net.sf.plist

Class NSBoolean

java.lang.Object

net.sf.plist.NSObject

net.sf.plist.NSBoolean

public final class NSBoolean
extends NSObject

Represents a value of either Boolean.TRUE or Boolean.FALSE.

In this implementation, a primitive boolean is used to represent the NSBoolean.

See Also:

Boolean

Field Summary

Fields

Modifier and Type	Field and Description
static NSBoolean	FALSE Represents Boolean.FALSE
static NSBoolean	TRUE Represents Boolean.TRUE

Constructor Summary

Constructors

Constructor and Description
NSBoolean(boolean theBoolean) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	bool() Get the boolean represented by this object.
java.lang.Boolean	getValue() Get the unmodifiable value of this object.
boolean	isTrue() Return whether or not the value evaluates to true.
byte[]	toBytes() Get the raw data of the value.
double	toDouble() Return the value as a double.
long	toLong() Return the value as a long.
java.util.SortedMap<java.lang.String,NSObject>	toMap() Try to retrieve the SortedMap contained in this NSObject.
java.lang.Number	toNumber() Return the value as a number.
java.lang.String	toString() Get the String representation of this objects value.

Methods inherited from class net.sf.plist.NSObject

equals, hashCode, toBoolean, toDate, toInteger, toList, toStream

Methods inherited from class java.lang.Object

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

Field Detail

TRUE

public static final NSBoolean TRUE

Represents Boolean.TRUE

FALSE

public static final NSBoolean FALSE

Represents Boolean.FALSE

Constructor Detail

NSBoolean

public NSBoolean(boolean theBoolean)

Constructor.

Parameters:

theBoolean - value of the new object

Method Detail

getValue

public java.lang.Boolean getValue()

Get the unmodifiable value of this object.

Specified by:

getValue in class NSObject

Returns:

the unmodifiable value of this object

See Also:

bool(), bool()

isTrue

public boolean isTrue()

Description copied from class: NSObject

Return whether or not the value evaluates to true.

A value returns to true if and only if

• it is the NSBoolean type TRUE
• It is an NSString which has a length greater than zero and does not equal "NO" or "False" (case insensitive)
• It is an NSNumber greater than 0
• It is an NSCollection which contains more than zero elements
• It is an NSDate
• It is an NSData with a length greater than 0

Specified by:

isTrue in class NSObject

Returns:

the value evaluates to true

See Also:

bool()

bool

public boolean bool()

Get the boolean represented by this object.

Returns:

the boolean

toBytes

public byte[] toBytes()

Get the raw data of the value.

Overrides:

toBytes in class NSObject

Returns:

the data

toMap

public java.util.SortedMap<java.lang.String,NSObject> toMap()

Try to retrieve the SortedMap contained in this NSObject. This method will return the SortedMap if the object is a NSDictionary and will return a SortedMap containing incremental keys and all the values if this object is a NSArray. Otherwise an empty list is returned.

Overrides:

toMap in class NSObject

Returns:

the list

toNumber

public java.lang.Number toNumber()

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

toLong

public long toLong()

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

toDouble

public double toDouble()

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

toString

public java.lang.String toString()

Get the String representation of this objects value.

Overrides:

toString in class NSObject

Returns:

the String representation for this object

See Also:

Object.toString()