Class Observance
- java.lang.Object
-
- net.fortuna.ical4j.model.Component
-
- net.fortuna.ical4j.model.component.Observance
-
- All Implemented Interfaces:
Serializable
public abstract class Observance extends Component
$Id$ [05-Apr-2004] Defines an iCalendar sub-component representing a timezone observance. Class made abstract such that only Standard and Daylight instances are valid.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
Observance(String name)
Constructs a timezone observance with the specified name and no properties.protected
Observance(String name, PropertyList<Property> properties)
Constructor protected to enforce use of sub-classes from this library.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Date
getLatestOnset(Date date)
Returns the latest applicable onset of this observance for the specified date.TzOffsetFrom
getOffsetFrom()
Returns the mandatory tzoffsetfrom property.TzOffsetTo
getOffsetTo()
Returns the mandatory tzoffsetto property.DtStart
getStartDate()
Returns the mandatory dtstart property.void
validate(boolean recurse)
Perform validation on a component.-
Methods inherited from class net.fortuna.ical4j.model.Component
calculateRecurrenceSet, copy, equals, getName, getProperties, getProperties, getProperty, getRequiredProperty, hashCode, toString, validate, validateProperties
-
-
-
-
Field Detail
-
STANDARD
public static final String STANDARD
one of 'standardc' or 'daylightc' MUST occur and each MAY occur more than once.- See Also:
- Constant Field Values
-
DAYLIGHT
public static final String DAYLIGHT
Token for daylight observance.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
Observance
protected Observance(String name)
Constructs a timezone observance with the specified name and no properties.- Parameters:
name
- the name of this observance component
-
Observance
protected Observance(String name, PropertyList<Property> properties)
Constructor protected to enforce use of sub-classes from this library.- Parameters:
name
- the name of the time typeproperties
- a list of properties
-
-
Method Detail
-
validate
public final void validate(boolean recurse) throws ValidationException
Perform validation on a component.- Specified by:
validate
in classComponent
- Parameters:
recurse
- indicates whether to validate the component's properties- Throws:
ValidationException
- where the component is not in a valid state
-
getLatestOnset
public final Date getLatestOnset(Date date)
Returns the latest applicable onset of this observance for the specified date.- Parameters:
date
- the latest date that an observance onset may occur- Returns:
- the latest applicable observance date or null if there is no applicable observance onset for the specified date
-
getStartDate
public final DtStart getStartDate()
Returns the mandatory dtstart property.- Returns:
- the DTSTART property or null if not specified
-
getOffsetFrom
public final TzOffsetFrom getOffsetFrom()
Returns the mandatory tzoffsetfrom property.- Returns:
- the TZOFFSETFROM property or null if not specified
-
getOffsetTo
public final TzOffsetTo getOffsetTo()
Returns the mandatory tzoffsetto property.- Returns:
- the TZOFFSETTO property or null if not specified
-
-