UID (Java Platform SE 6) (original) (raw)

java.rmi.server

Class UID

java.lang.Object java.rmi.server.UID

All Implemented Interfaces:

Serializable

public final class UID

extends Object

implements Serializable

A UID represents an identifier that is unique over time with respect to the host it is generated on, or one of 216 "well-known" identifiers.

The UID() constructor can be used to generate an identifier that is unique over time with respect to the host it is generated on. The UID(short) constructor can be used to create one of 216 well-known identifiers.

A UID instance contains three primitive values:

• unique, an int that uniquely identifies the VM that this UID was generated in, with respect to its host and at the time represented by the time value (an example implementation of the unique value would be a process identifier), or zero for a well-known UID
• time, a long equal to a time (as returned by System.currentTimeMillis()) at which the VM that thisUID was generated in was alive, or zero for a well-known UID
• count, a short to distinguishUIDs generated in the same VM with the sametime value

An independently generated UID instance is unique over time with respect to the host it is generated on as long as the host requires more than one millisecond to reboot and its system clock is never set backward. A globally unique identifier can be constructed by pairing a UID instance with a unique host identifier, such as an IP address.

Since:

JDK1.1

See Also:

Serialized Form

UID

public UID()

Generates a UID that is unique over time with respect to the host that it was generated on.

UID

public UID(short num)

Creates a "well-known" UID. There are 216 possible such well-known ids.

A UID created via this constructor will not clash with any UIDs generated via the no-arg constructor.

Parameters:

num - number for well-known UID

hashCode

public int hashCode()

Returns the hash code value for this UID.

Overrides:

[hashCode](../../../java/lang/Object.html#hashCode%28%29) in class [Object](../../../java/lang/Object.html "class in java.lang")

Returns:

the hash code value for this UID

See Also:

Object.equals(java.lang.Object), Hashtable

equals

public boolean equals(Object obj)

Compares the specified object with this UID for equality. This method returns true if and only if the specified object is a UID instance with the sameunique, time, and count values as this one.

Overrides:

[equals](../../../java/lang/Object.html#equals%28java.lang.Object%29) in class [Object](../../../java/lang/Object.html "class in java.lang")

Parameters:

obj - the object to compare this UID to

Returns:

true if the given object is equivalent to this one, and false otherwise

See Also:

Object.hashCode(), Hashtable

toString

public String toString()

Returns a string representation of this UID.

Overrides:

[toString](../../../java/lang/Object.html#toString%28%29) in class [Object](../../../java/lang/Object.html "class in java.lang")

Returns:

a string representation of this UID

write

public void write(DataOutput out) throws IOException

Marshals a binary representation of this UID to a DataOutput instance.

Specifically, this method first invokes the given stream'sDataOutput.writeInt(int) method with this UID'sunique value, then it invokes the stream'sDataOutput.writeLong(long) method with this UID'stime value, and then it invokes the stream'sDataOutput.writeShort(int) method with this UID'scount value.

Parameters:

out - the DataOutput instance to write this UID to

Throws:

[IOException](../../../java/io/IOException.html "class in java.io") - if an I/O error occurs while performing this operation

read

public static UID read(DataInput in) throws IOException

Constructs and returns a new UID instance by unmarshalling a binary representation from anDataInput instance.

Specifically, this method first invokes the given stream'sDataInput.readInt() method to read a unique value, then it invoke's the stream'sDataInput.readLong() method to read a time value, then it invoke's the stream'sDataInput.readShort() method to read a count value, and then it creates and returns a new UID instance that contains the unique, time, andcount values that were read from the stream.

Parameters:

in - the DataInput instance to readUID from

Returns:

unmarshalled UID instance

Throws:

[IOException](../../../java/io/IOException.html "class in java.io") - if an I/O error occurs while performing this operation

Submit a bug or feature
For further API reference and developer documentation, see Java SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Copyright © 1993, 2015, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.

Scripting on this page tracks web page traffic, but does not change the content in any way.