org.apache.flink.runtime

Class AbstractID

java.lang.Object

org.apache.flink.runtime.AbstractID

All Implemented Interfaces:

IOReadableWritable

Direct Known Subclasses:

AllocationID, ChannelID, ExecutionVertexID, GateID, InstanceID, JobID, JobVertexID, ManagementEdgeID, ManagementGateID, ManagementGroupVertexID, ManagementVertexID

public class AbstractID
extends Object
implements IOReadableWritable

A statistically unique identification number.

Field Summary

Fields

Modifier and Type	Field and Description
static int	SIZE The size of the ID in byte

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

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
protected static long	generateRandomLong() Generates a uniformly distributed random positive long.
int	hashCode()
void	read(DataInputView in)
void	setID(AbstractID src) Sets an ID from another ID by copying its internal byte representation.
String	toString()
void	write(ByteBuffer buffer)
void	write(DataOutputView out)
void	writeTo(io.netty.buffer.ByteBuf buf)

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

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

generateRandomLong

protected static long generateRandomLong()

Generates a uniformly distributed random positive long.

Returns:

a uniformly distributed random positive long

setID

public void setID(AbstractID src)

Sets an ID from another ID by copying its internal byte representation.

Parameters:

src - source ID

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

read

public void read(DataInputView in)
          throws IOException

Specified by:

read in interface IOReadableWritable

Throws:

IOException

write

public void write(DataOutputView out)
           throws IOException

Specified by:

write in interface IOReadableWritable

Throws:

IOException

write

public void write(ByteBuffer buffer)

writeTo

public void writeTo(io.netty.buffer.ByteBuf buf)

toString

public String toString()

Overrides:

toString in class Object