A B C D E F G H I L M N O P R S T U V W X

A

AbstractLongIdentifierGenerator - Class in org.apache.commons.id
Abstract superclass for LongIdentifierGenerator implementations.
AbstractLongIdentifierGenerator() - Constructor for class org.apache.commons.id.AbstractLongIdentifierGenerator
Constructor.
AbstractStringIdentifierGenerator - Class in org.apache.commons.id
Abstract superclass for StringIdentifierGenerator implementations.
AbstractStringIdentifierGenerator() - Constructor for class org.apache.commons.id.AbstractStringIdentifierGenerator
Constructor.
ALPHA_NUMERIC_CHARSET_SIZE - Static variable in class org.apache.commons.id.AbstractStringIdentifierGenerator
Number of alphanumeric characters.
AlphanumericGenerator - Class in org.apache.commons.id.serial
AlphanumericGenerator is an identifier generator that generates an incrementing number in base 36 as a String object.
AlphanumericGenerator(boolean) - Constructor for class org.apache.commons.id.serial.AlphanumericGenerator
Constructor with a default size for the alphanumeric identifier.
AlphanumericGenerator(boolean, int) - Constructor for class org.apache.commons.id.serial.AlphanumericGenerator
Constructor.
AlphanumericGenerator(boolean, String) - Constructor for class org.apache.commons.id.serial.AlphanumericGenerator
Construct with a counter, that will start at the specified alphanumeric value.
append(byte[], byte[]) - Static method in class org.apache.commons.id.uuid.Bytes
Appends two bytes array into one.
areEqual(byte[], byte[]) - Static method in class org.apache.commons.id.uuid.Bytes
Compares two byte arrays for equality.

B

Bytes - Class in org.apache.commons.id.uuid
Static methods for managing byte arrays (all methods follow Big Endian order where most significant bits are in front).
BYTES_IN_SHORT - Static variable in class org.apache.commons.id.uuid.state.StateHelper
Number of bytes in a short.

C

Clock - Interface in org.apache.commons.id.uuid.clock
Provides a timing mechanism for returning the current time in 100-nano second intervals since 00:00:00.00, 15 October 1582.
CLOCK_SEQ_HI_AND_RESERVED_BYTE_8 - Static variable in interface org.apache.commons.id.uuid.Constants
Byte position of the clock sequence and reserved field
clockSequence() - Method in class org.apache.commons.id.uuid.UUID
Returns the clock sequence value in the UUID.
compareTo(byte[], byte[]) - Static method in class org.apache.commons.id.uuid.Bytes
Compares two byte arrays as specified by Comparable.
compareTo(Object) - Method in class org.apache.commons.id.uuid.UUID
Compares two UUID's for equality.
CompositeIdentifierGenerator - Class in org.apache.commons.id
Identifier generator that concatenates the results of a list of string identifier generators.
CompositeIdentifierGenerator(StringIdentifierGenerator[]) - Constructor for class org.apache.commons.id.CompositeIdentifierGenerator
Constructor that does not check for nulls.
CONFIG_FILENAME_KEY - Static variable in class org.apache.commons.id.uuid.state.ReadOnlyResourceStateImpl
The key to use in locating the uuid configuration xml file from System properties.
ConstantIdentifierGenerator - Class in org.apache.commons.id
StringIdentifierGenerator that always returns the same string.
ConstantIdentifierGenerator() - Constructor for class org.apache.commons.id.ConstantIdentifierGenerator
Creates a new ConstantIdentifierGenerator using the default (empty string) constant value.
ConstantIdentifierGenerator(String) - Constructor for class org.apache.commons.id.ConstantIdentifierGenerator
Creates a new ConstantIdentifierGenerator using the given constant value.
Constants - Interface in org.apache.commons.id.uuid
Constant values commonly needed in the uuid classes.
currentNode() - Method in interface org.apache.commons.id.uuid.NodeManager
Returns the current node in use for uuid generation.
currentNode() - Method in class org.apache.commons.id.uuid.NodeManagerImpl
Returns the current node in use for uuid generation.

D

decode(byte[]) - Method in class org.apache.commons.id.Hex
Converts an array of character bytes representing hexidecimal values into an array of bytes of those same values.
decode(Object) - Method in class org.apache.commons.id.Hex
Converts a String or an array of character bytes representing hexidecimal values into an array of bytes of those same values.
decodeHex(char[]) - Static method in class org.apache.commons.id.Hex
Converts an array of characters representing hexidecimal values into an array of bytes of those same values.
decodeMACAddress(String) - Static method in class org.apache.commons.id.uuid.state.StateHelper
Utility method decodes a valid MAC address in the form of XX-XX-XX-XX-XX-XX where each XX represents a hexidecimal value.
DecoderException - Exception in org.apache.commons.id
Thrown when a Decoder has encountered a failure condition during a decode.
DecoderException(String) - Constructor for exception org.apache.commons.id.DecoderException
Creates a DecoderException
DEFAULT_ALPHANUMERIC_IDENTIFIER_SIZE - Static variable in class org.apache.commons.id.AbstractStringIdentifierGenerator
Default size of an alphanumeric identifier.
DEFAULT_CLOCK_IMPL - Static variable in interface org.apache.commons.id.uuid.clock.Clock
The default Clock implementation if not configured
DEFAULT_STATE_IMPL - Static variable in interface org.apache.commons.id.uuid.state.State
The default State implementation class name if not configured.
DEFAULT_THREAD_LIFE - Static variable in class org.apache.commons.id.uuid.clock.ThreadClockImpl
Default time to live of the Clock thread in milliseconds
DigestUtils - Class in org.apache.commons.id
Operations to simplifiy common MessageDigest tasks.
DigestUtils() - Constructor for class org.apache.commons.id.DigestUtils
 

