net.sf.mmm.util.date.api

Class WeekdaySet

java.lang.Object

net.sf.mmm.util.lang.api.AbstractDatatype

net.sf.mmm.util.lang.api.AbstractSimpleDatatypeBase<V>

net.sf.mmm.util.lang.api.AbstractSimpleDatatype<Integer>

net.sf.mmm.util.date.api.WeekdaySet

All Implemented Interfaces:

Serializable, AttributeReadValue<Integer>, Datatype, SimpleDatatype<Integer>

public class WeekdaySet
extends AbstractSimpleDatatype<Integer>

This Datatype represents a set of Weekdays. It can represent any unordered combination from none to all.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static WeekdaySet	ALL An WeekdaySet containing all Weekdays.
static WeekdaySet	NONE An empty WeekdaySet containing no Weekday at all.
private static long	serialVersionUID
private Set<Weekday>	set
static WeekdaySet	WORKDAYS An WeekdaySet containing the working days (all but Weekday.SUNDAY and Weekday.SUNDAY).

Constructor Summary

Constructors

Constructor and Description
WeekdaySet(Integer bitmask) The constructor.
WeekdaySet(Set<Weekday> set) The constructor.
WeekdaySet(Weekday... weekdays) The constructor.

Method Summary

Modifier and Type	Method and Description
boolean	contains(Weekday weekday) This method determines if this WeekdaySet contains the given Weekday.
private static int	encode(Set<Weekday> set) This method encodes the given set to a bit-mask for getValue().
private static int	encode(Weekday... weekdays) This method encodes the given set to a bit-mask for getValue().
Weekday	getNextMatch(Weekday weekday) This method gets the next Weekday contained in this WeekdaySet starting with the given weekday.
Set<Weekday>	getSet() This method gets an unmodifiable Set representing this WeekdaySet.
Integer	getValue() This method returns the WeekdaySet as compressed mask of seven bits.
WeekdaySet	invert() This method returns a new WeekdaySet that is the inverse selection of this WeekdaySet.
String	toString() Returns the official String representation of this Datatype.

Methods inherited from class net.sf.mmm.util.lang.api.AbstractSimpleDatatypeBase

equals, getValue, hashCode

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

NONE

public static final WeekdaySet NONE

An empty WeekdaySet containing no Weekday at all.

ALL

public static final WeekdaySet ALL

An WeekdaySet containing all Weekdays.

WORKDAYS

public static final WeekdaySet WORKDAYS

An WeekdaySet containing the working days (all but Weekday.SUNDAY and Weekday.SUNDAY).

set

private transient Set<Weekday> set

Constructor Detail

WeekdaySet

public WeekdaySet(Integer bitmask)

The constructor.

Parameters:

bitmask - - see getValue().

WeekdaySet

public WeekdaySet(Set<Weekday> set)

The constructor.

Parameters:

set - is the set representing the WeekdaySet to create.

WeekdaySet

public WeekdaySet(Weekday... weekdays)

The constructor.

Parameters:

weekdays - are the Weekdays representing the WeekdaySet to create.

Method Detail

encode

private static int encode(Weekday... weekdays)

This method encodes the given set to a bit-mask for getValue().

Parameters:

weekdays - are the Weekdays.

Returns:

the encoded value.

encode

private static int encode(Set<Weekday> set)

This method encodes the given set to a bit-mask for getValue().

Parameters:

set - is the Set of Weekdays.

Returns:

the encoded value.

getValue

public Integer getValue()

This method returns the WeekdaySet as compressed mask of seven bits. This method returns the raw value of this datatype. This will typically be a standard datatype (like String , Character, Boolean, any type of Number, any type of java.time.LocalDate, etc.).

Specified by:

getValue in interface AttributeReadValue<Integer>

Specified by:

getValue in interface SimpleDatatype<Integer>

Overrides:

getValue in class AbstractSimpleDatatype<Integer>

Returns:

the value of this datatype.

contains

public boolean contains(Weekday weekday)

This method determines if this WeekdaySet contains the given Weekday. This is equivalent to:

 getSet().contains(weekday)
 

Parameters:

weekday - is the Weekday to check.

Returns:

true if the given weekday is contained in this set, false otherwise.

getSet

public Set<Weekday> getSet()

This method gets an unmodifiable Set representing this WeekdaySet.

Returns:

the Set with all Weekdays.

getNextMatch

public Weekday getNextMatch(Weekday weekday)

This method gets the next Weekday contained in this WeekdaySet starting with the given weekday. If the given weekday is contained, it will be returned. Otherwise the next successor is determined.

Parameters:

weekday - is the Weekday to start with.

Returns:

the next Weekday starting with the given weekday or null if this WeekdaySet is empty.

toString

public String toString()

Description copied from interface: Datatype

Returns the official String representation of this Datatype. While the general contract of Object.toString() is very weak and mainly used for debugging, the contract here is very strong. The returned String has to be suitable for end-users and official output to any kind of sink.
ATTENTION:
This method is not supposed to do internationalization (I18N). See NlsMessage for this purpose and implement NlsObject if you want to support I18N/L10N.

Specified by:

toString in interface Datatype

Overrides:

toString in class AbstractSimpleDatatypeBase<Integer>

Returns:

the official String representation to display the value of this Datatype.

invert

public WeekdaySet invert()

This method returns a new WeekdaySet that is the inverse selection of this WeekdaySet. Every Weekday contained in this WeekdaySet is NOT contained in the returned result and vice versa.

Returns:

the inverse WeekdaySet.