org.datanucleus.store.ldap.fieldmanager

Class GeneralizedTime

java.lang.Object

org.datanucleus.store.ldap.fieldmanager.GeneralizedTime

All Implemented Interfaces:

Comparable<GeneralizedTime>

public class GeneralizedTime
extends Object
implements Comparable<GeneralizedTime>

Converts between Calendar and LDAP generalized time syntax as defined in RFC 4517 section 3.3.13. Copied and adapted from Apache Directory shared-ldap.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GeneralizedTime.Format
static class	GeneralizedTime.FractionDelimiter
static class	GeneralizedTime.TimeZoneFormat

Constructor Summary

Constructors

Constructor and Description
GeneralizedTime(Calendar calendar) Creates a new instance of GeneralizedTime, based on the given Calendar object.
GeneralizedTime(String generalizedTime) Creates a new instance of GeneralizedTime, based on the given generalized time string.

Method Summary

Modifier and Type	Method and Description
int	compareTo(GeneralizedTime other) Compares this GeneralizedTime object with the specified GeneralizedTime object.
boolean	equals(Object obj)
Calendar	getCalendar() Gets the calendar.
int	hashCode()
String	toGeneralizedTime() Returns the string representation of this generalized time.
String	toGeneralizedTime(GeneralizedTime.Format format, GeneralizedTime.FractionDelimiter fractionDelimiter, int fractionLength, GeneralizedTime.TimeZoneFormat timeZoneFormat) Returns the string representation of this generalized time.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

GeneralizedTime

public GeneralizedTime(Calendar calendar)

Creates a new instance of GeneralizedTime, based on the given Calendar object. Uses

 Format.YEAR_MONTH_DAY_HOUR_MIN_SEC
 

as default format and

 TimeZoneFormat.Z
 

as default time zone format.

Parameters:

calendar - the calendar containing the date, time and timezone information

GeneralizedTime

public GeneralizedTime(String generalizedTime)
                throws ParseException

Creates a new instance of GeneralizedTime, based on the given generalized time string.

Parameters:

generalizedTime - the generalized time

Throws:

ParseException - if the given generalized time can't be parsed.

Method Detail

toGeneralizedTime

public String toGeneralizedTime()

Returns the string representation of this generalized time. This method uses the same format as the user provided format.

Returns:

the string representation of this generalized time

toGeneralizedTime

public String toGeneralizedTime(GeneralizedTime.Format format,
                                GeneralizedTime.FractionDelimiter fractionDelimiter,
                                int fractionLength,
                                GeneralizedTime.TimeZoneFormat timeZoneFormat)

Returns the string representation of this generalized time.

Parameters:

format - the target format

fractionDelimiter - the target fraction delimiter, may be null

fractionLength - the fraction length

timeZoneFormat - the target time zone format

Returns:

the string

getCalendar

public Calendar getCalendar()

Gets the calendar. It could be used to manipulate this GeneralizedTime settings.

Returns:

the calendar

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

compareTo

public int compareTo(GeneralizedTime other)

Compares this GeneralizedTime object with the specified GeneralizedTime object.

Specified by:

compareTo in interface Comparable<GeneralizedTime>

Parameters:

other - the other GeneralizedTime object

Returns:

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

See Also:

Comparable.compareTo(java.lang.Object)