org.protempa.proposition.value

Interface Unit

All Superinterfaces:

Comparable<Unit>, Serializable

All Known Implementing Classes:

AbsoluteTimeUnit, AbstractRelativeTimeUnit, AbstractTimeUnit, RelativeDayUnit, RelativeHourUnit

public interface Unit
extends Serializable, Comparable<Unit>

The units for a length. It extends Serializable so that it can be stored as part of Proposition s.

Author:

Andrew Post

Method Summary

Modifier and Type	Method and Description
long	addToPosition(long position, int length) Adds a length in these units to the given position.
String	getAbbreviatedName() Returns a short version of the unit's singular name.
Format	getLongFormat()
Format	getMediumFormat()
String	getName() Returns the unit's singular name.
String	getPluralName() Returns the unit's plural name.
Format	getShortFormat()

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getName

String getName()

Returns the unit's singular name.

Returns:

a String

getAbbreviatedName

String getAbbreviatedName()

Returns a short version of the unit's singular name.

Returns:

a String

getPluralName

String getPluralName()

Returns the unit's plural name.

Returns:

a String

getShortFormat

Format getShortFormat()

getMediumFormat

Format getMediumFormat()

getLongFormat

Format getLongFormat()

addToPosition

long addToPosition(long position,
                   int length)

Adds a length in these units to the given position.

Parameters:

position - a long

length - an int

Returns:

the new position long