org.ldaptive.io

Class GeneralizedTimeValueTranscoder

java.lang.Object

org.ldaptive.io.AbstractStringValueTranscoder<java.util.Calendar>

org.ldaptive.io.GeneralizedTimeValueTranscoder

All Implemented Interfaces:

ValueTranscoder<java.util.Calendar>

public class GeneralizedTimeValueTranscoder
extends AbstractStringValueTranscoder<java.util.Calendar>

Decodes and encodes a generalized time for use in an ldap attribute value. See http://tools.ietf.org/html/rfc4517#section-3.3.13

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	GeneralizedTimeValueTranscoder.FractionalPart Describes the fractional part of a generalized time string.

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.ThreadLocal<java.text.DateFormat>	DATE_FORMAT Thread local container holding date format which is not thread safe.
private static java.lang.String	DAY_PATTERN Pattern for capturing the day in generalized time.
private static java.util.Locale	DEFAULT_LOCALE Default locale.
private static java.lang.String	FRACTION_PATTERN Pattern for capturing optional fraction in generalized time.
private static java.lang.String	HOUR_PATTERN Pattern for capturing hours in generalized time.
private static java.lang.String	MIN_PATTERN Pattern for capturing optional minutes in generalized time.
private static java.lang.String	MONTH_PATTERN Pattern for capturing the month in generalized time.
private static java.lang.String	SECOND_PATTERN Pattern for capturing optional seconds in generalized time.
private static java.util.regex.Pattern	TIME_REGEX Generalized time format regular expression.
private static java.lang.String	TIMEZONE_PATTERN Pattern for capturing timezone in generalized time.
private static java.util.TimeZone	UTC UTC time zone.
private static java.lang.String	YEAR_PATTERN Pattern for capturing the year in generalized time.

Constructor Summary

Constructors

Constructor and Description
GeneralizedTimeValueTranscoder()

Method Summary

Modifier and Type	Method and Description
java.util.Calendar	decodeStringValue(java.lang.String value) Decodes the supplied ldap attribute value into a custom type.
java.lang.String	encodeStringValue(java.util.Calendar value) Encodes the supplied value into an ldap attribute value.
java.lang.Class<java.util.Calendar>	getType() Returns the type produced by this value transcoder.
protected java.util.Calendar	parseGeneralizedTime(java.lang.String value) Parses the supplied value and sets a calendar with the appropriate fields.

Methods inherited from class org.ldaptive.io.AbstractStringValueTranscoder

decodeBinaryValue, encodeBinaryValue

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

YEAR_PATTERN

private static final java.lang.String YEAR_PATTERN

Pattern for capturing the year in generalized time.

See Also:

Constant Field Values

MONTH_PATTERN

private static final java.lang.String MONTH_PATTERN

Pattern for capturing the month in generalized time.

See Also:

Constant Field Values

DAY_PATTERN

private static final java.lang.String DAY_PATTERN

Pattern for capturing the day in generalized time.

See Also:

Constant Field Values

HOUR_PATTERN

private static final java.lang.String HOUR_PATTERN

Pattern for capturing hours in generalized time.

See Also:

Constant Field Values

MIN_PATTERN

private static final java.lang.String MIN_PATTERN

Pattern for capturing optional minutes in generalized time.

See Also:

Constant Field Values

SECOND_PATTERN

private static final java.lang.String SECOND_PATTERN

Pattern for capturing optional seconds in generalized time.

See Also:

Constant Field Values

FRACTION_PATTERN

private static final java.lang.String FRACTION_PATTERN

Pattern for capturing optional fraction in generalized time.

See Also:

Constant Field Values

TIMEZONE_PATTERN

private static final java.lang.String TIMEZONE_PATTERN

Pattern for capturing timezone in generalized time.

See Also:

Constant Field Values

TIME_REGEX

private static final java.util.regex.Pattern TIME_REGEX

Generalized time format regular expression.

UTC

private static final java.util.TimeZone UTC

UTC time zone.

DEFAULT_LOCALE

private static final java.util.Locale DEFAULT_LOCALE

Default locale.

DATE_FORMAT

private static final java.lang.ThreadLocal<java.text.DateFormat> DATE_FORMAT

Thread local container holding date format which is not thread safe.

Constructor Detail

GeneralizedTimeValueTranscoder

public GeneralizedTimeValueTranscoder()

Method Detail

decodeStringValue

public java.util.Calendar decodeStringValue(java.lang.String value)

Description copied from interface: ValueTranscoder

Decodes the supplied ldap attribute value into a custom type.

Parameters:

value - to decode

Returns:

decoded value

encodeStringValue

public java.lang.String encodeStringValue(java.util.Calendar value)

Description copied from interface: ValueTranscoder

Encodes the supplied value into an ldap attribute value.

Parameters:

value - to encode

Returns:

encoded value

getType

public java.lang.Class<java.util.Calendar> getType()

Description copied from interface: ValueTranscoder

Returns the type produced by this value transcoder.

Returns:

type produced by this value transcoder

parseGeneralizedTime

protected java.util.Calendar parseGeneralizedTime(java.lang.String value)
                                           throws java.text.ParseException

Parses the supplied value and sets a calendar with the appropriate fields.

Parameters:

value - of generalized time to parse

Returns:

calendar initialized to the correct time

Throws:

java.text.ParseException - if the value does not contain correct generalized time syntax