dd-plist 1.29 · com.dd.plist.NSString · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private static CharsetEncoder	asciiEncoder
private String	content
private static CharsetEncoder	utf16beEncoder
private static CharsetEncoder	utf8Encoder

Access	Constructor and Description
public	NSString(byte[] The binary representation. bytes, String The string encoding (name of the charset). encoding) Creates a new NSString instance from its binary representation.
public	NSString(byte[] An array containing the binary representation of the string. bytes, final int The offset inside the array at which the string data starts. startIndex, final int The offset inside the array at which the string data ends. endIndex, String The string encoding (name of the charset). encoding) Creates a new NSString instance from its binary representation.
public	NSString(String The string that will be contained in the NSString. string) Creates a new NSString instance with the specified content.

Method Summary

Modifier and Type	Method and Description
public void	append(NSString The string to append. s) Appends a string to this string.
public void	append(String The string to append. s) Appends a string to this string.
public boolean	Returns: The boolean value of this string. Leading whitespaces are ignored. Any + or - sign and leading zeroes are ignored. If the remaining string starts with 'Y', 'y', 'T', 't' or a positive digit (1-9), true is returned. Otherwise, false is returned. Examples: "YES" is true "true" is true " YES" is true "+1" is true "-9" is true " +01" is true "0" is false "false" is false "no" is false "1FALSE" is true "0TRUE" is true "FALSE1" is false boolValue() Gets the boolean value of this string.
public NSString	clone() Implements abstract com.dd.plist.NSObject.clone. Creates and returns a deep copy of this instance.
public int	compareTo(NSObject o) Implements java.lang.Comparable.compareTo. Compares this object with the specified object for order.
public double	Returns: The floating-point value of this string, assuming a decimal representation and skipping whitespace at the beginning of the string. If the string does not contain a valid decimal representation of a floating-point number, 0 is returned. doubleValue() Gets the floating-point value (double precision) of this string.
public boolean	equals(Object obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
pack-priv static String	Returns: The escaped string. escapeStringForASCII(String The unescaped string. s) Escapes a string for use in ASCII property lists.
pack-priv static String	escapeStringForXml(String s)
public float	Returns: The floating-point value of this string, assuming a decimal representation and skipping whitespace at the beginning of the string. If the string does not contain a valid decimal representation of a number, 0 is returned. If the string contains an integer larger than Float.MAX_VALUE, Float.MAX_VALUE is returned. If the string contains an integer less than -Float.MAX_VALUE, -Float.MAX_VALUE is returned. floatValue() Gets the floating-point value of this string.
public String	Returns: This string contained in this instance. getContent() Gets the string content of this instance.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public int	Returns: The integer value of this string, assuming a decimal representation and skipping whitespace at the beginning of the string. If the string does not contain a valid decimal representation of a number, 0 is returned. If the string contains an integer larger than Integer.MAX_VALUE, Integer.MAX_VALUE is returned. If the string contains an integer less than Integer.MIN_VALUE, Integer.MIN_VALUE is returned. intValue() Gets the integer value of this string.
public void	prepend(String The string to prepend. s) Prepends a string to this string.
public void	prepend(NSString The string to prepend. s) Prepends a string to this string.
public void	setContent(String The new content of this string object. c) Sets the string content of this instance.
protected void	toASCII(StringBuilder ascii, int level) Implements abstract com.dd.plist.NSObject.toASCII. Generates the ASCII representation of this object.
protected void	toASCIIGnuStep(StringBuilder ascii, int level) Implements abstract com.dd.plist.NSObject.toASCIIGnuStep. Generates the ASCII representation of this object in the GnuStep format.
public void	toBinary(BinaryPropertyListWriter out) Implements abstract com.dd.plist.NSObject.toBinary. Generates the binary representation of the object.
public Object	toJavaObject() Implements abstract com.dd.plist.NSObject.toJavaObject. Converts this NSObject into an equivalent object of the Java Runtime Environment.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
pack-priv void	toXML(StringBuilder xml, int level) Implements abstract com.dd.plist.NSObject.toXML. Generates the XML representation of the object (without XML headers or enclosing plist-tags).

Inherited from com.dd.plist.NSObject:: assignIDs fromJavaObject getLocationInformation indent setLocationInformation toJavaObject toXMLPropertyList

asciiEncoder	back to summary
private static CharsetEncoder asciiEncoder

content	back to summary
private String content

utf16beEncoder	back to summary
private static CharsetEncoder utf16beEncoder

utf8Encoder	back to summary
private static CharsetEncoder utf8Encoder

NSString	back to summary
public NSString(byte[] bytes, String encoding) throws UnsupportedEncodingException Creates a new NSString instance from its binary representation. Parameters bytes:byte[] The binary representation. encoding:String The string encoding (name of the charset). Exceptions UnsupportedEncodingException: When the given encoding is not supported by the JRE. See Also `java.lang.String#String(byte[], String)`

NSString	back to summary
public NSString(byte[] bytes, final int startIndex, final int endIndex, String encoding) throws UnsupportedEncodingException Creates a new NSString instance from its binary representation. Parameters bytes:byte[] An array containing the binary representation of the string. startIndex:int The offset inside the array at which the string data starts. endIndex:int The offset inside the array at which the string data ends. encoding:String The string encoding (name of the charset). Exceptions UnsupportedEncodingException: When the given encoding is not supported by the JRE. See Also `java.lang.String#String(byte[], int, int, String)`

NSString	back to summary
public NSString(String string) Creates a new NSString instance with the specified content. Parameters string:String The string that will be contained in the NSString.

Method Detail

append	back to summary
public void append(NSString s) Appends a string to this string. Parameters s:NSString The string to append.

append

back to summary

public void append(NSString s)

Appends a string to this string.

Parameters

s:NSString: The string to append.

append	back to summary
public void append(String s) Appends a string to this string. Parameters s:String The string to append.

append

back to summary

public void append(String s)

Appends a string to this string.

Parameters

s:String: The string to append.

boolValue	back to summary
public boolean boolValue() Gets the boolean value of this string. Returns:boolean The boolean value of this string. Leading whitespaces are ignored. Any + or - sign and leading zeroes are ignored. If the remaining string starts with 'Y', 'y', 'T', 't' or a positive digit (1-9), true is returned. Otherwise, false is returned. Examples: "YES" is true "true" is true " YES" is true "+1" is true "-9" is true " +01" is true "0" is false "false" is false "no" is false "1FALSE" is true "0TRUE" is true "FALSE1" is false

boolValue

back to summary

public boolean boolValue()

Gets the boolean value of this string.

Returns:boolean

The boolean value of this string. Leading whitespaces are ignored. Any + or - sign and leading zeroes are ignored. If the remaining string starts with 'Y', 'y', 'T', 't' or a positive digit (1-9), true is returned. Otherwise, false is returned.

Examples: "YES" is true "true" is true " YES" is true "+1" is true "-9" is true " +01" is true "0" is false "false" is false "no" is false "1FALSE" is true "0TRUE" is true "FALSE1" is false

clone	back to summary
public NSString clone() Implements abstract com.dd.plist.NSObject.clone. Doc from com.dd.plist.NSObject.clone. Creates and returns a deep copy of this instance. Annotations @Override

clone

back to summary

public NSString clone()

Implements abstract com.dd.plist.NSObject.clone.

Doc from com.dd.plist.NSObject.clone.

Creates and returns a deep copy of this instance.

Annotations

@Override

compareTo back to summary

compareTo	back to summary
public int compareTo(NSObject o) Implements java.lang.Comparable.compareTo. Doc from java.lang.Comparable.compareTo. Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. The implementor must ensure `signum(x.compareTo(y)) == -signum(y.compareTo(x))` for all `x` and `y`. (This implies that `x.compareTo(y)` must throw an exception if and only if `y.compareTo(x)` throws an exception.) The implementor must also ensure that the relation is transitive: `(x.compareTo(y) > 0 && y.compareTo(z) > 0)` implies `x.compareTo(z) > 0`. Finally, the implementor must ensure that `x.compareTo(y)==0` implies that `signum(x.compareTo(z)) == signum(y.compareTo(z))`, for all `z`. Annotations @Override

public int compareTo(NSObject o)

Implements java.lang.Comparable.compareTo.

Doc from java.lang.Comparable.compareTo.

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure signum(x.compareTo(y)) == -signum(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception if and only if y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y) > 0 && y.compareTo(z) > 0) implies x.compareTo(z) > 0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that signum(x.compareTo(z)) == signum(y.compareTo(z)), for all z.

