VersionedIdentifier (Dirmi 1.1.4 API)

java.lang.Object
- org.cojen.dirmi.core.VersionedIdentifier

All Implemented Interfaces:

Serializable, Comparable<org.cojen.dirmi.core.AbstractIdentifier>
```
public class VersionedIdentifier
extends Object
```
Identifier which also tracks version numbers for local and remote endpoints. Version numbers are used to detect race conditions during distributed garbage collection.

Author:

Brian S O'Neill

See Also:

Serialized Form

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(org.cojen.dirmi.core.AbstractIdentifier id)` Lexicographically compares two identifiers.
`boolean`	`equals(Object obj)`
`int`	`hashCode()`
`static VersionedIdentifier`	`identify(Object obj)` Returns a new or existing unique identifier for the given object.
`int`	`localVersion()` Returns the current local version number.
`int`	`nextLocalVersion()` Atomically increments local version number and returns the new value.
`static VersionedIdentifier`	`read(DataInput in)` Returns a deserialized identifier, which may or may not have an object registered with it.
`static VersionedIdentifier`	`read(InputStream in)` Returns a deserialized identifier, which may or may not have an object registered with it.
`static VersionedIdentifier`	`readAndUpdateRemoteVersion(DataInput in)` Returns a deserialized identifier, and also updates the remote version.
`<T> void`	`register(T obj)` Register the given object with this identifier.
`int`	`remoteVersion()` Returns the current remote version number.
`String`	`toString()`
`Object`	`tryRetrieve()` Returns the identified object, if it exists locally.
`boolean`	`updateRemoteVersion(int value)` Atomically updates the remote version number only if the given value is greater than the current remote version.
`void`	`write(DataOutput out)`
`void`	`write(OutputStream out)`
`void`	`writeWithNextVersion(DataOutput out)` Writes the identifier and also writes the next local version number.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - identify
```
public static VersionedIdentifier identify(Object obj)
```
    Returns a new or existing unique identifier for the given object. If new, the given object is automatically registered with the identifier.
    
    Throws:
    
    IllegalArgumentException - if object is null
  - read
```
public static VersionedIdentifier read(DataInput in)
                                throws IOException
```
    Returns a deserialized identifier, which may or may not have an object registered with it.
    
    Throws:
    
    IOException
  - read
```
public static VersionedIdentifier read(InputStream in)
                                throws IOException
```
    Returns a deserialized identifier, which may or may not have an object registered with it.
    
    Throws:
    
    IOException
  - readAndUpdateRemoteVersion
```
public static VersionedIdentifier readAndUpdateRemoteVersion(DataInput in)
                                                      throws IOException
```
    Returns a deserialized identifier, and also updates the remote version. This convenience method is appropriate only if the identifier will not be used to lookup a DGC managed resource. Otherwise, the remote version should be updated after the lookup.
    
    Throws:
    
    IOException
  - writeWithNextVersion
```
public void writeWithNextVersion(DataOutput out)
                          throws IOException
```
    Writes the identifier and also writes the next local version number.
    
    Throws:
    
    IOException
  - localVersion
```
public int localVersion()
```
    Returns the current local version number.
  - nextLocalVersion
```
public int nextLocalVersion()
```
    Atomically increments local version number and returns the new value.
  - remoteVersion
```
public int remoteVersion()
```
    Returns the current remote version number.
  - updateRemoteVersion
```
public boolean updateRemoteVersion(int value)
```
    Atomically updates the remote version number only if the given value is greater than the current remote version.
    
    Returns:
    
    true if version was updated
  - tryRetrieve
```
public Object tryRetrieve()
```
    Returns the identified object, if it exists locally.
    
    Returns:
    
    identified object, or null if it doesn't exist locally.
  - register
```
public <T> void register(T obj)
                  throws IllegalArgumentException
```
    Register the given object with this identifier. Registered objects are not strongly referenced, and so they may be garbage collected unless referenced elsewhere. Many objects can be registered with an identifier.
    A registered object cannot be retrieved, but calling identify against a registered object returns the original identifier object.
    
    Throws:
    
    IllegalArgumentException - if given object is null
  - write
```
public void write(DataOutput out)
           throws IOException
```
    Throws:
    
    IOException
  - write
```
public void write(OutputStream out)
           throws IOException
```
    Throws:
    
    IOException
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - compareTo
```
public int compareTo(org.cojen.dirmi.core.AbstractIdentifier id)
```
    Lexicographically compares two identifiers.
    
    Specified by:
    
    compareTo in interface Comparable<org.cojen.dirmi.core.AbstractIdentifier>

Class VersionedIdentifier

Method Summary

Methods inherited from class java.lang.Object

Method Detail

identify

read

read

readAndUpdateRemoteVersion

writeWithNextVersion

localVersion

nextLocalVersion

remoteVersion

updateRemoteVersion

tryRetrieve

register

write

write

hashCode

equals

toString

compareTo