Top Description Fields Constructors Methods
com.dd.plist

public Class NSDate

extends NSObject
Class Inheritance
Imports
java.io.IOException, java.text.ParseException, .SimpleDateFormat, java.util.Date, .Objects, .TimeZone

The NSDate class wraps a date.
Author
Daniel Dreibrodt
See Also
Foundation NSDate documentation

Field Summary

Modifier and TypeField and Description
private final Date
private static final long
private static final SimpleDateFormat
private static final SimpleDateFormat
Inherited from com.dd.plist.NSObject:
ASCII_LINE_LENGTHNEWLINE

Constructor Summary

AccessConstructor and Description
public
NSDate(byte[]
The binary date representation.
bytes
)

Creates new NSDate instance from its binary representation.

public
NSDate(byte[]
The byte array containing the date data.
bytes
,
final int
The index within the array at which the date data begins.
startIndex
,
final int
The index within the array at which the data date ends.
endIndex
)

Creates a new NSDate instance from its binary representation.

public
NSDate(String
The textual representation of the date.
textRepresentation
)

Creates a new NSDate instance from is textual representation.

public
NSDate(Date
The date.
d
)

Creates a new NSDate instance.

Method Summary

Modifier and TypeMethod and Description
public NSDate
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 obj)

Overrides java.lang.Object.equals.

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

public Date

Returns:

The date.
getDate
()

Gets the date.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

private static synchronized String

Returns:

The string representation of the date.
makeDateString
(Date
The date which should be represented.
date
)

Generates a string representation of a Java Date object.

private static synchronized String

Returns:

The string representation of the date.
makeDateStringGnuStep
(Date
The date which should be represented.
date
)

Generates a string representation of a Java Date object.

private static synchronized Date

Returns:

The parsed Date
parseDateString
(String
The date string as found in an ASCII or XML property list
textRepresentation
)

Parses a date string and creates a Java Date object from it.

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

Returns:

A string representation of the date.
toString
()

Overrides java.lang.Object.toString.

Generates a string representation of the date.

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:
assignIDsfromJavaObjectgetLocationInformationindentsetLocationInformationtoJavaObjecttoXMLPropertyList

Field Detail

dateback to summary
private final Date date
EPOCHback to summary
private static final long EPOCH
sdfDefaultback to summary
private static final SimpleDateFormat sdfDefault
sdfGnuStepback to summary
private static final SimpleDateFormat sdfGnuStep

Constructor Detail

NSDateback to summary
public NSDate(byte[] bytes)

Creates new NSDate instance from its binary representation.

Parameters
bytes:byte[]

The binary date representation.

NSDateback to summary
public NSDate(byte[] bytes, final int startIndex, final int endIndex)

Creates a new NSDate instance from its binary representation.

Parameters
bytes:byte[]

The byte array containing the date data.

startIndex:int

The index within the array at which the date data begins.

endIndex:int

The index within the array at which the data date ends.

NSDateback to summary
public NSDate(String textRepresentation) throws ParseException

Creates a new NSDate instance from is textual representation. The textual representation must adhere to one of the following patterns. For XML property lists: yyyy-MM-dd'T'HH:mm:ss'Z' For ASCII property lists: yyyy-MM-dd HH:mm:ss Z

Parameters
textRepresentation:String

The textual representation of the date.

Exceptions
ParseException:
If the date could not be parsed, i.e. it does not match the expected pattern.
NSDateback to summary
public NSDate(Date d)

Creates a new NSDate instance.

Parameters
d:Date

The date.

Method Detail

cloneback to summary
public NSDate 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
compareToback 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
equalsback 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
getDateback to summary
public Date getDate()

Gets the date.

Returns:Date

The date.

hashCodeback 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
makeDateStringback to summary
private static synchronized String makeDateString(Date date)

Generates a string representation of a Java Date object. The string is formatted according to the specification for XML property list dates.

Parameters
date:Date

The date which should be represented.

Returns:String

The string representation of the date.

makeDateStringGnuStepback to summary
private static synchronized String makeDateStringGnuStep(Date date)

Generates a string representation of a Java Date object. The string is formatted according to the specification for GnuStep ASCII property list dates.

Parameters
date:Date

The date which should be represented.

Returns:String

The string representation of the date.

parseDateStringback to summary
private static synchronized Date parseDateString(String textRepresentation) throws ParseException

Parses a date string and creates a Java Date object from it. This function is synchronized because the underlying SimpleDateFormat instances are not thread-safe.

Parameters
textRepresentation:String

The date string as found in an ASCII or XML property list

Returns:Date

The parsed Date

Exceptions
ParseException:
If the given string cannot be parsed.
See Also
SimpleDateFormat#parse(java.lang.String)
toASCIIback 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
toASCIIGnuStepback 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
toBinaryback 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.
toJavaObjectback 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.

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Generates a string representation of the date.

Returns:String

A string representation of the date.

Annotations
@Override
See Also
java.util.Date#toString()
toXMLback 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