jadex.platform.service.dht

Class ID

java.lang.Object

jadex.platform.service.dht.ID

All Implemented Interfaces:

jadex.bridge.service.types.dht.IID, java.lang.Comparable<jadex.bridge.service.types.dht.IID>

public class ID
extends java.lang.Object
implements jadex.bridge.service.types.dht.IID

This class is an identifier. It is used to represent hash values that are too big for primitive data types.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEBUG Debug field.
protected byte[]	id The byte array containing the id information.

Constructor Summary

Constructors

Constructor and Description
ID() Constructor.
ID(byte[] id) Constructor.

Method Summary

Modifier and Type	Method and Description
ID	addPowerOfTwo(int powerOfTwo) Adds 2^powerOfTwo to the value of this ID and returns the result as new ID.
int	compareTo(jadex.bridge.service.types.dht.IID otherKey) Compare this ID with another.
boolean	equals(java.lang.Object obj)
static jadex.bridge.service.types.dht.IID	get(jadex.bridge.IComponentIdentifier cid) Hashes the given CID and returns an ID containing the hash.
static jadex.bridge.service.types.dht.IID	get(java.lang.String str) Hashes the given string and returns an ID containing the hash.
byte[]	getBytes() Returns the bytes.
byte[]	getId() Returns the internal byte array.
int	getLength() Returns the length of this ID in bits.
int	hashCode()
boolean	isInInterval(jadex.bridge.service.types.dht.IID start, jadex.bridge.service.types.dht.IID end) Check whether this ID is in the given closed interval.
boolean	isInInterval(jadex.bridge.service.types.dht.IID start, jadex.bridge.service.types.dht.IID end, boolean leftOpen, boolean rightOpen) Check whether this ID is in the given interval.
void	setId(byte[] id) Sets the internal byte array.
ID	subtractPowerOfTwo(int powerOfTwo) Subtracts 2^powerOfTwo from the value of this ID and returns the result as new ID.
java.lang.String	toDecimalString(int numberOfBytes) Returns a string of the decimal representation of the first n bytes of this ID, including leading zeros.
java.lang.String	toHexString(int numberOfBytes) Returns a string of the hexadecimal representation of the first n bytes of this ID, including leading zeros.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEBUG

public static boolean DEBUG

Debug field. Setting this to true enables 8-bit hashes (0-255) for better readability.

id

protected byte[] id

The byte array containing the id information.

Constructor Detail

ID

public ID()

Constructor.

ID

public ID(byte[] id)

Constructor.

Method Detail

getId

public byte[] getId()

Returns the internal byte array.

setId

public void setId(byte[] id)

Sets the internal byte array.

Parameters:

id -

getBytes

public byte[] getBytes()

Returns the bytes.

Specified by:

getBytes in interface jadex.bridge.service.types.dht.IID

getLength

public int getLength()

Returns the length of this ID in bits.

Specified by:

getLength in interface jadex.bridge.service.types.dht.IID

Returns:

toDecimalString

public final java.lang.String toDecimalString(int numberOfBytes)

Returns a string of the decimal representation of the first n bytes of this ID, including leading zeros.

Parameters:

numberOfBytes -

Returns:

Hex string of ID

subtractPowerOfTwo

public ID subtractPowerOfTwo(int powerOfTwo)

Subtracts 2^powerOfTwo from the value of this ID and returns the result as new ID. Does not modify this instance.

Parameters:

powerOfTwo - exponent to be used for subtraction.

Returns:

the new ID which is 2^powerOfTwo lower than the current ID modulo the maximum ID.

addPowerOfTwo

public ID addPowerOfTwo(int powerOfTwo)

Adds 2^powerOfTwo to the value of this ID and returns the result as new ID. Does not modify this instance.

Specified by:

addPowerOfTwo in interface jadex.bridge.service.types.dht.IID

Parameters:

powerOfTwo - exponent to be used for subtraction.

Returns:

the new ID which is 2^powerOfTwo higher than the current ID modulo the maximum ID.

isInInterval

public boolean isInInterval(jadex.bridge.service.types.dht.IID start,
                            jadex.bridge.service.types.dht.IID end,
                            boolean leftOpen,
                            boolean rightOpen)

Check whether this ID is in the given interval.

Specified by:

isInInterval in interface jadex.bridge.service.types.dht.IID

Parameters:

start - Begin of interval.

end - End of interval.

leftOpen - If true, the start value is included in the interval.

rightOpen - If true, the end value is included in the interval.

Returns:

true, if this Id is inside the specified interval, else false.

isInInterval

public boolean isInInterval(jadex.bridge.service.types.dht.IID start,
                            jadex.bridge.service.types.dht.IID end)

Check whether this ID is in the given closed interval.

Specified by:

isInInterval in interface jadex.bridge.service.types.dht.IID

Parameters:

start - Begin of interval.

end - End of interval.

Returns:

true, if this Id is inside the specified interval, else false.

get

public static jadex.bridge.service.types.dht.IID get(jadex.bridge.IComponentIdentifier cid)

Hashes the given CID and returns an ID containing the hash.

Parameters:

cid - CID to hash.

Returns:

ID Resulting Id.

get

public static jadex.bridge.service.types.dht.IID get(java.lang.String str)

Hashes the given string and returns an ID containing the hash.

Parameters:

str - String to hash.

Returns:

ID Resulting Id.

compareTo

public final int compareTo(jadex.bridge.service.types.dht.IID otherKey)
                    throws java.lang.ClassCastException

Compare this ID with another. If type or length do not match, throw ClassCastException.

Specified by:

compareTo in interface java.lang.Comparable<jadex.bridge.service.types.dht.IID>

Returns:

-1 if this ID is smaller, 0 if equal, 1 if greater than the given ID.

Throws:

java.lang.ClassCastException

toHexString

public final java.lang.String toHexString(int numberOfBytes)

Returns a string of the hexadecimal representation of the first n bytes of this ID, including leading zeros.

Parameters:

numberOfBytes -

Returns:

Hex string of ID

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object