com.github.robtimus.validation.datetime.base

Class ZoneIdUtils

java.lang.Object

com.github.robtimus.validation.datetime.base.ZoneIdUtils

public final class ZoneIdUtils
extends Object

A utility class for ZoneIds.

Author:

Rob Spoor

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROVIDED_ZONE_ID A string representing the provided zone id.
static String	SYSTEM_ZONE_ID A string representing the system zone id.

Method Summary

Modifier and Type	Method and Description
static <A extends Annotation> Function<A,String>	nonProvidedZoneId(Function<A,String> zoneIdExtractor) Wraps a zone id extraction function so it will throw an IllegalStateException if the extracted zone id (as a text value) equals PROVIDED_ZONE_ID.
static <A extends Annotation> Function<A,String>	systemOnlyZoneId(Function<A,String> zoneIdExtractor) Wraps a zone id extraction function so it will throw an IllegalStateException if the extracted zone id (as a text value) does not equal SYSTEM_ZONE_ID.
static ZoneId	toZoneId(String text) Returns a ZoneId for a specific text value.

Methods inherited from class java.lang.Object

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

Field Detail

SYSTEM_ZONE_ID

public static final String SYSTEM_ZONE_ID

A string representing the system zone id.

See Also:

ZoneId.systemDefault(), Constant Field Values

PROVIDED_ZONE_ID

public static final String PROVIDED_ZONE_ID

A string representing the provided zone id.

See Also:

Constant Field Values

Method Detail

toZoneId

public static ZoneId toZoneId(String text)

Returns a ZoneId for a specific text value.

Parameters:

text - The text value for which to return a ZoneId.

Returns:

ZoneId.systemDefault() if the given text equals SYSTEM_ZONE_ID, null if the given text equals PROVIDED_ZONE_ID, or the result of calling ZoneId.of(String) otherwise.

Throws:

NullPointerException - If the given text value is null.

systemOnlyZoneId

public static <A extends Annotation> Function<A,String> systemOnlyZoneId(Function<A,String> zoneIdExtractor)

Wraps a zone id extraction function so it will throw an IllegalStateException if the extracted zone id (as a text value) does not equal SYSTEM_ZONE_ID. This can be used for validators of types that don't support zone information like LocalDate.

Type Parameters:

A - The constraint annotation type from which to extract the zone id.

Parameters:

zoneIdExtractor - A function that extracts the zone id from a constraint annotation.

Returns:

A function that extracts the zone id from a constraint annotation, but throws an IllegalStateException if the extracted zone id does not equal SYSTEM_ZONE_ID.

Throws:

NullPointerException - If the given function is null.

nonProvidedZoneId

public static <A extends Annotation> Function<A,String> nonProvidedZoneId(Function<A,String> zoneIdExtractor)

Wraps a zone id extraction function so it will throw an IllegalStateException if the extracted zone id (as a text value) equals PROVIDED_ZONE_ID. This can be used for validators of types that don't contain any zone information like Date or Instant.

Type Parameters:

A - The constraint annotation type from which to extract the zone id.

Parameters:

zoneIdExtractor - A function that extracts the zone id from a constraint annotation.

Returns:

A function that extracts the zone id from a constraint annotation, but throws an IllegalStateException if the extracted zone id equals PROVIDED_ZONE_ID.

Throws:

NullPointerException - If the given function is null.