dk.heick.properties.types.custom

Class SequenceVO

java.lang.Object

dk.heick.properties.types.custom.SequenceVO

All Implemented Interfaces:

Serializable

public class SequenceVO
extends Object
implements Serializable

A sequence of increment value. Where the value is stored in memory but saved via the PropertyIO every n'th increment.

Author:

Frederik Heick

See Also:

SequencePropertyType, Serialized Form

Constructor Summary

Constructors

Constructor and Description
SequenceVO(String propertyName, SequencePropertyType propertyType, long storedValue, long increments) Constructor of the sequence

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
long	getCurrentValue() Get current sequence value.
long	getIncrements() The increment value which determines how often the value is stored in the PropertyIO when getting the next key.
long	getNextKey() Gets the next value incremented by one.
String	getPropertyName() The name of the property.
long	getStoredValue() The last key save in the PropertyIO.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SequenceVO

public SequenceVO(String propertyName,
                  SequencePropertyType propertyType,
                  long storedValue,
                  long increments)

Constructor of the sequence

Parameters:

propertyName - the name of property, this is part of the constructor to provide callback functionality to the property type write the incremented.

propertyType - the propertyType , this is part of the constructor to provide callback functionality to the property type write the incremented.

storedValue - the last stored property value.

increments - after how many increments the value shall be written to the PropertyIO.

Method Detail

getNextKey

public long getNextKey()
                throws PropertyException

Gets the next value incremented by one. When the value is incremented n'th time the value is written to the PropertyIO. The value stored in the Property is the current value + increments.

Returns:

the next key incremented by one.

Throws:

PropertyException - if fail to write the incremented value.

getStoredValue

public long getStoredValue()

The last key save in the PropertyIO.

Returns:

the last property value.

getPropertyName

public String getPropertyName()

The name of the property.

Returns:

the property name.

getIncrements

public long getIncrements()

The increment value which determines how often the value is stored in the PropertyIO when getting the next key.

Returns:

the increment value.

getCurrentValue

public long getCurrentValue()

Get current sequence value.

Returns:

the current value.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object