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();
   ...
 }
 

Examples:

 //creating a new property
 CalendarScale calscale = CalendarScale.gregorian();
 
 if (calscale.isGregorian()) {
        //its value is "GREGORIAN"
 }
 

Author:

Michael Angstadt

See Also:

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

Field Summary

Fields inherited from class biweekly.property.ValuedProperty

value

Fields inherited from class biweekly.property.ICalProperty

parameters

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
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

is, validate

Methods inherited from class biweekly.property.ValuedProperty

getValue, getValue, setValue

Methods inherited from class biweekly.property.ICalProperty

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

Methods inherited from class java.lang.Object

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

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")

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.

Overrides:

getValueSupportedVersions in class EnumProperty

Returns:

the supported versions