org.apache.flink.util

Class AbstractID

java.lang.Object

org.apache.flink.util.AbstractID

All Implemented Interfaces:

Serializable, Comparable<AbstractID>, IOReadableWritable

Direct Known Subclasses:

JobID

@PublicEvolving
public class AbstractID
extends Object
implements IOReadableWritable, Comparable<AbstractID>, Serializable

A statistically unique identification number.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected long	lowerPart The lower part of the actual ID
static int	SIZE The size of the ID in byte
protected long	upperPart The upper part of the actual ID

Constructor Summary

Constructors

Constructor and Description
AbstractID() Constructs a new random ID from a uniform distribution.
AbstractID(AbstractID id) Creates a new abstract ID from the given one.
AbstractID(byte[] bytes) Constructs a new ID with a specific bytes value.
AbstractID(long lowerPart, long upperPart) Constructs a new abstract ID.

Method Summary

Modifier and Type	Method and Description
int	compareTo(AbstractID o)
boolean	equals(Object obj)
byte[]	getBytes() Gets the bytes underlying this ID.
long	getLowerPart() Gets the lower 64 bits of the ID.
long	getUpperPart() Gets the upper 64 bits of the ID.
int	hashCode()
void	read(DataInputView in) Reads the object's internal data from the given data input view.
String	toString()
void	write(DataOutputView out) Writes the object's internal data to the given data output view.

Methods inherited from class java.lang.Object

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

Field Detail

SIZE

public static final int SIZE

The size of the ID in byte

See Also:

Constant Field Values

upperPart

protected long upperPart

The upper part of the actual ID

lowerPart

protected long lowerPart

The lower part of the actual ID

Constructor Detail

AbstractID

public AbstractID(byte[] bytes)

Constructs a new ID with a specific bytes value.

AbstractID

public AbstractID(long lowerPart,
                  long upperPart)

Constructs a new abstract ID.

Parameters:

lowerPart - the lower bytes of the ID

upperPart - the higher bytes of the ID

AbstractID

public AbstractID(AbstractID id)

Creates a new abstract ID from the given one.

The given and the newly created abstract ID will be identical, i.e. a comparison by equals will return true and both objects will have the same hash code.

Parameters:

id - the abstract ID to copy

AbstractID

public AbstractID()

Constructs a new random ID from a uniform distribution.

Method Detail

getLowerPart

public long getLowerPart()

Gets the lower 64 bits of the ID.

Returns:

The lower 64 bits of the ID.

getUpperPart

public long getUpperPart()

Gets the upper 64 bits of the ID.

Returns:

The upper 64 bits of the ID.

getBytes

public byte[] getBytes()

Gets the bytes underlying this ID.

Returns:

The bytes underlying this ID.

read

public void read(DataInputView in)
          throws IOException

Description copied from interface: IOReadableWritable

Reads the object's internal data from the given data input view.

Specified by:

read in interface IOReadableWritable

Parameters:

in - the input view to read the data from

Throws:

IOException - thrown if any error occurs while reading from the input stream

write

public void write(DataOutputView out)
           throws IOException

Description copied from interface: IOReadableWritable

Writes the object's internal data to the given data output view.

Specified by:

write in interface IOReadableWritable

Parameters:

out - the output view to receive the data.

Throws:

IOException - thrown if any error occurs while writing to the output stream

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

compareTo

public int compareTo(AbstractID o)

Specified by:

compareTo in interface Comparable<AbstractID>