Package com.atlassian.bamboo.core

Class BambooEntityOid

java.lang.Object

com.atlassian.bamboo.core.BambooEntityOid

All Implemented Interfaces:

WhitelistedSerializable, Serializable

@Immutable
public final class BambooEntityOid
extends Object
implements WhitelistedSerializable

Unique identifier assigned to Bamboo entities. Information encoded into OID include Bamboo server unique key and entity type, as well as this entity's unique number.

See Also:

BootstrapManager.getServerKey(), BambooEntityType, Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static int	SERVER_BITS_MASK
static int	SERVER_BITS_NUMBER

Method Summary

Modifier and Type	Method	Description
static BambooEntityOid	create(int serverKey, @NotNull BambooEntityType type, long entityOid)	Create a new OID object instance based on server key, entity type and entity oid (unique within the server, within entity type).
static BambooEntityOid	create(long oid)	Create a new OID object instance from it's serialized representation.
static BambooEntityOid	createFromExternalValue(String externalValue)
boolean	equals(Object o)
long	getEntityOid()	Return unique entity OID from this OID object.
@NotNull BambooEntityType	getEntityType()	Return entity type represented by this OID.
int	getServerKey()	Return server key represented by this OID.
long	getValue()	Returns the serialized representation of this OID object.
int	hashCode()
static @NotNull BambooEntityOid	maxOidOfType(int serverKey, @NotNull BambooEntityType type)	Obtain maximal allowed entity OID for the given server key and entity type.
static @NotNull BambooEntityOid	minOidOfType(int serverKey, @NotNull BambooEntityType type)	Obtain minimal allowed entity OID for the given server key and entity type.
String	toExternalValue()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

SERVER_BITS_NUMBER

public static final int SERVER_BITS_NUMBER

See Also:

Constant Field Values

SERVER_BITS_MASK

public static final int SERVER_BITS_MASK

Method Detail

create

public static BambooEntityOid create(long oid)

Create a new OID object instance from it's serialized representation.

Parameters:

oid - serialized OID

Throws:

IllegalArgumentException - if the OID is invalid

create

public static BambooEntityOid create(int serverKey,
                                     @NotNull
                                     @NotNull BambooEntityType type,
                                     long entityOid)

Create a new OID object instance based on server key, entity type and entity oid (unique within the server, within entity type).

Parameters:

serverKey - server key

type - entity type

entityOid - OID of this entity within the server and the type

Throws:

IllegalArgumentException - if the server key or entity OID are invalid

createFromExternalValue

public static BambooEntityOid createFromExternalValue(String externalValue)

minOidOfType

@NotNull
public static @NotNull BambooEntityOid minOidOfType(int serverKey,
                                                    @NotNull
                                                    @NotNull BambooEntityType type)

Obtain minimal allowed entity OID for the given server key and entity type.

maxOidOfType

@NotNull
public static @NotNull BambooEntityOid maxOidOfType(int serverKey,
                                                    @NotNull
                                                    @NotNull BambooEntityType type)

Obtain maximal allowed entity OID for the given server key and entity type.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

toExternalValue

public String toExternalValue()

getServerKey

public int getServerKey()

Return server key represented by this OID.

getEntityType

@NotNull
public @NotNull BambooEntityType getEntityType()

Return entity type represented by this OID.

getEntityOid

public long getEntityOid()

Return unique entity OID from this OID object. The returned value is unique within the server, within entity type.

See Also:

getServerKey(), getEntityType()

getValue

public long getValue()

Returns the serialized representation of this OID object.