bg.util.leto.base

Class LetoPeriodTypeBase

java.lang.Object

bg.util.leto.base.LetoPeriodTypeBase

All Implemented Interfaces:

LetoPeriodType

Direct Known Subclasses:

LetoPeriodTypeBean

public abstract class LetoPeriodTypeBase
extends java.lang.Object
implements LetoPeriodType

Constructor Summary

Constructors

Constructor and Description
LetoPeriodTypeBase()

Method Summary

Modifier and Type	Method and Description
abstract java.lang.String	getDescription(java.util.Locale locale) Longer human readable description of the period type.
abstract java.lang.String	getName(java.util.Locale locale) The name of the period type.
abstract LetoPeriodStructure[]	getPossibleStructures() Return the possible structures for this period type.

Methods inherited from class java.lang.Object

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

Methods inherited from interface bg.util.leto.api.LetoPeriodType

getDescription, getDescriptionTranslations, getName, getNameTranslations

Constructor Detail

LetoPeriodTypeBase

public LetoPeriodTypeBase()

Method Detail

getDescription

public abstract java.lang.String getDescription(java.util.Locale locale)

Description copied from interface: LetoPeriodType

Longer human readable description of the period type.

Specified by:

getDescription in interface LetoPeriodType

Parameters:

locale - The localization to be used.

Returns:

Longer human readable description of the given period type.

getName

public abstract java.lang.String getName(java.util.Locale locale)

Description copied from interface: LetoPeriodType

The name of the period type. For example: "day", "month", "year", "century" and so on...

Specified by:

getName in interface LetoPeriodType

Parameters:

locale - The localization to be used.

Returns:

The name of this period type.

getPossibleStructures

public abstract LetoPeriodStructure[] getPossibleStructures()

Description copied from interface: LetoPeriodType

Return the possible structures for this period type. Each possible structure is defined as an element of the array returned. Each possible structure contains the duration of the period in days as well as information about how much sub-periods it contains.
For example in Gregorian calendar, the month period type should return an array of 4 elements like this:

Number	Duration in days	Description
1-st	duration - 28 days	February in non leap year
2-nd	duration - 29 days	February in a leap year
3-rd	duration - 30 days	April, June, September, November
4-th	duration - 31 days	January, March, May, July, August, October, December

Specified by:

getPossibleStructures in interface LetoPeriodType

Returns:

An array containing all of the possible structures of this period type.