NSUID

java.lang.Object
- net.sf.plist.NSObject
- - net.sf.plist.NSUID

```
public final class NSUID
extends NSObject
```
A NSUID object is rarely seen in the wild. Therefore it is difficult to come up with a good API for it. PLEASE NOTE THAT MY UNDERSTANDING OF THE NSUID IS LIMITED, AND THEREFORE THIS API COULD TURN OUT TO BE WRONG AND WILL NEED TO BE CHANGED. Apple's own Property List Editor (part of XCode) completely ignores the NSUID. By using Apple's QuickLook to convert the Property List to XML code, the NSUID object is converted into a NSDictionary with one entry; the key is always CF$UID and the value is the unsigned 32bits integer value contained within the NSUID. So far I have only seen the NSUID files in the temporary .appdownload files Mac OS X writes when downloading an app from the Mac App Store. These files have four NSUID values; 0x01, 0x02, 0x03 and 0x04. It is still unclear what these values represent. They could point to objects in the object table but that seems to be unlikely, given the results that would produce. Because the CF$UID is a Number and QuickLook represents the NSUID as a NSDictionary, it is difficult to choose where NSUID should extend from, NSNumber or NSDictionary. Because I can not make a well informed choice we will inheirit from NSObject for now. toMap() and toList() are overridden to return a single entry. The key of the entry in the map is "CF$UID".

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CFUIDKEY
The string CF$UID, used in XML Property List files

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CFUIDKEY` The string CF$UID, used in XML Property List files

Constructor Summary

Constructors
Constructor and Description

NSUID(long cfUid)
Construct a new object with a given CF$UID.

Constructors
Constructor and Description
`NSUID(long cfUid)` Construct a new object with a given CF$UID.

Method Summary

Methods
Modifier and Type	Method and Description
`long`	`getCfUid()` Return the CF$UID value
`java.lang.Long`	`getValue()` Get the unmodifiable value of this object.
`boolean`	`isTrue()` This implementation considers the CF$UID to be true if the value of cfUid is bigger than 0.
`byte[]`	`toBytes()` Get the raw data of the value.
`double`	`toDouble()` Return the value as a double.
`java.util.List<NSInteger>`	`toList()` Return a list which has one item.
`long`	`toLong()` Return the value as a long.
`java.util.SortedMap<java.lang.String,NSObject>`	`toMap()` Return a map which has one entry, which has the key "CF$UID".
`java.lang.Long`	`toNumber()` Return the value as a number.
`NSUID`	`toObject()` Returns itself because there is no Java equivalent for NSUID.

Methods inherited from class net.sf.plist.NSObject
equals, fromObject, hashCode, toBoolean, toDate, toInteger, toListObject, toMapObject, toStream, toString

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

- Field Detail
  - CFUIDKEY
```
public static final java.lang.String CFUIDKEY
```
    The string CF$UID, used in XML Property List files
    
    See Also:
    Constant Field Values
- Constructor Detail
  - NSUID
```
public NSUID(long cfUid)
```
    Construct a new object with a given CF$UID. Note that a CF$UID is never negative and should be representable using at most 4 bytes.
    
    Parameters:
    cfUid - the CF$UID
- Method Detail
  - getValue
```
public java.lang.Long getValue()
```
    Get the unmodifiable value of this object.
    
    Specified by:
    
    getValue in class NSObject
    
    Returns:
    the unmodifiable value of this object
    See Also:
    toMap()
  - toMap
```
public java.util.SortedMap<java.lang.String,NSObject> toMap()
```
    Return a map which has one entry, which has the key "CF$UID". The value of this entry is always NSInteger and contains the value of this NSUID.
    
    Overrides:
    
    toMap in class NSObject
    
    Returns:
    the map
  - toList
```
public java.util.List<NSInteger> toList()
```
    Return a list which has one item. The item is a NSInteger and contains the value of this NSUID.
    
    Overrides:
    
    toList in class NSObject
    
    Returns:
    the list
  - toLong
```
public long toLong()
```
    Description copied from class: NSObject
    
    Return the value as a long. If this is not a NSInteger the long value is derived from the actual value.
    
    Specified by:
    
    toLong in class NSObject
    
    Returns:
    the long
    See Also:
    getCfUid()
  - toDouble
```
public double toDouble()
```
    Description copied from class: NSObject
    
    Return the value as a double. If this is not a NSReal the double value is derived from the actual value.
    
    Specified by:
    
    toDouble in class NSObject
    
    Returns:
    the double
    See Also:
    getCfUid()
  - toNumber
```
public java.lang.Long toNumber()
```
    Description copied from class: NSObject
    Return the value as a number. If this is not a NSNumber the number is derived from the value.
    
    The number is derived in the following way
    - For NSNumber: the actual number value
    - For NSCollection: the amount of children
    - For NSData: the length in bytes
    - For NSBoolean: always byte; 0 for false, 1 for true
    - For NSString: If the String is numeric, return the number in the string. Otherwise return 0^*
    If you need to be sure about the result (e.g. you need to know if the result is user intended or a guess) you should do instanceof checks yourself.
    
    ^*This behaviour is exactly as the library works and even though one could argue that the method should return null instead of 0, the method returns 0 and will never return null. There are a couple reasons for this:
    - The methods NSObject.toLong() and NSObject.toDouble() use NSObject.toNumber();
      returning null would cause NullPointerExceptions.
    - Just calling NSObject.toNumber() on any NSObject is dirty anyway.
      If you want to be sure that your number is really a number, check if your NSObject is an NSNumber.
    - If the implementation would fail on non-numeric Strings, the implementing programmer would need to check for these failures.
      By not failing explicitly, the programmer can still conduct some checks, but is not forced to do so if these checks are not important.
    Overrides:
    
    toNumber in class NSObject
    
    Returns:
    the number
    See Also:
    getCfUid()
  - getCfUid
```
public long getCfUid()
```
    Return the CF$UID value
    
    Returns:
    value of CF$UID
  - isTrue
```
public boolean isTrue()
```
    This implementation considers the CF$UID to be true if the value of cfUid is bigger than 0. The in-the-wild-observed values of the CF$UID have always been bigger than 0.
    
    Specified by:
    
    isTrue in class NSObject
    
    Returns:
    truth value of CF$UID
  - toObject
```
public NSUID toObject()
```
    Returns itself because there is no Java equivalent for NSUID.
    
    Overrides:
    
    toObject in class NSObject
    
    Returns:
    this
  - toBytes
```
public byte[] toBytes()
```
    Get the raw data of the value.
    
    Specified by:
    
    toBytes in class NSObject
    
    Returns:
    the data

Class NSUID

Field Summary

Constructor Summary

Method Summary

Methods inherited from class net.sf.plist.NSObject

Methods inherited from class java.lang.Object

Field Detail

CFUIDKEY

Constructor Detail

NSUID

Method Detail

getValue

toMap

toList

toLong

toDouble

toNumber

getCfUid

isTrue

toObject

toBytes