org.jgroups.util

Class ExtendedUUID

java.lang.Object

org.jgroups.util.UUID

org.jgroups.util.ExtendedUUID

All Implemented Interfaces:

Externalizable, Serializable, Comparable<Address>, Address, Streamable

Direct Known Subclasses:

AdditionalDataUUID, CanBeSiteMaster, PayloadUUID, SiteUUID, TopologyUUID

public class ExtendedUUID
extends UUID

Subclass of UUID accommodating additional data such as a flag and a small hashmap. There may be many instances in memory, and as they are serialized a lot and sent across the wire, I tried to make this as compact as possible. As a consequence, the hashmap can have a max size of 255 and a value can have a max length of 255 bytes.

Since:

3.5

Author:

Bela Ban

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static short	can_become_site_master
protected short	flags
protected byte[][]	keys
static short	site_master
protected byte[][]	values

Fields inherited from class org.jgroups.util.UUID

cache, leastSigBits, mostSigBits, numberGenerator, print_function, print_uuids, SIZE

Fields inherited from interface org.jgroups.Address

IP_ADDR, NULL, SITE_MASTER, SITE_UUID, UUID_ADDR

Constructor Summary

Constructors

Modifier	Constructor and Description
	ExtendedUUID()
protected	ExtendedUUID(byte[] data)
	ExtendedUUID(ExtendedUUID other)
	ExtendedUUID(long mostSigBits, long leastSigBits)

Method Summary

Modifier and Type	Method and Description
ExtendedUUID	addContents(ExtendedUUID other)
ExtendedUUID	clearFlag(short flag)
protected String	flagsToString()
byte[]	get(byte[] key)
byte[]	get(String key)
boolean	isFlagSet(short flag)
boolean	keyExists(byte[] key)
boolean	keyExists(String key)
int	length() The number of non-null keys
String	print()
ExtendedUUID	put(byte[] key, byte[] val)
protected ExtendedUUID	put(int start_index, byte[] key, byte[] val)
ExtendedUUID	put(String key, byte[] val)
static ExtendedUUID	randomUUID()
static ExtendedUUID	randomUUID(String name)
protected void	read(DataInput in)
void	readExternal(ObjectInput in)
void	readFrom(DataInput in) Read the state of the current object (including superclasses) from instream Note that the input stream must not be closed
byte[]	remove(byte[] key)
byte[]	remove(String key)
protected void	resize(int new_length)
ExtendedUUID	setFlag(short flag)
int	size() The number of bytes required to serialize this instance
protected int	sizeofHashMap()
String	toString()
protected void	write(DataOutput out)
void	writeExternal(ObjectOutput out)
void	writeTo(DataOutput out) Write the entire state of the current object (including superclasses) to outstream.

Methods inherited from class org.jgroups.util.UUID

add, add, compareTo, copy, digits, equals, fromString, generateRandomBytes, get, getByName, getContents, getLeastSignificantBits, getMostSignificantBits, hashCode, printCache, remove, removeAll, retainAll, toStringLong

Methods inherited from class java.lang.Object

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

Field Detail

flags

protected short flags

keys

protected byte[][] keys

values

protected byte[][] values

site_master

public static final short site_master

See Also:

Constant Field Values

can_become_site_master

public static final short can_become_site_master

See Also:

Constant Field Values

Constructor Detail

ExtendedUUID

public ExtendedUUID()

ExtendedUUID

protected ExtendedUUID(byte[] data)

ExtendedUUID

public ExtendedUUID(long mostSigBits,
                    long leastSigBits)

ExtendedUUID

public ExtendedUUID(ExtendedUUID other)

Method Detail

randomUUID

public static ExtendedUUID randomUUID()

randomUUID

public static ExtendedUUID randomUUID(String name)

setFlag

public ExtendedUUID setFlag(short flag)

clearFlag

public ExtendedUUID clearFlag(short flag)

isFlagSet

public boolean isFlagSet(short flag)

get

public byte[] get(byte[] key)

get

public byte[] get(String key)

put

public ExtendedUUID put(byte[] key,
                        byte[] val)

put

protected ExtendedUUID put(int start_index,
                           byte[] key,
                           byte[] val)

put

public ExtendedUUID put(String key,
                        byte[] val)

remove

public byte[] remove(byte[] key)

remove

public byte[] remove(String key)

keyExists

public boolean keyExists(byte[] key)

keyExists

public boolean keyExists(String key)

addContents

public ExtendedUUID addContents(ExtendedUUID other)

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Overrides:

writeExternal in class UUID

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class UUID

Throws:

IOException

ClassNotFoundException

writeTo

public void writeTo(DataOutput out)
             throws Exception

Description copied from interface: Streamable

Write the entire state of the current object (including superclasses) to outstream. Note that the output stream must not be closed

Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class UUID

Throws:

Exception

readFrom

public void readFrom(DataInput in)
              throws Exception

Description copied from interface: Streamable

Read the state of the current object (including superclasses) from instream Note that the input stream must not be closed

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class UUID

Throws:

Exception

size

public int size()

The number of bytes required to serialize this instance

Specified by:

size in interface Address

Overrides:

size in class UUID

length

public int length()

The number of non-null keys

toString

public String toString()

Overrides:

toString in class UUID

print

public String print()

write

protected void write(DataOutput out)
              throws IOException

Throws:

IOException

read

protected void read(DataInput in)
             throws IOException

Throws:

IOException

sizeofHashMap

protected int sizeofHashMap()

resize

protected void resize(int new_length)

flagsToString

protected String flagsToString()