info.pppc.base.lease

Class Lease

java.lang.Object

info.pppc.base.lease.Lease

All Implemented Interfaces:

ISerializable

public final class Lease
extends java.lang.Object
implements ISerializable

The lease is used by the lease registry to maintain listeners and to perform remote and local signaling. Users can pass the lease to remote systems to register remote listeners that listen to changes of a locally created lease. Users should never cerate a lease using the constructor instead they should create the lease through the lease registry. A lease created through the default constructor of this class will lead to failures.

Author:

Mac

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ABBREVIATION The abbreviation used for this class during serialization.

Constructor Summary

Constructors

Constructor and Description
Lease() Creates a new uninitialized lease.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o) Determines whether this lease is structurally equivalent to the specified object.
SystemID	getCreator() Returns the creator system of the lease.
ObjectID	getIdentifier() Returns the identifier of the lease.
long	getTimeout() Returns the timeout period of the lease.
int	hashCode() Returns a content-based hashcode for the lease.
void	readObject(IObjectInput input) Deserializes the lease from the given input.
java.lang.String	toString() Returns a human readable string representation of the lease.
void	writeObject(IObjectOutput output) Serializes the lease to the specified output.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

ABBREVIATION

public static final java.lang.String ABBREVIATION

The abbreviation used for this class during serialization.

See Also:

Constant Field Values

Constructor Detail

Lease

public Lease()

Creates a new uninitialized lease. This method is not intended to be called by user code. It solely for deserialization.

Method Detail

getIdentifier

public ObjectID getIdentifier()

Returns the identifier of the lease.

Returns:

The identifier of the lease.

getCreator

public SystemID getCreator()

Returns the creator system of the lease.

Returns:

The creator system of the lease.

getTimeout

public long getTimeout()

Returns the timeout period of the lease.

Returns:

The timeout period of the lease.

readObject

public void readObject(IObjectInput input)
                throws java.io.IOException

Deserializes the lease from the given input.

Specified by:

readObject in interface ISerializable

Parameters:

input - The input to read from.

Throws:

java.io.IOException - Thrown by the underlying input.

writeObject

public void writeObject(IObjectOutput output)
                 throws java.io.IOException

Serializes the lease to the specified output.

Specified by:

writeObject in interface ISerializable

Parameters:

output - The output to write to.

Throws:

java.io.IOException - Thrown by the underlying output.

equals

public boolean equals(java.lang.Object o)

Determines whether this lease is structurally equivalent to the specified object.

Overrides:

equals in class java.lang.Object

Parameters:

o - The object to compare to.

Returns:

True if the lease equals the specified object, false otherwise.

hashCode

public int hashCode()

Returns a content-based hashcode for the lease.

Overrides:

hashCode in class java.lang.Object

Returns:

A content-based hashcoode.

toString

public java.lang.String toString()

Returns a human readable string representation of the lease.

Overrides:

toString in class java.lang.Object

Returns:

A human readable string representation.