E

encode(byte[]) - Method in class org.apache.commons.id.Hex
Converts an array of bytes into an array of bytes for the characters representing the hexidecimal values of each byte in order.
encode(Object) - Method in class org.apache.commons.id.Hex
Converts a String or an array of bytes into an array of characters representing the hexidecimal values of each byte in order.
encodeHex(byte[]) - Static method in class org.apache.commons.id.Hex
Converts an array of bytes into an array of characters representing the hexidecimal values of each byte in order.
encodeMACAddress(byte[]) - Static method in class org.apache.commons.id.uuid.state.StateHelper
Returns the node id / address byte array in it's hexidecimal string representation in the following format: XX-XX-XX-XX-XX-XX where each XX represents a hexidecimal value.
EncoderException - Exception in org.apache.commons.id
Thrown when there is a failure condition during the encoding process.
EncoderException(String) - Constructor for exception org.apache.commons.id.EncoderException
Creates a new instance of this exception with an useful message.
equals(Object) - Method in class org.apache.commons.id.uuid.state.Node
Returns true if the identifier value in this Node is equal to the identifier value in the compare to Node.
equals(Object) - Method in class org.apache.commons.id.uuid.UUID
Compares two UUID for equality.
execute() - Method in class org.apache.commons.id.uuid.task.UUIDTask
 

F

finalize() - Method in class org.apache.commons.id.uuid.NodeManagerImpl
Asks the State implementation to store.
FORMAT_POSITION1 - Static variable in interface org.apache.commons.id.uuid.Constants
Insertion point 1 for dashes in the string format
FORMAT_POSITION2 - Static variable in interface org.apache.commons.id.uuid.Constants
Insertion point 2 for dashes in the string format
FORMAT_POSITION3 - Static variable in interface org.apache.commons.id.uuid.Constants
Insertion point 3 for dashes in the string format
FORMAT_POSITION4 - Static variable in interface org.apache.commons.id.uuid.Constants
Insertion point 4 for dashes in the string format
fromString(String) - Static method in class org.apache.commons.id.uuid.UUID
Parses a string for a UUID.

G

getClockImpl() - Static method in class org.apache.commons.id.uuid.state.StateHelper
Returns the Clock implementation using commons discovery.
getClockSequence() - Method in class org.apache.commons.id.uuid.state.Node
Returns the clock sequence used in this node.
getIdentifierGenerators() - Method in class org.apache.commons.id.CompositeIdentifierGenerator
Returns a (shallow) copy of the array of identifier generators concatenated by this generator.
getInstance(StringIdentifierGenerator[]) - Static method in class org.apache.commons.id.CompositeIdentifierGenerator
Factory method to create a new CompositeIdentifierGenerator from an input array of StringIdentifierGenerator instances.
getInstance(Collection) - Static method in class org.apache.commons.id.CompositeIdentifierGenerator
Create a new CompositeIdentifierGenerator that concatenates the results of the provided collection of generators.
getInstance(String) - Static method in class org.apache.commons.id.ConstantIdentifierGenerator
Factory method to create a new ConstantIdentifierGenerator with the given constant value.
getInstance() - Static method in class org.apache.commons.id.uuid.VersionFourGenerator
Returns a singleton instance of the version four UUID generator.
getInstance() - Static method in class org.apache.commons.id.uuid.VersionOneGenerator
Returns the singleton instance of the version one UUID generator.
getLastTimestamp() - Method in class org.apache.commons.id.uuid.state.Node
Returns the last uuid timestamp from this Node.
getMillisecondsFromId(Object, long) - Method in class org.apache.commons.id.serial.TimeBasedAlphanumericIdentifierGenerator
Retrieve the number of milliseconds since 1st Jan 1970 that were the base for the given id.
getNodeIdentifier() - Method in class org.apache.commons.id.uuid.state.Node
Returns the node identifier bytes for this node.
getNodes() - Method in class org.apache.commons.id.uuid.state.InMemoryStateImpl
 
getNodes() - Method in class org.apache.commons.id.uuid.state.ReadOnlyResourceStateImpl
 
getNodes() - Method in interface org.apache.commons.id.uuid.state.State
Returns the collection of Nodes for this uuid state information.
getPrefix() - Method in class org.apache.commons.id.serial.PrefixedAlphanumericGenerator
Return the prefix for this prefixed alphanumeric generator.
getPrefix() - Method in class org.apache.commons.id.serial.PrefixedLeftPaddedNumericGenerator
Return the prefix for this prefixed numeric generator.
getPrefix() - Method in class org.apache.commons.id.serial.PrefixedNumericGenerator
Return the prefix for this prefixed numeric generator.
getRawBytes() - Method in class org.apache.commons.id.uuid.UUID
Returns a copy of the byte values contained in this UUID.
getSize() - Method in class org.apache.commons.id.serial.AlphanumericGenerator
Returns the (constant) size of the strings generated by this generator.
getSize() - Method in class org.apache.commons.id.serial.PrefixedAlphanumericGenerator
 
