de.ipcon.tools

Enum PeriodUnit

java.lang.Object

java.lang.Enum<PeriodUnit>

de.ipcon.tools.PeriodUnit

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<PeriodUnit>

public enum PeriodUnit
extends java.lang.Enum<PeriodUnit>

Represents a unit of time used for parsing periods.

This enum defines a mapping between single-character representations and their corresponding ChronoUnit. This simplified approach is designed for easier use, especially for non-programmers who may be involved in defining XML schemas for GDPR compliance, and avoids the complexities of the ISO-8601 duration format.

Examples:

• Instead of ISO-8601: P10Y, use: 10y
• Instead of ISO-8601: P5M, use: 5M
• Instead of ISO-8601: P2W, use: 2w
• Instead of ISO-8601: P1D, use: 1d

In addition to representing time units, this enum provides methods for:

• Retrieving the corresponding ChronoUnit for a given period unit.
• Obtaining a PeriodUnit from its character representation.
• Constructing a Period object from a period unit and a specified amount.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DAYS Represents days.
MONTHS Represents months.
WEEKS Represents weeks.
YEARS Represents years.

Method Summary

Modifier and Type	Method and Description
static PeriodUnit	fromUnitChar(char unitChar) Returns the PeriodUnit corresponding to the given unit character.
java.time.temporal.ChronoUnit	getChronoUnit() Returns the ChronoUnit associated with the period unit.
java.time.Period	toPeriod(int amount) Creates a Period object based on the period unit and the given amount.
static PeriodUnit	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static PeriodUnit[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

YEARS

public static final PeriodUnit YEARS

Represents years. Character representation: 'y' or 'Y'.

MONTHS

public static final PeriodUnit MONTHS

Represents months. Character representation: 'm' or 'M'.

WEEKS

public static final PeriodUnit WEEKS

Represents weeks. Character representation: 'w' or 'W'.

DAYS

public static final PeriodUnit DAYS

Represents days. Character representation: 'd' or 'D'.

Method Detail

values

public static PeriodUnit[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (PeriodUnit c : PeriodUnit.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static PeriodUnit valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getChronoUnit

public java.time.temporal.ChronoUnit getChronoUnit()

Returns the ChronoUnit associated with the period unit.

Returns:

the ChronoUnit associated with the period unit

fromUnitChar

public static PeriodUnit fromUnitChar(char unitChar)

Returns the PeriodUnit corresponding to the given unit character. The comparison is case-insensitive.

Parameters:

unitChar - the unit character

Returns:

the PeriodUnit corresponding to the given unit character

Throws:

java.lang.IllegalArgumentException - if the unit character is invalid

toPeriod

public java.time.Period toPeriod(int amount)

Creates a Period object based on the period unit and the given amount.

Parameters:

amount - the amount of time

Returns:

the created Period object

Throws:

java.lang.IllegalStateException - if the period unit is not supported for creating a Period