Annotations

@Override

doubleValue	back to summary
public double doubleValue() Gets the floating-point value (double precision) of this string. Returns:double The floating-point value of this string, assuming a decimal representation and skipping whitespace at the beginning of the string. If the string does not contain a valid decimal representation of a floating-point number, 0 is returned.

doubleValue

back to summary

public double doubleValue()

Gets the floating-point value (double precision) of this string.

Returns:double: The floating-point value of this string, assuming a decimal representation and skipping whitespace at the beginning of the string. If the string does not contain a valid decimal representation of a floating-point number, 0 is returned.

equals back to summary

equals	back to summary
public boolean equals(Object obj) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Annotations @Override

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Annotations

@Override

escapeStringForASCII	back to summary
pack-priv static String escapeStringForASCII(String s) Escapes a string for use in ASCII property lists. Parameters s:String The unescaped string. Returns:String The escaped string.

escapeStringForASCII

back to summary

pack-priv static String escapeStringForASCII(String s)

Escapes a string for use in ASCII property lists.

Parameters

s:String: The unescaped string.

Returns:String

The escaped string.

escapeStringForXml	back to summary
pack-priv static String escapeStringForXml(String s)

floatValue	back to summary
public float floatValue() Gets the floating-point value of this string. Returns:float The floating-point value of this string, assuming a decimal representation and skipping whitespace at the beginning of the string. If the string does not contain a valid decimal representation of a number, 0 is returned. If the string contains an integer larger than Float.MAX_VALUE, Float.MAX_VALUE is returned. If the string contains an integer less than -Float.MAX_VALUE, -Float.MAX_VALUE is returned.