getSize() - Method in class org.apache.commons.id.serial.PrefixedLeftPaddedNumericGenerator
Returns the (constant) size of the strings generated by this generator.
getStateImpl() - Static method in class org.apache.commons.id.uuid.state.StateHelper
Returns the State implementation in use.
getSynchInterval() - Method in class org.apache.commons.id.uuid.state.InMemoryStateImpl
 
getSynchInterval() - Method in class org.apache.commons.id.uuid.state.ReadOnlyResourceStateImpl
 
getSynchInterval() - Method in interface org.apache.commons.id.uuid.state.State
Returns the number of milliseconds to wait between writing to stable storage.
getThreadLife() - Static method in class org.apache.commons.id.uuid.clock.ThreadClockImpl
Returns the thread life in milliseconds.
getUUIDTime() - Method in interface org.apache.commons.id.uuid.clock.Clock
Returns the current time.
getUUIDTime() - Method in class org.apache.commons.id.uuid.clock.SystemClockImpl
 
getUUIDTime() - Method in class org.apache.commons.id.uuid.clock.ThreadClockImpl
Method returns the clocks current time in 100-nanosecond intervals since the Gregorian calander change.
getUUIDTime() - Method in class org.apache.commons.id.uuid.state.Node
Returns the time in UUID time.
getValues() - Method in class org.apache.commons.id.uuid.task.UUIDTask.UUIDVersion
 
GREGORIAN_CHANGE_OFFSET - Static variable in interface org.apache.commons.id.uuid.clock.Clock
Offset from GregorianCalendar Change over to Jan 1 1970 00:00:00.00

H

hashCode() - Method in class org.apache.commons.id.uuid.state.Node
 
hashCode() - Method in class org.apache.commons.id.uuid.UUID
Returns a hash code value for the object.
Hex - Class in org.apache.commons.id
Hex encoder and decoder.
Hex() - Constructor for class org.apache.commons.id.Hex
 
HOSTNAME_MAX_CHAR_LEN - Static variable in class org.apache.commons.id.uuid.state.StateHelper
Number of postitions to shift when shifting by one byte.

I

IdentifierGenerator - Interface in org.apache.commons.id
IdentifierGenerator defines a simple interface for identifier generation.
INFINITE_MAX_LENGTH - Static variable in interface org.apache.commons.id.StringIdentifierGenerator
Constant representing unlimited identifier length, returned by StringIdentifierGenerator.maxLength() when there is no upper bound to the length of an identifier in the sequence
init() - Method in class org.apache.commons.id.uuid.NodeManagerImpl
Initialization
InMemoryStateImpl - Class in org.apache.commons.id.uuid.state
The InMemoryStateImpl is an implementation of the State interface.
InMemoryStateImpl() - Constructor for class org.apache.commons.id.uuid.state.InMemoryStateImpl
 
INTERVALS_PER_MILLI - Static variable in interface org.apache.commons.id.uuid.clock.Clock
Maximum ticks per millisecond interval (1 millisecond = 1 000 000 nanoseconds) / 100
isWrap() - Method in class org.apache.commons.id.serial.AlphanumericGenerator
Getter for property wrap.
isWrap() - Method in class org.apache.commons.id.serial.LongGenerator
Getter for property wrap.
isWrap() - Method in class org.apache.commons.id.serial.NumericGenerator
Getter for property wrap.
isWrap() - Method in class org.apache.commons.id.serial.PrefixedLeftPaddedNumericGenerator
Getter for property wrap.

L

load() - Method in class org.apache.commons.id.uuid.state.InMemoryStateImpl
 
load() - Method in class org.apache.commons.id.uuid.state.ReadOnlyResourceStateImpl
Loads the System.property "commons.uuid.configFileName" (default is "uuid.conf") using commons.discovery.
load() - Method in interface org.apache.commons.id.uuid.state.State
Method loads the Systems node identifier information usually from some stateful storage area.
lockNode(Node) - Method in interface org.apache.commons.id.uuid.NodeManager
Locks a node for use by a generator.
lockNode(Node) - Method in class org.apache.commons.id.uuid.NodeManagerImpl
Locks a node for use by a generator.
LongGenerator - Class in org.apache.commons.id.serial
LongGenerator is an Identifier Generator that generates an incrementing number as a Long object.
LongGenerator(boolean, long) - Constructor for class org.apache.commons.id.serial.LongGenerator
Constructor.
LongIdentifierGenerator - Interface in org.apache.commons.id
LongIdentifier defines a simple interface for Long based identifier generation.

M

MAX_INT_ALPHANUMERIC_VALUE_LENGTH - Static variable in class org.apache.commons.id.AbstractStringIdentifierGenerator
Maximum length for an alphanumeric string representing an integer value.
MAX_INT_NUMERIC_VALUE_LENGTH - Static variable in class org.apache.commons.id.AbstractStringIdentifierGenerator
Maximum length for a numeric string representing an integer value.
MAX_LONG_ALPHANUMERIC_VALUE_LENGTH - Static variable in class org.apache.commons.id.AbstractStringIdentifierGenerator
Maximum length for an alphanumeric string representing a long value.
MAX_LONG_NUMERIC_VALUE_LENGTH - Static variable in class org.apache.commons.id.AbstractStringIdentifierGenerator
Maximum length for a numeric string representing a long value.
maxLength() - Method in class org.apache.commons.id.AbstractStringIdentifierGenerator
Returns the maximum length (number or characters) for an identifier from this sequence.
maxLength() - Method in class org.apache.commons.id.CompositeIdentifierGenerator
 
