org.radix.common.ID

Class AID

java.lang.Object

org.radix.common.ID.AID

public final class AID
extends java.lang.Object

An Atom ID, made up of 192 bits of truncated hash and 64 bits of a selected shard. The Atom ID is used so that Atoms can be located using just their hid.

Field Summary

Fields

Modifier and Type	Field and Description
static int	BYTES
static AID	ZERO

Method Summary

Modifier and Type	Method and Description
void	copyTo(byte[] array, int offset) Copies this AID to a byte array with some offset.
boolean	equals(java.lang.Object o)
static AID	from(byte[] bytes) Create an AID from its bytes
static AID	from(byte[] bytes, int offset) Create an AID from a portion of a byte array
static AID	from(RadixHash hash, java.util.Set<java.lang.Long> shards) Create an AID from a hash and a set of shards The AID will contain 192 first bits of shard + 64 bits of selected shard
static AID	from(java.lang.String hexBytes) Create an AID from its hex bytes
byte[]	getBytes() Gets the underlying bytes of this AID.
long	getLow() Gets the lowest 4 bytes of this AID as a long.
long	getShard() Gets the shard encoded in this AID.
int	hashCode()
boolean	isZero() Checks whether this AID is zero.
static java.util.Comparator<AID>	lexicalComparator() Get a lexical comparator for this type.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

BYTES

public static final int BYTES

See Also:

Constant Field Values

ZERO

public static final AID ZERO

Method Detail

getLow

public long getLow()

Gets the lowest 4 bytes of this AID as a long.

getShard

public long getShard()

Gets the shard encoded in this AID.

isZero

public boolean isZero()

Checks whether this AID is zero.

copyTo

public void copyTo(byte[] array,
                   int offset)

Copies this AID to a byte array with some offset. Note that the array must fit the offset + AID.BYTES.

Parameters:

array - The array

offset - The offset into that array

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getBytes

public byte[] getBytes()

Gets the underlying bytes of this AID. Note that this is NOT a copy and is the actual underlying byte array.

from

public static AID from(RadixHash hash,
                       java.util.Set<java.lang.Long> shards)

Create an AID from a hash and a set of shards The AID will contain 192 first bits of shard + 64 bits of selected shard

Parameters:

hash - The hash

shards - The shards

Returns:

The AID

from

public static AID from(byte[] bytes)

Create an AID from its bytes

Parameters:

bytes - The bytes (must be of length AID.BYTES)

Returns:

An AID with those bytes

from

public static AID from(byte[] bytes,
                       int offset)

Create an AID from a portion of a byte array

Parameters:

bytes - The bytes (must be of length AID.BYTES)

offset - The offset into the bytes array

Returns:

An AID with those bytes

from

public static AID from(java.lang.String hexBytes)

Create an AID from its hex bytes

Parameters:

hexBytes - The bytes in hex (must be of length AID.BYTES * 2)

Returns:

An AID with those bytes

lexicalComparator

public static java.util.Comparator<AID> lexicalComparator()

Get a lexical comparator for this type.