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

Modifier and Type	Field and Description
private final String	name
private final BigInteger	uid

Access	Constructor and Description
public	UID(String The UID name. name, BigInteger The UID value. value) Creates a new UID instance.
public	UID(String The UID name. name, byte[] The UID value. bytes) Creates a new UID instance.

Method Summary

Modifier and Type	Method and Description
public UID	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 boolean	equals(Object o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public byte[]	Returns: The UID's value in big-endian representation, encoded on 1, 2, 4, 8 or 16 bytes. getBytes() Gets this instance's value.
public String	Returns: The UID's name. getName() Gets this instance's name.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
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.
pack-priv 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 The XML StringBuilder xml, int The indentation level level) Implements abstract com.dd.plist.NSObject.toXML. The UID type has no dedicated representation in an XML property list.

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

name	back to summary
private final String name

uid	back to summary
private final BigInteger uid

UID	back to summary
public UID(String name, BigInteger value) Creates a new UID instance. Parameters name:String The UID name. value:BigInteger The UID value. Exceptions NullPointerException: If value is null. IllegalArgumentException: If value is negative or has a length of more than 128-bit.

UID	back to summary
public UID(String name, byte[] bytes) Creates a new UID instance. Parameters name:String The UID name. bytes:byte[] The UID value. Exceptions NullPointerException: If bytes is null. IllegalArgumentException: If bytes represents a UID with a length of more than 128-bit (leading zero bytes are ignored).

Method Detail

clone	back to summary
public UID 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 UID 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

equals back to summary

equals	back to summary
public boolean equals(Object o) 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 o)

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

getBytes	back to summary
public byte[] getBytes() Gets this instance's value. Returns:byte[] The UID's value in big-endian representation, encoded on 1, 2, 4, 8 or 16 bytes.

getBytes

back to summary

public byte[] getBytes()

Gets this instance's value.

Returns:byte[]: The UID's value in big-endian representation, encoded on 1, 2, 4, 8 or 16 bytes.

getName	back to summary
public String getName() Gets this instance's name. Returns:String The UID's name.

getName

back to summary

public String getName()

Gets this instance's name.

Returns:String: The UID's name.

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

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
pack-priv 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

pack-priv 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. The UID type has no dedicated representation in an XML property list. Typically, it is represented in XML as a dictionary with only one entry, where the key is "CF$UID" and the value is the integer representation of the UID. Parameters xml:StringBuilder The XML StringBuilder level:int The indentation level Annotations @Override

toXML

back to summary

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

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

The UID type has no dedicated representation in an XML property list. Typically, it is represented in XML as a dictionary with only one entry, where the key is "CF$UID" and the value is the integer representation of the UID.

Parameters

xml:StringBuilder: The XML StringBuilder
level:int: The indentation level

Annotations

@Override

public Class UID

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail