biweekly.property

Class CalendarScale

java.lang.Object

biweekly.property.ICalProperty

biweekly.property.ValuedProperty<String>

biweekly.property.TextProperty

biweekly.property.EnumProperty

biweekly.property.CalendarScale

public class CalendarScale
extends EnumProperty

Defines the calendar system that this iCalendar object uses for all its date values. If none is specified, then the calendar is assumed to be in "gregorian" format.

Code sample (creating):

 ICalendar ical = new ICalendar();
 ical.setCalendarScale(CalendarScale.gregorian());
 
 ical = new ICalendar();
 ical.setCalendarScale(new CalendarScale("another-calendar-system"));
 

Code sample (retrieving):

 ICalendar ical = ...
 CalendarScale calscale = ical.getCalendarscale();
 
 if (calscale.isGregorian()) {
   //...
 } else {
   String value = calscale.getValue();
   //...
 }
 

Author:

Michael Angstadt

See Also:

RFC 5545 p.76-7, RFC 2445 p.73-4

Field Summary

Fields

Modifier and Type	Field and Description
static String	GREGORIAN

Fields inherited from class biweekly.property.ValuedProperty

value

Fields inherited from class biweekly.property.ICalProperty

parameters

Constructor Summary

Constructors

Constructor and Description
CalendarScale(CalendarScale original) Copy constructor.
CalendarScale(String value) Creates a new calendar scale property.

Method Summary

Methods

Modifier and Type	Method and Description
CalendarScale	copy() Creates a copy of this property object.
protected Collection<String>	getStandardValues(ICalVersion version) Gets the list of acceptable values for this property.
protected Collection<ICalVersion>	getValueSupportedVersions() Gets the iCalendar versions that this property's value is supported in.
static CalendarScale	gregorian() Creates a new property whose value is set to "gregorian".
boolean	isGregorian() Determines whether the property is set to "gregorian".

Methods inherited from class biweekly.property.EnumProperty

equals, hashCode, is, validate

Methods inherited from class biweekly.property.ValuedProperty

getValue, getValue, setValue, toStringValues, valueEquals, valueHashCode

Methods inherited from class biweekly.property.ICalProperty

addParameter, getParameter, getParameters, getParameters, removeParameter, setParameter, setParameter, setParameters, toString, validate

Methods inherited from class java.lang.Object

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

Field Detail

GREGORIAN

public static final String GREGORIAN

See Also:

Constant Field Values

Constructor Detail

CalendarScale

public CalendarScale(String value)

Creates a new calendar scale property. Use of this constructor is discouraged and may put the property in an invalid state. Use one of the static factory methods instead.

Parameters:

value - the value of the property (e.g. "gregorian")

CalendarScale

public CalendarScale(CalendarScale original)

Copy constructor.

Parameters:

original - the property to make a copy of

Method Detail

gregorian

public static CalendarScale gregorian()

Creates a new property whose value is set to "gregorian".

Returns:

the new property

isGregorian

public boolean isGregorian()

Determines whether the property is set to "gregorian".

Returns:

true if it's set to "gregorian", false if not

getStandardValues

protected Collection<String> getStandardValues(ICalVersion version)

Description copied from class: EnumProperty

Gets the list of acceptable values for this property.

Specified by:

getStandardValues in class EnumProperty

Parameters:

version - the version

Returns:

the list of acceptable values

getValueSupportedVersions

protected Collection<ICalVersion> getValueSupportedVersions()

Description copied from class: EnumProperty

Gets the iCalendar versions that this property's value is supported in. Meant to be overridden by the child class.

Overrides:

getValueSupportedVersions in class EnumProperty

Returns:

the supported versions

copy

public CalendarScale copy()

Description copied from class: ICalProperty

Creates a copy of this property object.

The default implementation of this method uses reflection to look for a copy constructor. Child classes SHOULD override this method to avoid the performance overhead involved in using reflection.

The child class's copy constructor, if present, MUST invoke the ICalProperty.ICalProperty(ICalProperty) super constructor to ensure that the parameters are also copied.

This method MUST be overridden by the child class if the child class does not have a copy constructor. Otherwise, an UnsupportedOperationException will be thrown when an attempt is made to copy the property (such as in the ICalendar class's copy constructor ).

Overrides:

copy in class ICalProperty

Returns:

the copy