maxLength() - Method in class org.apache.commons.id.ConstantIdentifierGenerator
Returns the length of the constant string returned by this generator.
maxLength() - Method in class org.apache.commons.id.random.SessionIdGenerator
 
maxLength() - Method in class org.apache.commons.id.serial.AlphanumericGenerator
 
maxLength() - Method in class org.apache.commons.id.serial.NumericGenerator
Returns the maximum length (number or characters) for an identifier from this sequence.
maxLength() - Method in class org.apache.commons.id.serial.PrefixedAlphanumericGenerator
 
maxLength() - Method in class org.apache.commons.id.serial.PrefixedLeftPaddedNumericGenerator
 
maxLength() - Method in class org.apache.commons.id.serial.PrefixedNumericGenerator
 
maxLength() - Method in class org.apache.commons.id.serial.TimeBasedAlphanumericIdentifierGenerator
 
maxLength() - Method in interface org.apache.commons.id.StringIdentifierGenerator
Returns the maximum length (number or characters) for an identifier from this sequence.
maxValue() - Method in class org.apache.commons.id.AbstractLongIdentifierGenerator
Returns the maximum value of an identifier from this generator.
maxValue() - Method in interface org.apache.commons.id.LongIdentifierGenerator
Returns the maximum value of an identifier from this generator.
md5(byte[]) - Static method in class org.apache.commons.id.DigestUtils
Calculates the MD5 digest and returns the value as a 16 element byte[].
md5(String) - Static method in class org.apache.commons.id.DigestUtils
Calculates the MD5 digest and returns the value as a 16 element byte[].
MD5_ENCODING - Static variable in interface org.apache.commons.id.uuid.Constants
Constants that correspond to the encoding being used, a la http://www.ietf.org/internet-drafts/draft-mealling-uuid-urn-04.txt.
md5Hex(byte[]) - Static method in class org.apache.commons.id.DigestUtils
Calculates the MD5 digest and returns the value as a 32 character hex string.
md5Hex(String) - Static method in class org.apache.commons.id.DigestUtils
Calculates the MD5 digest and returns the value as a 32 character hex string.
minLength() - Method in class org.apache.commons.id.AbstractStringIdentifierGenerator
Returns the minimum length (number of characters) for an identifier from this sequence.
minLength() - Method in class org.apache.commons.id.CompositeIdentifierGenerator
 
minLength() - Method in class org.apache.commons.id.ConstantIdentifierGenerator
Returns the length of the constant string returned by this generator.
minLength() - Method in class org.apache.commons.id.random.SessionIdGenerator
 
minLength() - Method in class org.apache.commons.id.serial.AlphanumericGenerator
 
minLength() - Method in class org.apache.commons.id.serial.NumericGenerator
Returns the minimum length (number of characters) for an identifier from this sequence.
minLength() - Method in class org.apache.commons.id.serial.PrefixedAlphanumericGenerator
 
minLength() - Method in class org.apache.commons.id.serial.PrefixedLeftPaddedNumericGenerator
 
minLength() - Method in class org.apache.commons.id.serial.PrefixedNumericGenerator
 
minLength() - Method in class org.apache.commons.id.serial.TimeBasedAlphanumericIdentifierGenerator
 
minLength() - Method in interface org.apache.commons.id.StringIdentifierGenerator
Returns the minimum length (number of characters) for an identifier from this sequence.
minValue() - Method in class org.apache.commons.id.AbstractLongIdentifierGenerator
Returns the minimum value of an identifier from this generator.
minValue() - Method in interface org.apache.commons.id.LongIdentifierGenerator
Returns the minimum value of an identifier from this generator.

N

nameUUIDFromString(String, UUID, String) - Static method in class org.apache.commons.id.uuid.UUID
Returns a new version three (MD5) or five (SHA-1) UUID, using the specified encoding given a name and the namespace's UUID.
nameUUIDFromString(String, UUID) - Static method in class org.apache.commons.id.uuid.UUID
Returns a new version three UUID given a name and the namespace's UUID.
newClockSequence() - Static method in class org.apache.commons.id.uuid.state.StateHelper
Generates a new security quality random clock sequence.
nextAvailableNode() - Method in interface org.apache.commons.id.uuid.NodeManager
Returns the next available Node for uuid generation.
nextAvailableNode() - Method in class org.apache.commons.id.uuid.NodeManagerImpl
Returns the next available Node for uuid generation.
nextIdentifier() - Method in class org.apache.commons.id.AbstractLongIdentifierGenerator
 
nextIdentifier() - Method in class org.apache.commons.id.AbstractStringIdentifierGenerator
 
nextIdentifier() - Method in interface org.apache.commons.id.IdentifierGenerator
Gets the next identifier in the sequence.
nextIdentifier() - Method in class org.apache.commons.id.uuid.VersionFourGenerator
Returns a new version four UUID.
nextIdentifier(boolean) - Method in class org.apache.commons.id.uuid.VersionFourGenerator
Returns a new version four UUID.
nextIdentifier() - Method in class org.apache.commons.id.uuid.VersionOneGenerator
 
