org.datamanager.passiveentityvalue
Class StringEntityValue

java.lang.Object
  |
  +--org.datamanager.passiveentityvalue.StringEntityValue

All Implemented Interfaces:

Comparable, EntityValue, PassiveEntityValue, Serializable

public class StringEntityValue

extends Object

implements PassiveEntityValue, Comparable

This EntityValue wraps the String class, providing most of the methods available to an actual Java String through a PassiveEntityValue type. Original author - Benjamin Keil

Version:

$Revision: 1.8 $

Author:

Team Helium

See Also:

Serialized Form

Field Summary

static String

NULL_STRING

Constructor Summary

StringEntityValue()
Initializes a newly created String object so that it represents an empty character sequence.

StringEntityValue(byte[] bytes)
Construct a new String by converting the specified array of bytes using the platform's default character encoding.

StringEntityValue(byte[] bytes, int offset, int length)
Construct a new String by converting the specified subarray of bytes using the platform's default character encoding.

StringEntityValue(byte[] bytes, int offset, int length, String enc)
Construct a new String by converting the specified subarray of bytes using the specified character encoding.

StringEntityValue(byte[] bytes, String enc)
Construct a new String by converting the specified array of bytes using the specified character encoding.

StringEntityValue(char[] value)
Allocates a new String so that it represents the sequence of characters currently contained in the character array argument.

StringEntityValue(char[] value, int offset, int count)
Allocates a new String that contains characters from a subarray of the character array argument.

StringEntityValue(String value)
Initializes a newly created String object so that it represents the same sequence of characters as the argument; in other words, the newly created string is a copy of the argument string.

StringEntityValue(StringBuffer buffer)
Allocates a new string that contains the sequence of characters currently contained in the string buffer argument.

Method Summary

char	charAt(int index) Returns the character at the specified index.
int	compareTo(Object o) Compares this String to another Object.
int	compareTo(String anotherString) Compares two strings lexicographically.
int	compareToIgnoreCase(String str) Compares two strings lexicographically, ignoring case considerations.
String	concat(String str) Concatenates the specified string to the end of this string.
boolean	endsWith(String suffix) Tests if this string ends with the specified suffix.
boolean	equals(Object anObject) Compares this string to the specified object.
boolean	equalsIgnoreCase(String anotherString) Compares this String to another String, ignoring case considerations.
byte[]	getBytes() Convert this String into bytes according to the platform's default character encoding, storing the result into a new byte array.
byte[]	getBytes(String enc) Convert this String into bytes according to the specified character encoding, storing the result into a new byte array.
void	getChars(int srcBegin, int srcEnd, char[] dst, int dstBegin) Copies characters from this string into the destination character array.
int	hashCode() Returns a hashcode for this string.
int	indexOf(int ch) Returns the index within this string of the first occurrence of the specified character.
int	indexOf(int ch, int fromIndex) Returns the index within this string of the first occurrence of the specified character, starting the search at the specified index.
int	indexOf(String str) Returns the index within this string of the first occurrence of the specified substring.
int	indexOf(String str, int fromIndex) Returns the index within this string of the first occurrence of the specified substring, starting at the specified index.
String	intern() Returns a canonical representation for the string object.
int	lastIndexOf(int ch) Returns the index within this string of the last occurrence of the specified character.
int	lastIndexOf(int ch, int fromIndex) Returns the index within this string of the last occurrence of the specified character, searching backward starting at the specified index.
int	lastIndexOf(String str) Returns the index within this string of the rightmost occurrence of the specified substring.
int	lastIndexOf(String str, int fromIndex) Returns the index within this string of the last occurrence of the specified substring.
int	length() Returns the length of this string.
boolean	regionMatches(boolean ignoreCase, int toffset, String other, int ooffset, int len) Tests if two string regions are equal.
boolean	regionMatches(int toffset, String other, int ooffset, int len) Tests if two string regions are equal.
String	replace(char oldChar, char newChar) Returns a new string resulting from replacing all occurrences of oldChar in this string with newChar.
boolean	startsWith(String prefix) Tests if this string starts with the specified prefix.
boolean	startsWith(String prefix, int toffset) Tests if this string starts with the specified prefix beginning a specified index.
String	substring(int beginIndex) Returns a new string that is a substring of this string.
String	substring(int beginIndex, int endIndex) Returns a new string that is a substring of this string.
char[]	toCharArray() Converts this string to a new character array.
String	toLowerCase() Converts all of the characters in this String to lower case using the rules of the default locale, which is returned by Locale.getDefault .
String	toLowerCase(Locale locale) Converts all of the characters in this String to lower case using the rules of the given Locale.
String	toString() A copy of the String wrapped is returned.
String	toUpperCase() Converts all of the characters in this String to upper case using the rules of the default locale, which is returned by Locale.getDefault.
String	toUpperCase(Locale locale) Converts all of the characters in this String to upper case using the rules of the given locale.
String	trim() Removes white space from both ends of this string.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

NULL_STRING

public static final String NULL_STRING

See Also:

Constant Field Values

Constructor Detail

StringEntityValue

public StringEntityValue()

Initializes a newly created String object so that it represents an empty character sequence.

StringEntityValue

public StringEntityValue(byte[] bytes)

Construct a new String by converting the specified array of bytes using the platform's default character encoding.

StringEntityValue

public StringEntityValue(byte[] bytes,
                         int offset,
                         int length)

