Package org.simpleframework.common.lease
Interface Contract<T>
- All Superinterfaces:
Comparable<Delayed>
,Delayed
- All Known Implementing Classes:
Expiration
A
Contract
is used to represent the contract a
lease has been issued. This contains all relevant information
regarding the lease, such as the keyed resource that has been
leased and the duration of the lease. Delays for the contract
can be measured in any TimeUnit
for convinienct.-
Method Summary
Modifier and TypeMethodDescriptionlong
This method will return the number ofTimeUnit
seconds that remain in the contract.getKey()
This returns the key for the resource this represents.void
This method is used to set the number ofTimeUnit
seconds that should remain within the contract.toString()
This is used to provide a description of the contract that the instance represents.Methods inherited from interface java.lang.Comparable
compareTo
-
Method Details
-
getKey
T getKey()This returns the key for the resource this represents. This is used when the contract has expired to clean resources associated with the lease. It is passed in to the cleaner as an parameter to the callback. The cleaner is then responsible for cleaning any resources associated with the lease.- Returns:
- returns the resource key that this represents
-
getDelay
This method will return the number ofTimeUnit
seconds that remain in the contract. If the value returned is less than or equal to zero then it should be assumed that the lease has expired, if greater than zero the lease is active. -
setDelay
This method is used to set the number ofTimeUnit
seconds that should remain within the contract. This is used when the contract is to be reissued. Once a new duration has been set the contract for the lease has been changed and the previous expiry time is ignores, so only one clean is called.- Parameters:
delay
- this is the delay to be used for this contractunit
- this is the time unit measurment for the delay
-
toString
String toString()This is used to provide a description of the contract that the instance represents. A description well contain the key owned by the contract as well as the expiry time expected for it. This is used to provide descriptive messages in the exceptions.
-