nextLongIdentifier() - Method in class org.apache.commons.id.AbstractLongIdentifierGenerator
 
nextLongIdentifier() - Method in interface org.apache.commons.id.LongIdentifierGenerator
Gets the next identifier in the sequence.
nextLongIdentifier() - Method in class org.apache.commons.id.serial.LongGenerator
 
nextStringIdentifier() - Method in class org.apache.commons.id.AbstractStringIdentifierGenerator
 
nextStringIdentifier() - Method in class org.apache.commons.id.CompositeIdentifierGenerator
 
nextStringIdentifier() - Method in class org.apache.commons.id.ConstantIdentifierGenerator
 
nextStringIdentifier() - Method in class org.apache.commons.id.random.SessionIdGenerator
Gets the next new identifier.
nextStringIdentifier() - Method in class org.apache.commons.id.serial.AlphanumericGenerator
 
nextStringIdentifier() - Method in class org.apache.commons.id.serial.NumericGenerator
 
nextStringIdentifier() - Method in class org.apache.commons.id.serial.PrefixedAlphanumericGenerator
 
nextStringIdentifier() - Method in class org.apache.commons.id.serial.PrefixedLeftPaddedNumericGenerator
 
nextStringIdentifier() - Method in class org.apache.commons.id.serial.PrefixedNumericGenerator
 
nextStringIdentifier() - Method in class org.apache.commons.id.serial.TimeBasedAlphanumericIdentifierGenerator
 
nextStringIdentifier() - Method in interface org.apache.commons.id.StringIdentifierGenerator
Gets the next identifier in the sequence.
nextUUID() - Method in class org.apache.commons.id.uuid.VersionFourGenerator
Returns a new version four UUID.
nextUUID() - Method in class org.apache.commons.id.uuid.VersionOneGenerator
Returns a new version 1 UUID.
Node - Class in org.apache.commons.id.uuid.state
The Node class represents the data and accessors for a single node identifier.
Node(byte[]) - Constructor for class org.apache.commons.id.uuid.state.Node
Constructor used to create a Node when the lastTimestamp and clock sequence are unavailable.
Node(byte[], long, short) - Constructor for class org.apache.commons.id.uuid.state.Node
Constructor used to create a Node when all persistent state information is available; node bytes, lastTimestamp, and clock sequence.
node() - Method in class org.apache.commons.id.uuid.UUID
Returns the node identifier found in this UUID.
NODE_ID_BYTE_LENGTH - Static variable in class org.apache.commons.id.uuid.state.StateHelper
Array length of node bytes.
NodeManager - Interface in org.apache.commons.id.uuid
Class is responsible for managing the Nodes identified for this system (JVM instance), as well as the state management for the Nodes.
NodeManagerImpl - Class in org.apache.commons.id.uuid
Class is responsible for managing the Nodes identified for this system (JVM instance), as well as the state management for the Nodes.
NodeManagerImpl() - Constructor for class org.apache.commons.id.uuid.NodeManagerImpl
Constructor for class.
NumericGenerator - Class in org.apache.commons.id.serial
NumericIdentifierGenerator is an Identifier Generator that generates an incrementing number as a String object.
NumericGenerator(boolean, long) - Constructor for class org.apache.commons.id.serial.NumericGenerator
Constructor.

O

org.apache.commons.id - package org.apache.commons.id
This package contains factories and implementation classes to generate unique identifiers.
org.apache.commons.id.random - package org.apache.commons.id.random
This package contains identifier generators that return sequences of identifiers that appear to be random.
org.apache.commons.id.serial - package org.apache.commons.id.serial
This package contains identifier generators that yield sequences of identifiers that follow a prescribed order.
org.apache.commons.id.uuid - package org.apache.commons.id.uuid
This package contains UUID (Universally Unique Identifier) generator implementations and supporting classes.
org.apache.commons.id.uuid.clock - package org.apache.commons.id.uuid.clock
This package contains the Clock interface and implementations for generating UUID timestamps.
org.apache.commons.id.uuid.state - package org.apache.commons.id.uuid.state
This package contains persistent and non-persistent state implementations for data related to the generation of version 1 UUIDs.
org.apache.commons.id.uuid.task - package org.apache.commons.id.uuid.task
This package contains an Ant task to generate UUIDs.
OverClockedException - Exception in org.apache.commons.id.uuid.clock
This exception is raised whenever the clock generates too many timestamps in a given system interval.
OverClockedException() - Constructor for exception org.apache.commons.id.uuid.clock.OverClockedException
Constructs a OverClockedException with no message.
OverClockedException(String) - Constructor for exception org.apache.commons.id.uuid.clock.OverClockedException
Constructs a OverClockedException with a message.

P

parse(InputStream) - Method in class org.apache.commons.id.uuid.state.ReadOnlyResourceStateImpl
Parses the XML configuration into the Nodes and places into this instances node collection.
PrefixedAlphanumericGenerator - Class in org.apache.commons.id.serial
PrefixedAlphanumericGenerator is an identifier generator that generates an incrementing number in base 36 with a prefix as a String object.
PrefixedAlphanumericGenerator(String, boolean, int) - Constructor for class org.apache.commons.id.serial.PrefixedAlphanumericGenerator
Create a new prefixed alphanumeric generator with the specified prefix.
PrefixedLeftPaddedNumericGenerator - Class in org.apache.commons.id.serial
PrefixedLeftPaddedNumericGenerator is an Identifier Generator that generates a left-padded incrementing number with a prefix as a String object.
PrefixedLeftPaddedNumericGenerator(String, boolean, int) - Constructor for class org.apache.commons.id.serial.PrefixedLeftPaddedNumericGenerator
Create a new prefixed left-padded numeric generator with the specified prefix.
PrefixedNumericGenerator - Class in org.apache.commons.id.serial
PrefixedNumericGenerator is an Identifier Generator that generates an incrementing number with a prefix as a String object.
PrefixedNumericGenerator(String, boolean, long) - Constructor for class org.apache.commons.id.serial.PrefixedNumericGenerator
Create a new prefixed numeric generator with the specified prefix.