floatValue

back to summary

public float floatValue()

Gets the floating-point value of this string.

Returns:float: The floating-point value of this string, assuming a decimal representation and skipping whitespace at the beginning of the string. If the string does not contain a valid decimal representation of a number, 0 is returned. If the string contains an integer larger than Float.MAX_VALUE, Float.MAX_VALUE is returned. If the string contains an integer less than -Float.MAX_VALUE, -Float.MAX_VALUE is returned.

getContent	back to summary
public String getContent() Gets the string content of this instance. Returns:String This string contained in this instance.

getContent

back to summary

public String getContent()

Gets the string content of this instance.

Returns:String: This string contained in this instance.

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Annotations

@Override

intValue	back to summary
public int intValue() Gets the integer value of this string. Returns:int The integer value of this string, assuming a decimal representation and skipping whitespace at the beginning of the string. If the string does not contain a valid decimal representation of a number, 0 is returned. If the string contains an integer larger than Integer.MAX_VALUE, Integer.MAX_VALUE is returned. If the string contains an integer less than Integer.MIN_VALUE, Integer.MIN_VALUE is returned.

intValue

back to summary

public int intValue()

Gets the integer value of this string.

Returns:int: The integer value of this string, assuming a decimal representation and skipping whitespace at the beginning of the string. If the string does not contain a valid decimal representation of a number, 0 is returned. If the string contains an integer larger than Integer.MAX_VALUE, Integer.MAX_VALUE is returned. If the string contains an integer less than Integer.MIN_VALUE, Integer.MIN_VALUE is returned.

prepend	back to summary
public void prepend(String s) Prepends a string to this string. Parameters s:String The string to prepend.

prepend

back to summary

public void prepend(String s)

Prepends a string to this string.

Parameters

s:String: The string to prepend.

prepend	back to summary
public void prepend(NSString s) Prepends a string to this string. Parameters s:NSString The string to prepend.

prepend

back to summary

public void prepend(NSString s)

Prepends a string to this string.

Parameters

s:NSString: The string to prepend.

setContent	back to summary
public void setContent(String c) Sets the string content of this instance. Parameters c:String The new content of this string object.

setContent

back to summary

public void setContent(String c)

Sets the string content of this instance.

Parameters

