equip.data
Class Lease

java.lang.Object
  equip.runtime.Object
      equip.runtime.ValueBase
          equip.data.Lease

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

LeaseImpl

public abstract class Lease

extends ValueBase

A Lease, c.f.\ Jini (IDL'd in eqDataType.idl). A time-limited guarantee/request. Base class - assumes synchronized clocks.

Field Summary

Time	expireTime time at which lease expires.

Constructor Summary

Lease()
Default no-arg constructor

Method Summary

boolean	_equals_helper(Lease c) Internal IDL-generated equality test helper
boolean	_matches_helper(Lease c) Internal IDL-generated match test helper
boolean	equals(java.lang.Object c) Standard IDL-generated equality test.
abstract boolean	expired(Time now) has the lease expired?
java.lang.String	getModuleName() IDL-generated helper routine to get module name (currently unimplemented).
abstract void	initFromTimeToLive(int timeToLive) initialise relative to current time.
boolean	matches(java.lang.Object c) Standard IDL-generated template match test.
void	readObject(ObjectInputStream in) Internal IDL-generated serialisation helper.
void	writeObject(ObjectOutputStream out) Internal IDL-generated serialisation helper.

Methods inherited from class equip.runtime.ValueBase

_equals_helper, _matches_helper, clone

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

expireTime

public Time expireTime

time at which lease expires.

Constructor Detail

Lease

public Lease()

Default no-arg constructor

Method Detail

initFromTimeToLive

public abstract void initFromTimeToLive(int timeToLive)

initialise relative to current time.

Parameters:

timeToLive - time of lease, in seconds, from the current time

expired

public abstract boolean expired(Time now)

has the lease expired?

Parameters:

now - The time against which the lease is to be checked.

Returns:

true if the lease has expired.

getModuleName

public java.lang.String getModuleName()

IDL-generated helper routine to get module name (currently unimplemented).

Overrides:

getModuleName in class Object

Returns:

name of this class's module

equals

public boolean equals(java.lang.Object c)

Standard IDL-generated equality test.

Overrides:

equals in class ValueBase

Parameters:

c - The object to be compared against this.

Returns:

true if this is equal to c

_equals_helper

public boolean _equals_helper(Lease c)

Internal IDL-generated equality test helper

matches

public boolean matches(java.lang.Object c)

Standard IDL-generated template match test.

Overrides:

matches in class ValueBase

Parameters:

c - The object to be checked against this template.

Returns:

true if this (as a template) matches the argument

_matches_helper

public boolean _matches_helper(Lease c)

Internal IDL-generated match test helper

writeObject

public void writeObject(ObjectOutputStream out)
                 throws java.io.IOException

Internal IDL-generated serialisation helper. Used by ObjectInputStream and ObjectOutputStream only.

Overrides:

writeObject in class ValueBase

Throws:

java.io.IOException

readObject

public void readObject(ObjectInputStream in)
                throws java.io.IOException,
                       java.lang.ClassNotFoundException,
                       java.lang.InstantiationException

Internal IDL-generated serialisation helper. Used by ObjectInputStream and ObjectOutputStream only.

Overrides:

readObject in class ValueBase

Throws:

java.io.IOException

java.lang.ClassNotFoundException

java.lang.InstantiationException