R

randomNodeIdentifier() - Static method in class org.apache.commons.id.uuid.state.StateHelper
Creates a Random node identifier as described in IEFT UUID URN specification.
randomUUID() - Static method in class org.apache.commons.id.uuid.UUID
Returns a new version 4 UUID, based upon Random bits.
ReadOnlyResourceStateImpl - Class in org.apache.commons.id.uuid.state
The ReadOnlyResourceStateImpl is an implementation of the State interface.
ReadOnlyResourceStateImpl() - Constructor for class org.apache.commons.id.uuid.state.ReadOnlyResourceStateImpl
Constructs a ReadOnlyResouceStateImpl.
ReadWriteFileStateImpl - Class in org.apache.commons.id.uuid.state
The ReadWriteFileStateImpl is an implementation of the State interface.
ReadWriteFileStateImpl() - Constructor for class org.apache.commons.id.uuid.state.ReadWriteFileStateImpl
 
releaseNode(Node) - Method in interface org.apache.commons.id.uuid.NodeManager
Releases a node locked by a generator.
releaseNode(Node) - Method in class org.apache.commons.id.uuid.NodeManagerImpl
Releases a node locked by a generator.
run() - Method in class org.apache.commons.id.uuid.clock.ThreadClockImpl
Threads run method that increments the clock and resets the generated nano seconds counter.

S

SessionIdGenerator - Class in org.apache.commons.id.random
SessionIdGenerator is an identifier generator that generates an alphanumeric 10+ character identifier.
SessionIdGenerator() - Constructor for class org.apache.commons.id.random.SessionIdGenerator
Constructor.
setName(String) - Method in class org.apache.commons.id.uuid.task.UUIDTask
Setter for the name used to generate a UUID version 3 or 5.
setNamespace(String) - Method in class org.apache.commons.id.uuid.task.UUIDTask
Setter for the namespace used to generate a UUID version 3 or 5.
setPRNGProvider(String, String) - Static method in class org.apache.commons.id.uuid.VersionFourGenerator
Allows clients to set the pseudo-random number generator implementation used when generating a version four uuid with the secure option.
setThreadLife(long) - Static method in class org.apache.commons.id.uuid.clock.ThreadClockImpl
 
setVersion(UUIDTask.UUIDVersion) - Method in class org.apache.commons.id.uuid.task.UUIDTask
Set the UUID version to generate.
setWrap(boolean) - Method in class org.apache.commons.id.serial.AlphanumericGenerator
Sets the wrap property.
setWrap(boolean) - Method in class org.apache.commons.id.serial.LongGenerator
Sets the wrap property.
setWrap(boolean) - Method in class org.apache.commons.id.serial.NumericGenerator
Sets the wrap property.
setWrap(boolean) - Method in class org.apache.commons.id.serial.PrefixedLeftPaddedNumericGenerator
Setter for property wrap.
sha(byte[]) - Static method in class org.apache.commons.id.DigestUtils
Calculates the SHA digest and returns the value as a byte[].
sha(String) - Static method in class org.apache.commons.id.DigestUtils
Calculates the SHA digest and returns the value as a byte[].
SHA1_ENCODING - Static variable in interface org.apache.commons.id.uuid.Constants
 
shaHex(byte[]) - Static method in class org.apache.commons.id.DigestUtils
Calculates the SHA digest and returns the value as a hex string.
shaHex(String) - Static method in class org.apache.commons.id.DigestUtils
Calculates the SHA digest and returns the value as a hex string.
SHIFT_BY_BYTE - Static variable in class org.apache.commons.id.uuid.state.StateHelper
Number of postitions to shift when shifting by one byte.
State - Interface in org.apache.commons.id.uuid.state
The State interface.
StateHelper - Class in org.apache.commons.id.uuid.state
StateHelper provides helper methods for the uuid state implementations.
store(Set) - Method in class org.apache.commons.id.uuid.state.InMemoryStateImpl
 
store(Set, long) - Method in class org.apache.commons.id.uuid.state.InMemoryStateImpl
 
store(Set) - Method in class org.apache.commons.id.uuid.state.ReadOnlyResourceStateImpl
 
store(Set, long) - Method in class org.apache.commons.id.uuid.state.ReadOnlyResourceStateImpl
 
store(Set) - Method in class org.apache.commons.id.uuid.state.ReadWriteFileStateImpl
Persists the UUID generator state to file.
store(Set) - Method in interface org.apache.commons.id.uuid.state.State
Stores the state information.
store(Set, long) - Method in interface org.apache.commons.id.uuid.state.State
Stores the state information using a predetermined timestamp.
StringIdentifierGenerator - Interface in org.apache.commons.id
StringIdentifierGenerator defines a simple interface for String based identifier generation.
SystemClockImpl - Class in org.apache.commons.id.uuid.clock
SystemClockImpl provides a timing mechanism for returning the current time in 100-nano second intervals since 00:00:00.00, 15 October 1582.
SystemClockImpl() - Constructor for class org.apache.commons.id.uuid.clock.SystemClockImpl
Public constructor.

