biweekly.property
Class CalendarScale

java.lang.Object
  biweekly.property.ICalProperty
      biweekly.property.ValuedProperty<String>
          biweekly.property.TextProperty
              biweekly.property.CalendarScale

public class CalendarScale
extends TextProperty

Specifies the calendar system that this iCalendar object uses. If none is specified, then the calendar is assumed to be in Gregorian format.

Examples:

 CalendarScale calscale = CalendarScale.gregorian();
 
 if (calscale.isGregorian()) {
         ...
 }
 

Author:

Michael Angstadt

See Also:

RFC 5545 p.76-7

Field Summary

Fields inherited from class biweekly.property.ValuedProperty

value

Fields inherited from class biweekly.property.ICalProperty

parameters

Constructor Summary

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

Method Summary

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.ValuedProperty

getValue, setValue, validate

Methods inherited from class biweekly.property.ICalProperty

addParameter, getAltRepresentation, getCommonName, getDirectoryEntry, getFormatType, getLanguage, getParameter, getParameters, getParameters, getSentBy, getTimezoneId, removeParameter, setAltRepresentation, setCommonName, setDirectoryEntry, setFormatType, setLanguage, setParameter, setParameter, setParameters, setSentBy, setTimezone, setTimezoneId, 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