Index (Java UUID Generator 4.0.1 API)

A B C D E F G I J M N O P R S T U V _

A

asByteArray() - Method in class com.fasterxml.uuid.EthernetAddress: Returns 6 byte byte array that contains the binary representation of this ethernet address; byte 0 is the most significant byte (and so forth)
asByteArray(UUID) - Static method in class com.fasterxml.uuid.impl.UUIDUtil

B

BYTE_OFFSET_CLOCK_HI - Static variable in class com.fasterxml.uuid.impl.UUIDUtil
BYTE_OFFSET_CLOCK_LO - Static variable in class com.fasterxml.uuid.impl.UUIDUtil
BYTE_OFFSET_CLOCK_MID - Static variable in class com.fasterxml.uuid.impl.UUIDUtil
BYTE_OFFSET_CLOCK_SEQUENCE - Static variable in class com.fasterxml.uuid.impl.UUIDUtil
BYTE_OFFSET_TYPE - Static variable in class com.fasterxml.uuid.impl.UUIDUtil
BYTE_OFFSET_VARIATION - Static variable in class com.fasterxml.uuid.impl.UUIDUtil

C

clone() - Method in class com.fasterxml.uuid.EthernetAddress: Default cloning behaviour (bitwise copy) is just fine...
com.fasterxml.uuid - package com.fasterxml.uuid: Package that contains core (non-optional) Java UUID Generator API classes.
com.fasterxml.uuid.ext - package com.fasterxml.uuid.ext: Package that contains optional Java UUID Generator classes; classes that: Depend on optional external packages; like log4j or java.util.logging - based Logger adapters (java.util.logging itself was added in JDK 1.4)
com.fasterxml.uuid.impl - package com.fasterxml.uuid.impl
compare(UUID, UUID) - Method in class com.fasterxml.uuid.UUIDComparator
compareTo(EthernetAddress) - Method in class com.fasterxml.uuid.EthernetAddress: Method that compares this EthernetAddress to one passed in as argument.
compareUInts(int, int) - Static method in class com.fasterxml.uuid.UUIDComparator
compareULongs(long, long) - Static method in class com.fasterxml.uuid.UUIDComparator
constructMulticastAddress() - Static method in class com.fasterxml.uuid.EthernetAddress: Factory method that can be used to construct a random multicast address; to be used in cases where there is no "real" ethernet address to use.
constructMulticastAddress(Random) - Static method in class com.fasterxml.uuid.EthernetAddress: Factory method that can be used to construct a random multicast address; to be used in cases where there is no "real" ethernet address to use.
constructUUID(UUIDType, byte[]) - Static method in class com.fasterxml.uuid.impl.UUIDUtil: Helper method for constructing UUID instances with appropriate type
constructUUID(UUIDType, long, long) - Static method in class com.fasterxml.uuid.impl.UUIDUtil
currentTimeMillis() - Method in class com.fasterxml.uuid.UUIDClock: Returns the current time in milliseconds.

D

deactivate() - Method in class com.fasterxml.uuid.ext.FileBasedTimestampSynchronizer
deactivate() - Method in class com.fasterxml.uuid.TimestampSynchronizer: Method UUIDTimer will call if this synchronizer object is being replaced by another synchronizer (or removed, that is, no more synchronization is to be done).
DEFAULT_LOCK_FILE_NAME1 - Static variable in class com.fasterxml.uuid.ext.FileBasedTimestampSynchronizer
DEFAULT_LOCK_FILE_NAME2 - Static variable in class com.fasterxml.uuid.ext.FileBasedTimestampSynchronizer
doDeactivate(LockedFile, LockedFile) - Static method in class com.fasterxml.uuid.ext.FileBasedTimestampSynchronizer

E

equals(Object) - Method in class com.fasterxml.uuid.EthernetAddress
EthernetAddress - Class in com.fasterxml.uuid: EthernetAddress encapsulates the 6-byte MAC address defined in IEEE 802.1 standard.
EthernetAddress(String) - Constructor for class com.fasterxml.uuid.EthernetAddress: String constructor; given a 'standard' ethernet MAC address string (like '00:C0:F0:3D:5B:7C'), constructs an EthernetAddress instance.
EthernetAddress(byte[]) - Constructor for class com.fasterxml.uuid.EthernetAddress: Binary constructor that constructs an instance given the 6 byte (48-bit) address.
EthernetAddress(long) - Constructor for class com.fasterxml.uuid.EthernetAddress: Another binary constructor; constructs an instance from the given long argument; the lowest 6 bytes contain the address.