Construct a new String by converting the specified subarray of bytes using the platform's default character encoding.

StringEntityValue

public StringEntityValue(byte[] bytes,
                         int offset,
                         int length,
                         String enc)
                  throws UnsupportedEncodingException

Construct a new String by converting the specified subarray of bytes using the specified character encoding.

StringEntityValue

public StringEntityValue(byte[] bytes,
                         String enc)
                  throws UnsupportedEncodingException

Construct a new String by converting the specified array of bytes using the specified character encoding.

StringEntityValue

public StringEntityValue(char[] value)

Allocates a new String so that it represents the sequence of characters currently contained in the character array argument.

StringEntityValue

public StringEntityValue(char[] value,
                         int offset,
                         int count)

Allocates a new String that contains characters from a subarray of the character array argument.

StringEntityValue

public StringEntityValue(String value)

Initializes a newly created String object so that it represents the same sequence of characters as the argument; in other words, the newly created string is a copy of the argument string.

StringEntityValue

public StringEntityValue(StringBuffer buffer)

Allocates a new string that contains the sequence of characters currently contained in the string buffer argument.

Method Detail

charAt

public char charAt(int index)

Returns the character at the specified index.

compareTo

public int compareTo(Object o)

Compares this String to another Object.

Specified by:

compareTo in interface Comparable

compareTo

public int compareTo(String anotherString)

Compares two strings lexicographically.

compareToIgnoreCase

public int compareToIgnoreCase(String str)

Compares two strings lexicographically, ignoring case considerations.

concat

public String concat(String str)

Concatenates the specified string to the end of this string.

endsWith

public boolean endsWith(String suffix)

Tests if this string ends with the specified suffix.

equals

public boolean equals(Object anObject)

Compares this string to the specified object.

Specified by:

equals in interface PassiveEntityValue

Overrides:

equals in class Object

equalsIgnoreCase

public boolean equalsIgnoreCase(String anotherString)

Compares this String to another String, ignoring case considerations.

getBytes

public byte[] getBytes()

Convert this String into bytes according to the platform's default character encoding, storing the result into a new byte array.

getBytes

public byte[] getBytes(String enc)
                throws UnsupportedEncodingException

Convert this String into bytes according to the specified character encoding, storing the result into a new byte array.

UnsupportedEncodingException

getChars

public void getChars(int srcBegin,
                     int srcEnd,
                     char[] dst,
                     int dstBegin)

Copies characters from this string into the destination character array.

hashCode

public int hashCode()

Returns a hashcode for this string.

Specified by:

hashCode in interface PassiveEntityValue

Overrides:

hashCode in class Object

indexOf

public int indexOf(int ch)

Returns the index within this string of the first occurrence of the specified character.

indexOf

public int indexOf(int ch,
                   int fromIndex)

Returns the index within this string of the first occurrence of the specified character, starting the search at the specified index.

indexOf

public int indexOf(String str)

Returns the index within this string of the first occurrence of the specified substring.

indexOf

public int indexOf(String str,
                   int fromIndex)

Returns the index within this string of the first occurrence of the specified substring, starting at the specified index.

intern

public String intern()

Returns a canonical representation for the string object.

lastIndexOf

public int lastIndexOf(int ch)

Returns the index within this string of the last occurrence of the specified character.

lastIndexOf

public int lastIndexOf(int ch,
                       int fromIndex)

Returns the index within this string of the last occurrence of the specified character, searching backward starting at the specified index.

lastIndexOf

public int lastIndexOf(String str)

Returns the index within this string of the rightmost occurrence of the specified substring.

lastIndexOf

public int lastIndexOf(String str,
                       int fromIndex)

Returns the index within this string of the last occurrence of the specified substring.

length

public int length()

Returns the length of this string.

regionMatches

public boolean regionMatches(boolean ignoreCase,
                             int toffset,
                             String other,
                             int ooffset,
                             int len)

Tests if two string regions are equal.

regionMatches

public boolean regionMatches(int toffset,
                             String other,
                             int ooffset,
                             int len)

Tests if two string regions are equal.

replace

public String replace(char oldChar,
                      char newChar)

Returns a new string resulting from replacing all occurrences of oldChar in this string with newChar.

startsWith

public boolean startsWith(String prefix)

Tests if this string starts with the specified prefix.

startsWith

public boolean startsWith(String prefix,
                          int toffset)

Tests if this string starts with the specified prefix beginning a specified index.

substring

public String substring(int beginIndex)

Returns a new string that is a substring of this string.

substring

public String substring(int beginIndex,
                        int endIndex)

Returns a new string that is a substring of this string.

toCharArray

public char[] toCharArray()

Converts this string to a new character array.

toLowerCase

public String toLowerCase()

Converts all of the characters in this String to lower case using the rules of the default locale, which is returned by Locale.getDefault .

toLowerCase

public String toLowerCase(Locale locale)

Converts all of the characters in this String to lower case using the rules of the given Locale.

toString

public String toString()

A copy of the String wrapped is returned.

Overrides:

toString in class Object

toUpperCase

public String toUpperCase()

Converts all of the characters in this String to upper case using the rules of the default locale, which is returned by Locale.getDefault.

toUpperCase

public String toUpperCase(Locale locale)

Converts all of the characters in this String to upper case using the rules of the given locale.

trim

public String trim()

Removes white space from both ends of this string.