T

ThreadClockImpl - Class in org.apache.commons.id.uuid.clock
Clock provides a timing mechanism for returning the current time in 100-nano second intervals since 00:00:00.00, 15 October 1582.
ThreadClockImpl() - Constructor for class org.apache.commons.id.uuid.clock.ThreadClockImpl
Public constructor to instantiate a Clock instance.
TIME_HI_AND_VERSION_BYTE_6 - Static variable in interface org.apache.commons.id.uuid.Constants
Byte position of the clock sequence and reserved field
TIME_HI_BYTE_LEN - Static variable in interface org.apache.commons.id.uuid.Constants
Byte length of time low field
TIME_HI_START_POS - Static variable in interface org.apache.commons.id.uuid.Constants
uuid array position start of hi field
TIME_HI_TS_POS - Static variable in interface org.apache.commons.id.uuid.Constants
Timestamp byte[] position hi field
TIME_LOW_BYTE_LEN - Static variable in interface org.apache.commons.id.uuid.Constants
Byte length of time low field
TIME_LOW_START_POS - Static variable in interface org.apache.commons.id.uuid.Constants
uuid array position start of time low field
TIME_LOW_TS_POS - Static variable in interface org.apache.commons.id.uuid.Constants
Timestamp byte[] position of time low field
TIME_MID_BYTE_LEN - Static variable in interface org.apache.commons.id.uuid.Constants
Byte length of time low field
TIME_MID_START_POS - Static variable in interface org.apache.commons.id.uuid.Constants
uuid array position start of mid field
TIME_MID_TS_POS - Static variable in interface org.apache.commons.id.uuid.Constants
Timestamp byte[] position mid field
TimeBasedAlphanumericIdentifierGenerator - Class in org.apache.commons.id.serial
TimeBasedAlphanumericIdentifierGenerator is an identifier generator that generates an alphanumeric identifier in base 36 as a String object from the current UTC time and an internal counter.
TimeBasedAlphanumericIdentifierGenerator(int, long) - Constructor for class org.apache.commons.id.serial.TimeBasedAlphanumericIdentifierGenerator
Construct a TimeBasedAlphanumericIdentifierGenerator with a defined size of the postfix and an offset for the time value.
TimeBasedAlphanumericIdentifierGenerator(int) - Constructor for class org.apache.commons.id.serial.TimeBasedAlphanumericIdentifierGenerator
Construct a TimeBasedAlphanumericIdentifierGenerator with a defined size of the postfix.
TimeBasedAlphanumericIdentifierGenerator() - Constructor for class org.apache.commons.id.serial.TimeBasedAlphanumericIdentifierGenerator
Construct a TimeBasedAlphanumericIdentifierGenerator with a default size of the postfix of 3.
timestamp() - Method in class org.apache.commons.id.uuid.UUID
Returns the timestamp value of the UUID as 100-nano second intervals since the Gregorian change offset (00:00:00.00, 15 October 1582 ).
timeUUID() - Static method in class org.apache.commons.id.uuid.UUID
Returns a new version 1 UUID, based upon node identifier and time stamp.
toBytes(long) - Static method in class org.apache.commons.id.uuid.Bytes
Returns a 8-byte array built from a long.
toBytes(long, byte[]) - Static method in class org.apache.commons.id.uuid.Bytes
Build a 8-byte array from a long.
toDigit(char, int) - Static method in class org.apache.commons.id.Hex
Converts a hexadecimal character to an integer.
TOKEN_LENGTHS - Static variable in interface org.apache.commons.id.uuid.Constants
Array to check tokenized UUID's segment lengths
TOKENS_IN_UUID - Static variable in interface org.apache.commons.id.uuid.Constants
Token length of '-' separated tokens.
toLong(byte[]) - Static method in class org.apache.commons.id.uuid.Bytes
Build a long from first 8 bytes of the array.
toShort(byte[]) - Static method in class org.apache.commons.id.uuid.Bytes
Build a short from first 2 bytes of the array.
toString() - Method in class org.apache.commons.id.uuid.UUID
Returns a string representation of the UUID.
toUrn() - Method in class org.apache.commons.id.uuid.UUID
Returns a urn representation of the UUID.

U

