Package be.vlaanderen.vip.magda.client.domain.dto

Class IncompleteDate

java.lang.Object

be.vlaanderen.vip.magda.client.domain.dto.IncompleteDate

public class IncompleteDate
extends Object

Information on a date of which some parts may not be given (for instance, a birthdate that is not exactly known).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	IncompleteDate.CompletenessType	The manner in which a date is incomplete.

Field Summary

Fields

Modifier and Type	Field	Description
static final Pattern	INCOMPLETE_DATE_PATTERN

Method Summary

Modifier and Type	Method	Description
IncompleteDate.CompletenessType	completenessType()	Provides information on which parts are and are not given.
int	dayOfMonth()	Get the information on the day of month part.
static IncompleteDate	fromString(String value)
int	month()	Get the information on the month part.
LocalDate	toLocalDate()
String	toTextualRepresentation()
int	year()	Get the information on the year part.

Methods inherited from class java.lang.Object

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

Field Details

INCOMPLETE_DATE_PATTERN

public static final Pattern INCOMPLETE_DATE_PATTERN

Method Details

fromString

public static IncompleteDate fromString(String value)

year

public int year()

Get the information on the year part.

Returns:

The year as an integer.

Throws:

IncompleteDateMissingPartException - if the year part is not given.

month

public int month()

Get the information on the month part.

Returns:

The month as an integer.

Throws:

IncompleteDateMissingPartException - if the month part is not given.

dayOfMonth

public int dayOfMonth()

Get the information on the day of month part.

Returns:

The day of month as an integer.

Throws:

IncompleteDateMissingPartException - if the day of month part is not given.

completenessType

public IncompleteDate.CompletenessType completenessType()

Provides information on which parts are and are not given. It's strongly recommended to branch on the completeness type prior to handling the incomplete date in any other way. Otherwise, IncompleteDateMissingPartExceptions cannot be ruled out.

toLocalDate

public LocalDate toLocalDate()
                      throws IncompleteDateMissingPartException

Returns:

The date information as a LocalDate.

Throws:

IncompleteDateMissingPartException - if the date information is not complete.

toTextualRepresentation

public String toTextualRepresentation()

Returns:

The date in textual representation yyyy-MM-dd