io.virtdata.basicsmappers.from_long.to_time_types

Class ToEpochTimeUUID

java.lang.Object

io.virtdata.basicsmappers.from_long.to_time_types.ToEpochTimeUUID

All Implemented Interfaces:

LongFunction<UUID>

public class ToEpochTimeUUID
extends Object
implements LongFunction<UUID>

Converts a long UTC timestamp in epoch millis form into a Version 1 TimeUUID according to RFC 4122. This means that only one unique value for a timeuuid can be generated for each epoch milli value, even though version 1 TimeUUIDs can normally represent up to 10000 distinct values per millisecond. If you need to access this level of resolution for testing purposes, use ToFinestTimeUUID instead. This method is to support simple mapping to natural timestamps as we often find in the real world.

For the variants that have a String argument in the constructor, this is a parsable datetime that is used as the base time for all produced values. Setting this allows you to set the start of the time range for all timeuuid values produced. All times are parsed for UTC. All time use ISO date ordering, meaning that the most significant fields always go before the others.

The valid formats, in joda specifier form are:

1. yyyy-MM-dd HH:mm:ss.SSSZ, for example: 2015-02-28 23:30:15.223
2. yyyy-MM-dd HH:mm:ss, for example 2015-02-28 23:30:15
3. yyyyMMdd'T'HHmmss.SSSZ, for example: 20150228T233015.223
4. yyyyMMdd'T'HHmmssZ, for example: 20150228T233015
5. yyyy-MM-dd, for example: 2015-02-28
6. yyyyMMdd, for example: 20150228
7. yyyyMM, for example: 201502
8. yyyy, for example: 2015

Constructor Summary

Constructors

Constructor and Description
ToEpochTimeUUID() Create version 1 timeuuids with a per-host node and empty clock data.
ToEpochTimeUUID(long node) Create version 1 timeuuids with a specific static node and empty clock data.
ToEpochTimeUUID(long node, long clock) Create version 1 timeuuids with a specific static node and specific clock data.
ToEpochTimeUUID(String baseSpec) Create version 1 timeuuids with a per-host node and empty clock data.
ToEpochTimeUUID(String baseSpec, long node) Create version 1 timeuuids with a specific static node and empty clock data.
ToEpochTimeUUID(String baseSpec, long node, long clock) Create version 1 timeuuids with a specific static node and specific clock data.

Method Summary

Modifier and Type	Method and Description
UUID	apply(long timeTicks)

Methods inherited from class java.lang.Object

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

Constructor Detail

ToEpochTimeUUID

public ToEpochTimeUUID()

Create version 1 timeuuids with a per-host node and empty clock data. The node and clock components are seeded from network interface data. In this case, the clock data is not seeded uniquely.

ToEpochTimeUUID

public ToEpochTimeUUID(long node)

Create version 1 timeuuids with a specific static node and empty clock data. This is useful for testing so that you can know that values are verifiable, even though in non-testing practice, you would rely on some form of entropy per-system to provide more practical dispersion of values over reboots, etc.

Parameters:

node - a fixture value for testing that replaces node and clock bits

ToEpochTimeUUID

public ToEpochTimeUUID(long node,
                       long clock)

Create version 1 timeuuids with a specific static node and specific clock data. This is useful for testing so that you can know that values are verifiable, even though in non-testing practice, you would rely on some form of entropy per-system to provide more practical dispersion of values over reboots, etc.

Parameters:

node - a fixture value for testing that replaces node bits

clock - a fixture value for testing that replaces clock bits

ToEpochTimeUUID

public ToEpochTimeUUID(String baseSpec)

Create version 1 timeuuids with a per-host node and empty clock data. The node and clock components are seeded from network interface data. In this case, the clock data is not seeded uniquely.

Parameters:

baseSpec - - a string specification for the base time value

ToEpochTimeUUID

public ToEpochTimeUUID(String baseSpec,
                       long node)

Create version 1 timeuuids with a specific static node and empty clock data. This is useful for testing so that you can know that values are verifiable, even though in non-testing practice, you would rely on some form of entropy per-system to provide more practical dispersion of values over reboots, etc.

Parameters:

baseSpec - - a string specification for the base time value

node - a fixture value for testing that replaces node and clock bits

ToEpochTimeUUID

public ToEpochTimeUUID(String baseSpec,
                       long node,
                       long clock)

Create version 1 timeuuids with a specific static node and specific clock data. This is useful for testing so that you can know that values are verifiable, even though in non-testing practice, you would rely on some form of entropy per-system to provide more practical dispersion of values over reboots, etc.

Parameters:

baseSpec - - a string specification for the base time value

node - a fixture value for testing that replaces node bits

clock - a fixture value for testing that replaces clock bits

Method Detail

apply

public UUID apply(long timeTicks)

Specified by:

apply in interface LongFunction<UUID>