URN_PREFIX - Static variable in interface org.apache.commons.id.uuid.Constants
The string prefix for a urn UUID identifier.
UUID - Class in org.apache.commons.id.uuid
UUID represents a Universally Unique Identifier per RFC 4122.
UUID() - Constructor for class org.apache.commons.id.uuid.UUID
Constructs a nil UUID
UUID(UUID) - Constructor for class org.apache.commons.id.uuid.UUID
Copy constructor.
UUID(byte[]) - Constructor for class org.apache.commons.id.uuid.UUID
Constructs a UUID from a 16 byte array.
UUID(DataInput) - Constructor for class org.apache.commons.id.uuid.UUID
Constructs a UUID from a DataInput.
UUID(long, long) - Constructor for class org.apache.commons.id.uuid.UUID
Constructs a UUID from two long values in most significant byte, and least significant bytes order.
UUID(String) - Constructor for class org.apache.commons.id.uuid.UUID
Constructs a UUID from a UUID formatted String.
UUID_BIT_LENGTH - Static variable in interface org.apache.commons.id.uuid.Constants
Bits in a UUID.
UUID_BYTE_LENGTH - Static variable in interface org.apache.commons.id.uuid.Constants
Number of bytes in a UUID.
UUID_CLOCK_IMPL_PROPERTY_KEY - Static variable in class org.apache.commons.id.uuid.state.StateHelper
The key for the System.property containing the ClockImpl String.
UUID_FORMATTED_LENGTH - Static variable in interface org.apache.commons.id.uuid.Constants
Chars in a UUID String.
UUID_STATE_IMPL_PROPERTY_KEY - Static variable in class org.apache.commons.id.uuid.state.StateHelper
The key for the System.property containing the StateImpl String.
UUID_UNFORMATTED_LENGTH - Static variable in interface org.apache.commons.id.uuid.Constants
Chars in a UUID String.
UUIDFormatException - Exception in org.apache.commons.id.uuid
Thrown to indicate an attempted to convert a string to a UUID, but that the string does not have the appropriate format.
UUIDFormatException() - Constructor for exception org.apache.commons.id.uuid.UUIDFormatException
Constructs a UUIDFormatException with no message.
UUIDFormatException(String) - Constructor for exception org.apache.commons.id.uuid.UUIDFormatException
Constructs a UUIDFormatException with a message.
UUIDTask - Class in org.apache.commons.id.uuid.task
Simple Ant task to generate a UUID.
UUIDTask() - Constructor for class org.apache.commons.id.uuid.task.UUIDTask
 
UUIDTask.UUIDVersion - Class in org.apache.commons.id.uuid.task
The enum for the UUID version.
UUIDTask.UUIDVersion() - Constructor for class org.apache.commons.id.uuid.task.UUIDTask.UUIDVersion
 

V

variant() - Method in class org.apache.commons.id.uuid.UUID
Returns the variant field of the UUID.
VARIANT_FUTURE - Static variable in interface org.apache.commons.id.uuid.Constants
UUID variant bits described in the IETF Draft MSB order, this is the "Future Reserved variant 1 1 1 x with unknown bits as 0
VARIANT_IETF_DRAFT - Static variable in interface org.apache.commons.id.uuid.Constants
UUID variant bits described in the IETF Draft MSB order, this is the IETF Draft memo variant field 1 0 x with unknown bits as 0
VARIANT_MS - Static variable in interface org.apache.commons.id.uuid.Constants
UUID variant bits described in the IETF Draft MSB order, this is the IETF Draft "Microsoft Corporation" field variant 1 1 0 x with unknown bits as 0
VARIANT_NCS_COMPAT - Static variable in interface org.apache.commons.id.uuid.Constants
UUID variant bits described in the IETF Draft MSB order, this is the "Reserved, NCS backward compatibility field" 0 x x with unknown bits as 0
version() - Method in class org.apache.commons.id.uuid.UUID
Returns the version of the UUID.
VERSION_FIVE - Static variable in interface org.apache.commons.id.uuid.Constants
Version five constant for UUID version five - identical to version 3
VERSION_FOUR - Static variable in interface org.apache.commons.id.uuid.Constants
Version four constant for UUID version four of four
VERSION_ONE - Static variable in interface org.apache.commons.id.uuid.Constants
Version one constant for UUID version one of four
VERSION_THREE - Static variable in interface org.apache.commons.id.uuid.Constants
Version three constant for UUID version three of four
VERSION_TWO - Static variable in interface org.apache.commons.id.uuid.Constants
Version two constant for UUID version two of four
VersionFourGenerator - Class in org.apache.commons.id.uuid
Class is responsible for generating version 4 UUID's per RFC 4122.
VersionFourGenerator() - Constructor for class org.apache.commons.id.uuid.VersionFourGenerator
Constructs a new VersionFourGenerator.
VersionOneGenerator - Class in org.apache.commons.id.uuid
Class is responsible for generating version 1 UUID's per RFC 4122.

W

WRONG_VAR_VER_MSG - Static variable in interface org.apache.commons.id.uuid.Constants
Message indicating this is not a version one UUID

X

XML_DOC_END - Static variable in class org.apache.commons.id.uuid.state.StateHelper
End of the XML document used to store state persistence in XML
XML_DOC_START - Static variable in class org.apache.commons.id.uuid.state.StateHelper
Start of the XML document used to store state persistence in XML
XML_DOC_START_END - Static variable in class org.apache.commons.id.uuid.state.StateHelper
End of document start
XML_NODE_TAG_AFTER_CSEQ - Static variable in class org.apache.commons.id.uuid.state.StateHelper
After clock sequence of XML node tag
XML_NODE_TAG_AFTER_ID - Static variable in class org.apache.commons.id.uuid.state.StateHelper
After id of XML node tag
XML_NODE_TAG_END - Static variable in class org.apache.commons.id.uuid.state.StateHelper
End of XML node tag
XML_NODE_TAG_START - Static variable in class org.apache.commons.id.uuid.state.StateHelper
Start of XML node tag

A B C D E F G H I L M N O P R S T U V W X

Copyright 2003-2008 The Apache Software Foundation. All Rights Reserved.