F

FileBasedTimestampSynchronizer - Class in com.fasterxml.uuid.ext: Implementation of TimestampSynchronizer, which uses file system as the storage and locking mechanism.
FileBasedTimestampSynchronizer() - Constructor for class com.fasterxml.uuid.ext.FileBasedTimestampSynchronizer: Constructor that uses default values for names of files to use (files will get created in the current working directory), as well as for the update frequency value (10 seconds).
FileBasedTimestampSynchronizer(File, File) - Constructor for class com.fasterxml.uuid.ext.FileBasedTimestampSynchronizer
FileBasedTimestampSynchronizer(File, File, long) - Constructor for class com.fasterxml.uuid.ext.FileBasedTimestampSynchronizer
FileSyncTest - Class in test: Simple manual utility test class for manually checking whether file-based synchronization seems to be working or not.
FileSyncTest() - Constructor for class test.FileSyncTest
fromInterface() - Static method in class com.fasterxml.uuid.EthernetAddress: Factory method that locates a network interface that has a suitable mac address (ethernet cards, and things that emulate one), and return that address.

G

gatherLong(byte[], int) - Static method in class com.fasterxml.uuid.impl.UUIDUtil
generate(String) - Method in class com.fasterxml.uuid.impl.NameBasedGenerator
generate(byte[]) - Method in class com.fasterxml.uuid.impl.NameBasedGenerator
generate() - Method in class com.fasterxml.uuid.impl.RandomBasedGenerator
generate() - Method in class com.fasterxml.uuid.impl.TimeBasedGenerator
generate() - Method in class com.fasterxml.uuid.NoArgGenerator
generate(String) - Method in class com.fasterxml.uuid.StringArgGenerator: Method for generating name-based UUIDs using specified name (serialized to bytes using UTF-8 encoding)
generate(byte[]) - Method in class com.fasterxml.uuid.StringArgGenerator: Method for generating name-based UUIDs using specified byte-serialization of name.
GeneratorImplBase - Class in com.fasterxml.uuid.impl: Shared base class for various UUID generator implementations.
GeneratorImplBase() - Constructor for class com.fasterxml.uuid.impl.GeneratorImplBase
Generators - Class in com.fasterxml.uuid: Root factory class for constructing UUID generators.
Generators() - Constructor for class com.fasterxml.uuid.Generators
getAndSetTimestamp(byte[]) - Method in class com.fasterxml.uuid.UUIDTimer
getClockSequence() - Method in class com.fasterxml.uuid.UUIDTimer
getEthernetAddress() - Method in class com.fasterxml.uuid.impl.TimeBasedGenerator
getNamespace() - Method in class com.fasterxml.uuid.impl.NameBasedGenerator
getTimestamp() - Method in class com.fasterxml.uuid.UUIDTimer: Method that constructs unique timestamp suitable for use for constructing UUIDs.
getType() - Method in class com.fasterxml.uuid.impl.NameBasedGenerator
getType() - Method in class com.fasterxml.uuid.impl.RandomBasedGenerator
getType() - Method in class com.fasterxml.uuid.impl.TimeBasedGenerator
getType() - Method in class com.fasterxml.uuid.UUIDGenerator: Accessor for determining type of UUIDs (variant) that this generator instance will produce.

I

