org.assistments.util

Interface UIDGenerator

All Known Implementing Classes:

UIDGeneratorGWTImpl

public interface UIDGenerator

UIDGenerator specifies the methods needed create psuedo-random unique identifiers. A UID is composed of the following fields:

<optional fields><core UID>

Where:

<optional fields>

Each optional field is of the form:
<extra field N><delimiter string>

<core UID>

The core UID is of the form:
<current system time in milliseconds>+<N random chars>

Examples:

• From calling generateUID(): 1288203457807+ldL7V7nWbi2Se3ue
• From calling generateUID(String...) as generateUID("userName", "7"): userName-7-1288203457807+ZRQIyDWMtevcpidF

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CORE_UID_FIELD_DELIMITER Delimiter used to separate the core UID fields (of time stamp and random chars).
static java.lang.String	DEFAULT_DELIMITER Default delimiter used to separate the optional (extra) UID fields.
static char[]	DEFAULT_RANDOM_FIELD_CHARS Default character set to use when generating the <N random chars> component.
static int	DEFAULT_RANDOM_LEN Specifies the default number of random alpha-numeric characters to included in each returned UID.

Method Summary

Modifier and Type	Method and Description
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.
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.

Field Detail

DEFAULT_RANDOM_LEN

static final int DEFAULT_RANDOM_LEN

Specifies the default number of random alpha-numeric characters to included in each returned UID.

See Also:

Constant Field Values

DEFAULT_DELIMITER

static final java.lang.String DEFAULT_DELIMITER

Default delimiter used to separate the optional (extra) UID fields.

See Also:

Constant Field Values

DEFAULT_RANDOM_FIELD_CHARS

static final char[] DEFAULT_RANDOM_FIELD_CHARS

Default character set to use when generating the <N random chars> component.

CORE_UID_FIELD_DELIMITER

static final java.lang.String CORE_UID_FIELD_DELIMITER

Delimiter used to separate the core UID fields (of time stamp and random chars).

See Also:

Constant Field Values

Method Detail

generateUID

java.lang.String generateUID()

Returns a default Unique Identifier

generateUID

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

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

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:

setDelimiter(String), getDelimiter()

getDelimiter

java.lang.String getDelimiter()

Returns the optional field delimiter string

See Also:

setDelimiter(String), DEFAULT_DELIMITER

setDelimiter

void setDelimiter(java.lang.String delim)

Sets the optional field delimiter string

Parameters:

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

See Also:

getDelimiter()

getRandomCharSet

char[] getRandomCharSet()

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

setRandomCharSet

void setRandomCharSet(char[] charSet)

Sets the character set to use

Parameters:

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

getRandomFieldLen

int getRandomFieldLen()

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

setRandomFieldLen

void setRandomFieldLen(int len)

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

Parameters:

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