org.assistments.util

Class UIDGeneratorGWTImpl

java.lang.Object

org.assistments.util.UIDGeneratorGWTImpl

All Implemented Interfaces:

UIDGenerator

public class UIDGeneratorGWTImpl
extends java.lang.Object
implements UIDGenerator

UIDGeneratorGWTImpl provides a GWT-safe implementation of the UIDGenerator interface.

Field Summary

Fields inherited from interface org.assistments.util.UIDGenerator

CORE_UID_FIELD_DELIMITER, DEFAULT_DELIMITER, DEFAULT_RANDOM_FIELD_CHARS, DEFAULT_RANDOM_LEN

Constructor Summary

Constructors

Constructor and Description
UIDGeneratorGWTImpl() Default constructor.
UIDGeneratorGWTImpl(java.lang.String delim, char[] charSet, int randomFieldLen) Constructor

Method Summary

Modifier and Type	Method and Description
static java.lang.String	extractCoreUID(java.lang.String uid) Returns the core UID field (holding the time stamp and random characters)
static java.lang.String	extractCoreUID(java.lang.String uid, java.lang.String delim) Returns the core UID field (holding the time stamp and random characters)
static java.util.List<java.lang.String>	extractExtraFields(java.lang.String uid) Returns any optional fields from a UID.
static java.util.List<java.lang.String>	extractExtraFields(java.lang.String uid, java.lang.String delim) Returns any optional fields from a UID.
static long	extractTimestamp(java.lang.String uid) Returns the time stamp portion from a UUID
static long	extractTimestamp(java.lang.String uid, java.lang.String delim) Returns the time stamp portion from a UUID
static java.lang.String	generateDefaultUID() Returns a UID based on default settings.
static java.lang.String	generateDefaultUID(java.lang.String... extraFields) Returns a UID based on default settings containing the provided extra (optional) fields.
static java.lang.String	generateDefaultUID(java.lang.String coreUIDFieldDelimiter) Returns a UID based on default settings except for the delimeter character.
java.lang.String	generateUID() Returns a default Unique Identifier
java.lang.String	generateUID(java.lang.String... extraFields) Returns a Unique Identifier prepended with one or more options field values.
java.lang.String	getDelimiter() Returns the optional field delimiter string
char[]	getRandomCharSet() Returns the character set used for generating UID's the random field.
int	getRandomFieldLen() Returns the number of characters in the UID's random field.
static void	main(java.lang.String[] args) For debug only
static java.lang.String	makeExtendedUID(java.lang.String coreUID, java.lang.String... extraFields)
void	setDelimiter(java.lang.String delim) Sets the optional field delimiter string
void	setRandomCharSet(char[] charSet) Sets the character set to use
void	setRandomFieldLen(int len) Sets the number of characters in the UID's random field.

Methods inherited from class java.lang.Object

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

Constructor Detail

UIDGeneratorGWTImpl

public UIDGeneratorGWTImpl()

Default constructor.

UIDGeneratorGWTImpl

public UIDGeneratorGWTImpl(java.lang.String delim,
                           char[] charSet,
                           int randomFieldLen)

Constructor

Parameters:

delim - Optional field delimiter string

charSet - Character set to use for populating the <N random chars> portion of the core UID.

randomFieldLen - The length of <N random chars>.

Method Detail

generateDefaultUID

public static java.lang.String generateDefaultUID()

Returns a UID based on default settings.

See Also:

UIDGenerator.DEFAULT_DELIMITER, UIDGenerator.DEFAULT_RANDOM_FIELD_CHARS, UIDGenerator.DEFAULT_RANDOM_LEN

generateDefaultUID

public static java.lang.String generateDefaultUID(java.lang.String coreUIDFieldDelimiter)

Returns a UID based on default settings except for the delimeter character.

Parameters:

coreUIDFieldDelimiter - The string used to separate the UID fields (instead of using UIDGenerator.CORE_UID_FIELD_DELIMITER)

generateDefaultUID

public static java.lang.String generateDefaultUID(java.lang.String... extraFields)

Returns a UID based on default settings containing the provided extra (optional) fields.

See Also:

generateUID()

makeExtendedUID

public static java.lang.String makeExtendedUID(java.lang.String coreUID,
                                               java.lang.String... extraFields)

extractCoreUID

