Package com.illumon.util.calendar

Class Calendars

java.lang.Object

com.illumon.util.calendar.Calendars

All Implemented Interfaces:

Map<String,BusinessCalendar>

public class Calendars
extends Object
implements Map<String,BusinessCalendar>

A collection of business calendars.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Calendars.StaleHolidayCalendarException

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K extends Object,V extends Object>

Field Summary

Fields

Modifier and Type	Field	Description
static final Set<String>	ABANDONED_CALENDARS
static final String	BUSINESS_CALENDAR_PROP_INTERNAL
static final String	BUSINESS_CALENDAR_PROP_USER
static final Set<String>	USER_CALENDARS

Method Summary

Modifier and Type	Method	Description
void	addCalendarFromFile(File file)	Adds a calendar to the collection from the file
void	addCalendarFromFile(String filePath)	Adds a calendar to the collection from the filePath
static BusinessCalendar	calendar()	Returns a business calendar.
static BusinessCalendar	calendar(String name)	Returns a business calendar.
static String[]	calendarNames()	Returns the names of all available calendars
void	clear()
boolean	containsKey(Object key)
boolean	containsValue(Object value)
Set<Map.Entry<String,BusinessCalendar>>	entrySet()
BusinessCalendar	get(Object key)
static String	getDefaultName()	Returns the default calendar name
boolean	isEmpty()
Set<String>	keySet()
BusinessCalendar	put(String key, BusinessCalendar value)
void	putAll(Map<? extends String,? extends BusinessCalendar> m)
BusinessCalendar	remove(Object key)
int	size()
static String[]	userCalendarNames()	Returns the names of all user calendars, as specified by the Calendar.resourcePath property
Collection<BusinessCalendar>	values()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll

Field Details

BUSINESS_CALENDAR_PROP_INTERNAL

public static final String BUSINESS_CALENDAR_PROP_INTERNAL

See Also:

• Constant Field Values

BUSINESS_CALENDAR_PROP_USER

public static final String BUSINESS_CALENDAR_PROP_USER

See Also:

• Constant Field Values

ABANDONED_CALENDARS

public static final Set<String> ABANDONED_CALENDARS

USER_CALENDARS

public static final Set<String> USER_CALENDARS

Method Details

calendar

public static BusinessCalendar calendar(String name)

Returns a business calendar.

Parameters:

name - name of the calendar

Returns:

business calendar

Throws:

IllegalArgumentException - no calendar matching name

calendar

public static BusinessCalendar calendar()

Returns a business calendar.

Returns:

default business calendar. The default is specified by the Calendar.default property.

getDefaultName

public static String getDefaultName()

Returns the default calendar name

Returns:

default business calendar name

calendarNames

public static String[] calendarNames()

Returns the names of all available calendars

Returns:

names of all available calendars

userCalendarNames

public static String[] userCalendarNames()

Returns the names of all user calendars, as specified by the Calendar.resourcePath property

Returns:

names of all user calendars

addCalendarFromFile

public void addCalendarFromFile(String filePath)

Adds a calendar to the collection from the filePath

Parameters:

filePath - must be xml format

addCalendarFromFile

public void addCalendarFromFile(File file)

Adds a calendar to the collection from the file

Parameters:

file - must be xml format

size

public int size()

Specified by:

size in interface Map<String,BusinessCalendar>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<String,BusinessCalendar>

containsKey

public boolean containsKey(Object key)

Specified by:

containsKey in interface Map<String,BusinessCalendar>

containsValue

public boolean containsValue(Object value)

Specified by:

containsValue in interface Map<String,BusinessCalendar>

get

public BusinessCalendar get(Object key)

Specified by:

get in interface Map<String,BusinessCalendar>

put

public BusinessCalendar put(String key,
 BusinessCalendar value)

Specified by:

put in interface Map<String,BusinessCalendar>

remove

public BusinessCalendar remove(Object key)

Specified by:

remove in interface Map<String,BusinessCalendar>

putAll

public void putAll(@NotNull
 Map<? extends String,? extends BusinessCalendar> m)

Specified by:

putAll in interface Map<String,BusinessCalendar>

clear

public void clear()

Specified by:

clear in interface Map<String,BusinessCalendar>

keySet

@NotNull
public Set<String> keySet()

Specified by:

keySet in interface Map<String,BusinessCalendar>

values

@NotNull
public Collection<BusinessCalendar> values()

Specified by:

values in interface Map<String,BusinessCalendar>

entrySet

@NotNull
public Set<Map.Entry<String,BusinessCalendar>> entrySet()

Specified by:

entrySet in interface Map<String,BusinessCalendar>