Module de.powerstat.validation

Package de.powerstat.validation.values

Class MonthDay

java.lang.Object

de.powerstat.validation.values.MonthDay

All Implemented Interfaces:

IValueObject, Comparable<MonthDay>

public final class MonthDay
extends Object
implements Comparable<MonthDay>, IValueObject

DayMonth. Not DSGVO relevant. TODO LeapYear support TODO min, max

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	DATE_SEP	Date separator.
private final Day	day	Day.
private final Month	month	Month.
private static final String	OVERFLOW	Overflow constant.
private static final String	UNDERFLOW	Underflow constant.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	MonthDay(Month month, Day day)	Constructor.

Method Summary

Modifier and Type	Method	Description
MonthDay	add(Months months)	Add months to this MonthDay.
int	compareTo(MonthDay obj)	Compare with another object.
Day	dayValue()	Returns the day value of this DayMonth.
MonthDay	decrementMonth()	Decrement this MonthDay by one month.
boolean	equals(Object obj)	Is equal with another object.
int	hashCode()	Calculate hash code.
MonthDay	incrementMonth()	Increment this MonthDay by one month.
Month	monthValue()	Returns the month value of this DayMonth.
static MonthDay	of(Month month, Day day)	DayMonth factory.
static MonthDay	of(String value)	DayMonth factory.
String	stringValue()	Returns the String value of this DayMonth in ISO8601 format.
MonthDay	subtract(Months months)	Subtract months from this MonthDay.
String	toString()	Returns the string representation of this DayMonth.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

OVERFLOW

private static final String OVERFLOW

Overflow constant.

See Also:

• Constant Field Values

UNDERFLOW

private static final String UNDERFLOW

Underflow constant.

See Also:

• Constant Field Values

DATE_SEP

private static final String DATE_SEP

Date separator.

See Also:

• Constant Field Values

month

private final Month month

Month.

day

private final Day day

Day.

Constructor Details

MonthDay

private MonthDay(Month month,
 Day day)

Constructor.

Parameters:

month - Month

day - Day

Throws:

NullPointerException - When month or day is null

IndexOutOfBoundsException - When the day is less than 1 or greater than 31 or the day is to large for the month.

IllegalStateException - When the month is in an illegal state

Method Details

of

public static MonthDay of(Month month,
 Day day)

DayMonth factory.

Parameters:

month - Month 1-12

day - Day 1-31

Returns:

DayMonth object

of

public static MonthDay of(String value)

DayMonth factory.

Parameters:

value - ISO8601 format [m]m-[d]d

Returns:

DayMonth object

monthValue

public Month monthValue()

Returns the month value of this DayMonth.

Returns:

The month value represented by this object.

dayValue

public Day dayValue()

Returns the day value of this DayMonth.

Returns:

The day value represented by this object.

stringValue

public String stringValue()

Returns the String value of this DayMonth in ISO8601 format.

Specified by:

stringValue in interface IValueObject

Returns:

The String value represented by this object ([m]m-[d]d).

hashCode

public int hashCode()

Calculate hash code.

Overrides:

hashCode in class Object

Returns:

Hash

See Also:

• Object.hashCode()

equals

public boolean equals(Object obj)

Is equal with another object.

Overrides:

equals in class Object

Parameters:

obj - Object

Returns:

true when equal, false otherwise

See Also:

• Object.equals(java.lang.Object)

toString

public String toString()

Returns the string representation of this DayMonth. The exact details of this representation are unspecified and subject to change, but the following may be regarded as typical: "DayMonth[month=1, day=1]"

Overrides:

toString in class Object

Returns:

String representation of this DayMonth

See Also:

• Object.toString()

compareTo

public int compareTo(MonthDay obj)

Compare with another object.

Specified by:

compareTo in interface Comparable<MonthDay>

Parameters:

obj - Object to compare with

Returns:

0: equal; 1: greater; -1: smaller

See Also:

• Comparable.compareTo(java.lang.Object)

add

public MonthDay add(Months months)

Add months to this MonthDay.

Parameters:

months - Months to add to this MonthDay

Returns:

New MonthDay after adding the months to this MonthDay

Throws:

ArithmeticException - In case of an overflow

subtract

public MonthDay subtract(Months months)

Subtract months from this MonthDay.

Parameters:

months - Months to subtract from this MonthDay

Returns:

New MonthDay after subtracting months from this MonthDay

Throws:

ArithmeticException - In case of an underflow

incrementMonth

public MonthDay incrementMonth()

Increment this MonthDay by one month.

Returns:

New MonthDay after incrementing this MonthDay by one month

Throws:

ArithmeticException - In case of an overflow

decrementMonth

public MonthDay decrementMonth()

Decrement this MonthDay by one month.

Returns:

New MonthDay after decrement this MonthDay by one month

Throws:

ArithmeticException - In case of an overflow