public static java.lang.String extractCoreUID(java.lang.String uid)

Returns the core UID field (holding the time stamp and random characters)

Parameters:

uid - UID

Returns:

The core UID field. If uid does not contain extra fields, then returns uid.

See Also:

extractCoreUID(String, String)

extractCoreUID

public static java.lang.String extractCoreUID(java.lang.String uid,
                                              java.lang.String delim)

Returns the core UID field (holding the time stamp and random characters)

Parameters:

uid - UID

delim - Delimiter string for optional fields.

Returns:

The core UID field. If uid does not contain optional fields, then returns uid.

See Also:

extractCoreUID(String)

extractExtraFields

public static java.util.List<java.lang.String> extractExtraFields(java.lang.String uid)

Returns any optional fields from a UID.

Parameters:

uid - UID

Returns:

A list of optional fields. If none, returns an empty list.

See Also:

extractExtraFields(String, String)

extractExtraFields

public static java.util.List<java.lang.String> extractExtraFields(java.lang.String uid,
                                                                  java.lang.String delim)

Returns any optional fields from a UID.

Parameters:

uid - UID

delim - Delimiter string for optional fields.

Returns:

A list of optional fields. If none, returns an empty list.

See Also:

extractExtraFields(String)

extractTimestamp

public static long extractTimestamp(java.lang.String uid)

Returns the time stamp portion from a UUID

Parameters:

uid - UUID

Returns:

Time stamp in milliseconds from epoch.

See Also:

extractTimestamp(String, String)

extractTimestamp

public static long extractTimestamp(java.lang.String uid,
                                    java.lang.String delim)

Returns the time stamp portion from a UUID

Parameters:

uid - UUID

delim - Delimiter string for optional fields.

Returns:

Time stamp in milliseconds from epoch.

See Also:

extractTimestamp(String)

generateUID

public java.lang.String generateUID()

Description copied from interface: UIDGenerator

Returns a default Unique Identifier

Specified by:

generateUID in interface UIDGenerator

generateUID

public java.lang.String generateUID(java.lang.String... extraFields)

Description copied from interface: UIDGenerator

Returns a Unique Identifier prepended with one or more options field values.

Specified by:

generateUID in interface UIDGenerator

Parameters:

extraFields - An array of one or more additional fields to place at the beginning of the UID. Each extra field value is followed by the delimiter string.

See Also:

UIDGenerator.setDelimiter(String), UIDGenerator.getDelimiter()

getDelimiter

public java.lang.String getDelimiter()

Description copied from interface: UIDGenerator

Returns the optional field delimiter string

Specified by:

getDelimiter in interface UIDGenerator

See Also:

UIDGenerator.setDelimiter(String), UIDGenerator.DEFAULT_DELIMITER

setDelimiter

public void setDelimiter(java.lang.String delim)

Description copied from interface: UIDGenerator

Sets the optional field delimiter string

Specified by:

setDelimiter in interface UIDGenerator

Parameters:

delim - The delimiter string to use. If not specified, defaults to UIDGenerator.DEFAULT_DELIMITER.

See Also:

UIDGenerator.getDelimiter()

getRandomCharSet

public char[] getRandomCharSet()

Description copied from interface: UIDGenerator

Returns the character set used for generating UID's the random field.

Specified by:

getRandomCharSet in interface UIDGenerator

setRandomCharSet

public void setRandomCharSet(char[] charSet)

Description copied from interface: UIDGenerator

Sets the character set to use

Specified by:

setRandomCharSet in interface UIDGenerator

Parameters:

charSet - The character set to use for generating the UID's random field. If not specified, defaults to UIDGenerator.DEFAULT_RANDOM_FIELD_CHARS.

getRandomFieldLen

public int getRandomFieldLen()

Description copied from interface: UIDGenerator

Returns the number of characters in the UID's random field.

Specified by:

getRandomFieldLen in interface UIDGenerator

setRandomFieldLen

public void setRandomFieldLen(int len)

Description copied from interface: UIDGenerator

Sets the number of characters in the UID's random field.

Specified by:

setRandomFieldLen in interface UIDGenerator

Parameters:

len - The number of characters to use. If not specified, defaults to UIDGenerator.DEFAULT_RANDOM_LEN.

main

public static void main(java.lang.String[] args)

For debug only