c:String: The new content of this string object.

toASCII	back to summary
protected void toASCII(StringBuilder ascii, int level) Implements abstract com.dd.plist.NSObject.toASCII. Doc from com.dd.plist.NSObject.toASCII. Generates the ASCII representation of this object. The generated ASCII representation does not end with a newline. Complies with the Old-Style ASCII Property Lists definition. Annotations @Override

toASCII

back to summary

protected void toASCII(StringBuilder ascii, int level)

Implements abstract com.dd.plist.NSObject.toASCII.

Doc from com.dd.plist.NSObject.toASCII.

Generates the ASCII representation of this object. The generated ASCII representation does not end with a newline. Complies with the Old-Style ASCII Property Lists definition.

Annotations

@Override

toASCIIGnuStep	back to summary
protected void toASCIIGnuStep(StringBuilder ascii, int level) Implements abstract com.dd.plist.NSObject.toASCIIGnuStep. Doc from com.dd.plist.NSObject.toASCIIGnuStep. Generates the ASCII representation of this object in the GnuStep format. The generated ASCII representation does not end with a newline. Annotations @Override

toASCIIGnuStep

back to summary

protected void toASCIIGnuStep(StringBuilder ascii, int level)

Implements abstract com.dd.plist.NSObject.toASCIIGnuStep.

Doc from com.dd.plist.NSObject.toASCIIGnuStep.

Generates the ASCII representation of this object in the GnuStep format. The generated ASCII representation does not end with a newline.

Annotations

@Override

toBinary	back to summary
public void toBinary(BinaryPropertyListWriter out) throws IOException Implements abstract com.dd.plist.NSObject.toBinary. Doc from com.dd.plist.NSObject.toBinary. Generates the binary representation of the object. Annotations @Override Exceptions IOException: If an I/O error occurs while writing to the stream or the object structure contains data that cannot be saved.

toBinary

back to summary

public void toBinary(BinaryPropertyListWriter out) throws IOException

Implements abstract com.dd.plist.NSObject.toBinary.

Doc from com.dd.plist.NSObject.toBinary.

Generates the binary representation of the object.

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs while writing to the stream or the object structure contains data that cannot be saved.

toJavaObject back to summary

toJavaObject	back to summary
public Object toJavaObject() Implements abstract com.dd.plist.NSObject.toJavaObject. Doc from com.dd.plist.NSObject.toJavaObject. Converts this NSObject into an equivalent object of the Java Runtime Environment. `NSArray` objects are converted to arrays. `NSDictionary` objects are converted to objects extending the `java.util.Map` class. `NSSet` objects are converted to objects extending the `java.util.Set` class. `NSNumber` objects are converted to primitive number values (int, long, double or boolean). `NSString` objects are converted to `String` objects. `NSData` objects are converted to byte arrays. `NSDate` objects are converted to `java.util.Date` objects. `UID` objects are converted to byte arrays. Annotations @Override

public Object toJavaObject()

Implements abstract com.dd.plist.NSObject.toJavaObject.

Doc from com.dd.plist.NSObject.toJavaObject.

Converts this NSObject into an equivalent object of the Java Runtime Environment.

NSArray objects are converted to arrays.
NSDictionary objects are converted to objects extending the java.util.Map class.
NSSet objects are converted to objects extending the java.util.Set class.
NSNumber objects are converted to primitive number values (int, long, double or boolean).
NSString objects are converted to String objects.
NSData objects are converted to byte arrays.
NSDate objects are converted to java.util.Date objects.
UID objects are converted to byte arrays.

Annotations

@Override

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations

@Override

toXML	back to summary
pack-priv void toXML(StringBuilder xml, int level) Implements abstract com.dd.plist.NSObject.toXML. Doc from com.dd.plist.NSObject.toXML. Generates the XML representation of the object (without XML headers or enclosing plist-tags). Annotations @Override

toXML

back to summary

pack-priv void toXML(StringBuilder xml, int level)

Implements abstract com.dd.plist.NSObject.toXML.

Doc from com.dd.plist.NSObject.toXML.

Generates the XML representation of the object (without XML headers or enclosing plist-tags).

Annotations

@Override

public Class NSString

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail