NSString (dd-plist 1.22 API)

java.lang.Object
- com.dd.plist.NSObject
- - com.dd.plist.NSString

All Implemented Interfaces:

Cloneable, Comparable<Object>
```
public class NSString
extends NSObject
implements Comparable<Object>
```
The NSString class is a wrapper for a string.

Author:

Daniel Dreibrodt

See Also:

Foundation NSString documentation

Constructor Summary

Constructors
Constructor and Description
`NSString(byte[] bytes, int startIndex, int endIndex, String encoding)` Creates a new NSString instance from its binary representation.
`NSString(byte[] bytes, String encoding)` Creates a new NSString instance from its binary representation.
`NSString(String string)` Creates a new NSString instance with the specified content.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`append(NSString s)` Appends a string to this string.
`void`	`append(String s)` Appends a string to this string.
`boolean`	`boolValue()` Gets the boolean value of this string.
`NSString`	`clone()` Creates and returns a deep copy of this instance.
`int`	`compareTo(Object o)`
`double`	`doubleValue()` Gets the floating-point value (double precision) of this string.
`boolean`	`equals(Object obj)`
`float`	`floatValue()` Gets the floating-point value of this string.
`String`	`getContent()` Gets the string content of this instance.
`int`	`hashCode()`
`int`	`intValue()` Gets the integer value of this string.
`void`	`prepend(NSString s)` Prepends a string to this string.
`void`	`prepend(String s)` Prepends a string to this string.
`void`	`setContent(String c)` Sets the string content of this instance.
`protected void`	`toASCII(StringBuilder ascii, int level)` Generates the ASCII representation of this object.
`protected void`	`toASCIIGnuStep(StringBuilder ascii, int level)` Generates the ASCII representation of this object in the GnuStep format.
`void`	`toBinary(BinaryPropertyListWriter out)` Generates the binary representation of the object.
`String`	`toString()`

Methods inherited from class com.dd.plist.NSObject
fromJavaObject, toJavaObject, toJavaObject, toXMLPropertyList

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - NSString
```
public NSString(byte[] bytes,
                String encoding)
         throws UnsupportedEncodingException
```
    Creates a new NSString instance from its binary representation.
    
    Parameters:
    
    bytes - The binary representation.
    
    encoding - The string encoding (name of the charset).
    
    Throws:
    
    UnsupportedEncodingException - When the given encoding is not supported by the JRE.
    
    See Also:
    
    String.String(byte[], String)
  - NSString
```
public NSString(byte[] bytes,
                int startIndex,
                int endIndex,
                String encoding)
         throws UnsupportedEncodingException
```
    Creates a new NSString instance from its binary representation.
    
    Parameters:
    
    bytes - An array containing the binary representation of the string.
    
    startIndex - The offset inside the array at which the string data starts.
    
    endIndex - The offset inside the array at which the string data ends.
    
    encoding - The string encoding (name of the charset).
    
    Throws:
    
    UnsupportedEncodingException - When the given encoding is not supported by the JRE.
    
    See Also:
    
    String.String(byte[], int, int, String)
  - NSString
```
public NSString(String string)
```
    Creates a new NSString instance with the specified content.
    
    Parameters:
    
    string - The string that will be contained in the NSString.
- Method Detail
  - intValue
```
public int intValue()
```
    Gets the integer value of this string.
    
    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.
  - floatValue
```
public float floatValue()
```
    Gets the floating-point value of this string.
    
    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.
  - doubleValue
```
public double doubleValue()
```
    Gets the floating-point value (double precision) of this string.
    
    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.
  - boolValue
```
public boolean boolValue()
```
    Gets the boolean value of this string.
    
    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
  - getContent
```
public String getContent()
```
    Gets the string content of this instance.
    
    Returns:
    
    This string contained in this instance.
  - setContent
```
public void setContent(String c)
```
    Sets the string content of this instance.
    
    Parameters:
    
    c - The new content of this string object.
  - append
```
public void append(NSString s)
```
    Appends a string to this string.
    
    Parameters:
    
    s - The string to append.
  - append
```
public void append(String s)
```
    Appends a string to this string.
    
    Parameters:
    
    s - The string to append.
  - prepend
```
public void prepend(String s)
```
    Prepends a string to this string.
    
    Parameters:
    
    s - The string to prepend.
  - prepend
```
public void prepend(NSString s)
```
    Prepends a string to this string.
    
    Parameters:
    
    s - The string to prepend.
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - clone
```
public NSString clone()
```
    Description copied from class: NSObject
    
    Creates and returns a deep copy of this instance.
    
    Specified by:
    
    clone in class NSObject
    
    Returns:
    
    A clone of this instance.
  - toBinary
```
public void toBinary(BinaryPropertyListWriter out)
              throws IOException
```
    Description copied from class: NSObject
    
    Generates the binary representation of the object.
    
    Parameters:
    
    out - The output stream to serialize the object to.
    
    Throws:
    
    IOException - If an I/O error occurs while writing to the stream or the object structure contains data that cannot be saved.
  - toASCII
```
protected void toASCII(StringBuilder ascii,
                       int level)
```
    Description copied from class: NSObject
    
    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.
    
    Specified by:
    
    toASCII in class NSObject
    
    Parameters:
    
    ascii - The StringBuilder onto which the ASCII representation is appended.
    
    level - The indentation level of the object.
  - toASCIIGnuStep
```
protected void toASCIIGnuStep(StringBuilder ascii,
                              int level)
```
    Description copied from class: NSObject
    
    Generates the ASCII representation of this object in the GnuStep format. The generated ASCII representation does not end with a newline.
    
    Specified by:
    
    toASCIIGnuStep in class NSObject
    
    Parameters:
    
    ascii - The StringBuilder onto which the ASCII representation is appended.
    
    level - The indentation level of the object.
  - compareTo
```
public int compareTo(Object o)
```
    Specified by:
    
    compareTo in interface Comparable<Object>

Class NSString

Constructor Summary

Method Summary

Methods inherited from class com.dd.plist.NSObject

Methods inherited from class java.lang.Object

Constructor Detail

NSString

NSString

NSString

Method Detail

intValue

floatValue

doubleValue

boolValue

getContent

setContent

append

append

prepend

prepend

equals

hashCode

toString

clone

toBinary

toASCII

toASCIIGnuStep

compareTo