initialize() - Method in class com.fasterxml.uuid.ext.FileBasedTimestampSynchronizer: This method is to be called only once by UUIDTimer.
initialize() - Method in class com.fasterxml.uuid.TimestampSynchronizer: Initialization method is will be called on an instance by UUIDTimer right after it's been configured with one.
initUUIDFirstLong(long, UUIDType) - Static method in class com.fasterxml.uuid.impl.UUIDUtil
initUUIDFirstLong(long, int) - Static method in class com.fasterxml.uuid.impl.UUIDUtil
initUUIDSecondLong(long) - Static method in class com.fasterxml.uuid.impl.UUIDUtil
isLocallyAdministeredAddress() - Method in class com.fasterxml.uuid.EthernetAddress: Method that can be used to check if this address refers to a "locally administered address" (see [http://en.wikipedia.org/wiki/MAC_address] for details).
isMulticastAddress() - Method in class com.fasterxml.uuid.EthernetAddress: Method that can be used to check if this address refers to a multicast address.

J

Jug - Class in com.fasterxml.uuid: Simple command-line interface to UUID generation functionality.
Jug() - Constructor for class com.fasterxml.uuid.Jug

M

main(String[]) - Static method in class com.fasterxml.uuid.Jug
main(String[]) - Static method in class perf.MeasurePerformance
main(String[]) - Static method in class test.FileSyncTest
MeasurePerformance - Class in perf: Simple micro-benchmark for evaluating performance of various UUID generation techniques, including JDK's method as well as JUG's variants.
MeasurePerformance() - Constructor for class perf.MeasurePerformance
mInterval - Variable in class com.fasterxml.uuid.ext.FileBasedTimestampSynchronizer
mLocked1 - Variable in class com.fasterxml.uuid.ext.FileBasedTimestampSynchronizer
mLocked2 - Variable in class com.fasterxml.uuid.ext.FileBasedTimestampSynchronizer

N

nameBasedGenerator() - Static method in class com.fasterxml.uuid.Generators: Factory method for constructing UUID generator that uses specified random number generator for constructing UUIDs according to standard method number 5, but without using a namespace.
nameBasedGenerator(UUID) - Static method in class com.fasterxml.uuid.Generators: Factory method for constructing UUID generator that uses specified random number generator for constructing UUIDs according to standard method number 5, with specified namespace (or without one if null is specified).
nameBasedGenerator(UUID, MessageDigest) - Static method in class com.fasterxml.uuid.Generators: Factory method for constructing UUID generator that uses specified random number generator for constructing UUIDs according to standard method number 3 or 5, with specified namespace (or without one if null is specified), using specified digester.
NameBasedGenerator - Class in com.fasterxml.uuid.impl: Implementation of UUID generator that uses one of name-based generation methods (variants 3 (MD5) and 5 (SHA1)).
NameBasedGenerator(UUID, MessageDigest, UUIDType) - Constructor for class com.fasterxml.uuid.impl.NameBasedGenerator
NAMESPACE_DNS - Static variable in class com.fasterxml.uuid.impl.NameBasedGenerator: Namespace used when name is a DNS name.
NAMESPACE_OID - Static variable in class com.fasterxml.uuid.impl.NameBasedGenerator: Namespace used when name is an OID.
NAMESPACE_URL - Static variable in class com.fasterxml.uuid.impl.NameBasedGenerator: Namespace used when name is a URL.
NAMESPACE_X500 - Static variable in class com.fasterxml.uuid.impl.NameBasedGenerator: Namespace used when name is an X500 identifier
NoArgGenerator - Class in com.fasterxml.uuid: Intermediate base class for UUID generators that do not take arguments for individual calls.
NoArgGenerator() - Constructor for class com.fasterxml.uuid.NoArgGenerator

O

OPTIONS - Static variable in class com.fasterxml.uuid.Jug

P

perf - package perf
printUsage() - Static method in class com.fasterxml.uuid.Jug

R

randomBasedGenerator() - Static method in class com.fasterxml.uuid.Generators: Factory method for constructing UUID generator that uses default (shared) random number generator for constructing UUIDs according to standard method number 4.
randomBasedGenerator(Random) - Static method in class com.fasterxml.uuid.Generators: Factory method for constructing UUID generator that uses specified random number generator for constructing UUIDs according to standard method number 4.
RandomBasedGenerator - Class in com.fasterxml.uuid.impl: Implementation of UUID generator that uses generation method 4.
RandomBasedGenerator(Random) - Constructor for class com.fasterxml.uuid.impl.RandomBasedGenerator
raw() - Method in enum com.fasterxml.uuid.UUIDType: Returns "raw" type constants, embedded within UUID bytes.

S

setUpdateInterval(long) - Method in class com.fasterxml.uuid.ext.FileBasedTimestampSynchronizer
slowDown(long, long) - Static method in class com.fasterxml.uuid.UUIDTimer: Simple utility method to use to wait for couple of milliseconds, to let system clock hopefully advance closer to the virtual timestamps used.
staticCompare(UUID, UUID) - Static method in class com.fasterxml.uuid.UUIDComparator: Static helper method that can be used instead of instantiating comparator (used by unit tests, can be used by code too)
StringArgGenerator - Class in com.fasterxml.uuid: Intermediate base class for UUID generators that take one String argument for individual calls.
StringArgGenerator() - Constructor for class com.fasterxml.uuid.StringArgGenerator

T

test - package test
test() - Method in class perf.MeasurePerformance
timeBasedGenerator() - Static method in class com.fasterxml.uuid.Generators: Factory method for constructing UUID generator that generates UUID using variant 1 (time+location based).
timeBasedGenerator(EthernetAddress) - Static method in class com.fasterxml.uuid.Generators: Factory method for constructing UUID generator that generates UUID using variant 1 (time+location based), using specified Ethernet address as the location part of UUID.
timeBasedGenerator(EthernetAddress, TimestampSynchronizer) - Static method in class com.fasterxml.uuid.Generators: Factory method for constructing UUID generator that generates UUID using variant 1 (time+location based), using specified Ethernet address as the location part of UUID, and specified synchronizer (which may add additional restrictions to guarantee system-wide uniqueness).
timeBasedGenerator(EthernetAddress, UUIDTimer) - Static method in class com.fasterxml.uuid.Generators: Factory method for constructing UUID generator that generates UUID using variant 1 (time+location based), using specified Ethernet address as the location part of UUID, and specified UUIDTimer instance (which includes embedded synchronizer that defines synchronization behavior).
TimeBasedGenerator - Class in com.fasterxml.uuid.impl: Implementation of UUID generator that uses time/location based generation method (variant 1).
TimeBasedGenerator(EthernetAddress, UUIDTimer) - Constructor for class com.fasterxml.uuid.impl.TimeBasedGenerator
TimestampSynchronizer - Class in com.fasterxml.uuid: This is the API for utility classes optionally used by UUIDTimer to ensure that timestamp values used for generating time/location-based UUIDs are monotonically increasing, as well as that only one such generator is ever used on a single system, even in presence of multiple JVMs.
TimestampSynchronizer() - Constructor for class com.fasterxml.uuid.TimestampSynchronizer
toByteArray() - Method in class com.fasterxml.uuid.EthernetAddress: Synonym to 'asByteArray()'
toByteArray(byte[]) - Method in class com.fasterxml.uuid.EthernetAddress
toByteArray(byte[], int) - Method in class com.fasterxml.uuid.EthernetAddress
toByteArray(UUID, byte[]) - Static method in class com.fasterxml.uuid.impl.UUIDUtil
toByteArray(UUID, byte[], int) - Static method in class com.fasterxml.uuid.impl.UUIDUtil
toLong() - Method in class com.fasterxml.uuid.EthernetAddress
toString() - Method in class com.fasterxml.uuid.EthernetAddress: Returns the canonical string representation of this ethernet address.
typeOf(UUID) - Static method in class com.fasterxml.uuid.impl.UUIDUtil: Method for determining which type of UUID given UUID is.
TYPES - Static variable in class com.fasterxml.uuid.Jug

U

update(long) - Method in class com.fasterxml.uuid.ext.FileBasedTimestampSynchronizer
update(long) - Method in class com.fasterxml.uuid.TimestampSynchronizer: Method called by UUIDTimer to indicate that it has generated a timestamp value that is beyond last legal timestamp value.
uuid(String) - Static method in class com.fasterxml.uuid.impl.UUIDUtil: Factory method for creating UUIDs from the canonical string representation.
uuid(byte[]) - Static method in class com.fasterxml.uuid.impl.UUIDUtil: Factory method for constructing UUID instance from given 16 bytes.
uuid(byte[], int) - Static method in class com.fasterxml.uuid.impl.UUIDUtil: Factory method for constructing UUID instance from given 16 bytes.
UUIDClock - Class in com.fasterxml.uuid: UUIDClock is used by UUIDTimer to get the current time.
UUIDClock() - Constructor for class com.fasterxml.uuid.UUIDClock
UUIDComparator - Class in com.fasterxml.uuid: Default UUID comparator is not very useful, since it just does blind byte-by-byte comparison which does not work well for time+location - based UUIDs.
UUIDComparator() - Constructor for class com.fasterxml.uuid.UUIDComparator
UUIDGenerator - Class in com.fasterxml.uuid: Minimal "tag" base class from which all generator implementations derive.
UUIDGenerator() - Constructor for class com.fasterxml.uuid.UUIDGenerator: Constructor is private to enforce singleton access.
UUIDTimer - Class in com.fasterxml.uuid: UUIDTimer produces the time stamps required for time-based UUIDs.
UUIDTimer(Random, TimestampSynchronizer) - Constructor for class com.fasterxml.uuid.UUIDTimer
UUIDTimer(Random, TimestampSynchronizer, UUIDClock) - Constructor for class com.fasterxml.uuid.UUIDTimer
UUIDType - Enum in com.fasterxml.uuid: Enumeration of different flavors of UUIDs: 5 specified by specs (RFC-4122) and one virtual entry ("UNKNOWN") to represent invalid one that consists of all zero bites
UUIDUtil - Class in com.fasterxml.uuid.impl
UUIDUtil() - Constructor for class com.fasterxml.uuid.impl.UUIDUtil

V

valueOf(byte[]) - Static method in class com.fasterxml.uuid.EthernetAddress: Constructs a new EthernetAddress given the byte array that contains binary representation of the address.
valueOf(int[]) - Static method in class com.fasterxml.uuid.EthernetAddress: Constructs a new EthernetAddress given the byte array that contains binary representation of the address.
valueOf(String) - Static method in class com.fasterxml.uuid.EthernetAddress: Constructs a new EthernetAddress given a string representation of the ethernet address.
valueOf(long) - Static method in class com.fasterxml.uuid.EthernetAddress: Constructs a new EthernetAddress given the long int value (64-bit) representation of the ethernet address (of which 48 LSB contain the definition) Note that calling this method returns the same result as would using the matching constructor.
valueOf(String) - Static method in enum com.fasterxml.uuid.UUIDType: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.fasterxml.uuid.UUIDType: Returns an array containing the constants of this enum type, in the order they are declared.

_

_address - Variable in class com.fasterxml.uuid.EthernetAddress: 48-bit MAC address, stored in 6 lowest-significant bytes (in big endian notation)
_clock - Variable in class com.fasterxml.uuid.UUIDTimer: Clock used to get the time when a timestamp is requested.
_digester - Variable in class com.fasterxml.uuid.impl.NameBasedGenerator: Message digesster to use for hash calculation
_ethernetAddress - Variable in class com.fasterxml.uuid.impl.TimeBasedGenerator
_namespace - Variable in class com.fasterxml.uuid.impl.NameBasedGenerator: Namespace to use as prefix.
_random - Variable in class com.fasterxml.uuid.impl.RandomBasedGenerator: Random number generator that this generator uses.
_random - Variable in class com.fasterxml.uuid.UUIDTimer: Random number generator used to generate additional information to further reduce probability of collisions.
_randomNumberGenerator() - Static method in class com.fasterxml.uuid.EthernetAddress: Helper method for accessing configured random number generator
_rnd - Static variable in class com.fasterxml.uuid.EthernetAddress: We may need a random number generator, for creating dummy ethernet address if no real interface is found.
_secureRandom - Variable in class com.fasterxml.uuid.impl.RandomBasedGenerator: Looks like SecureRandom implementation is more efficient using single call access (compared to basic Random), so let's use that knowledge to our benefit.
_sharedRandom - Static variable in class com.fasterxml.uuid.impl.RandomBasedGenerator: Default shared random number generator, used if no random number generator is explicitly specified for instance
_sharedTimer - Static variable in class com.fasterxml.uuid.Generators: If no explicit timer (and synchronizer it implicitly uses) is specified, we will create and use a single lazily-constructed timer, which uses in-JVM synchronization but no external file-based syncing.
_syncer - Variable in class com.fasterxml.uuid.UUIDTimer: Object used to reliably ensure that no multiple JVMs generate UUIDs, and also that the time stamp value used for generating time-based UUIDs is monotonically increasing even if system clock moves backwards over a reboot (usually due to some system level problem).
_timer - Variable in class com.fasterxml.uuid.impl.TimeBasedGenerator: Object used for synchronizing access to timestamps, to guarantee that timestamps produced by this generator are unique and monotonically increasings.
_type - Variable in class com.fasterxml.uuid.impl.NameBasedGenerator
_utf8 - Static variable in class com.fasterxml.uuid.impl.NameBasedGenerator
_uuidL2 - Variable in class com.fasterxml.uuid.impl.TimeBasedGenerator: Base values for the second long (last 8 bytes) of UUID to construct

A B C D E F G I J M N O P R S T U V _