Calendar (ical4j 3.0.19 API)

java.lang.Object
- net.fortuna.ical4j.model.Calendar

All Implemented Interfaces:: java.io.Serializable

public class Calendar
extends java.lang.Object
implements java.io.Serializable

$Id$ [Apr 5, 2004] Defines an iCalendar calendar.

    4.6 Calendar Components
    
       The body of the iCalendar object consists of a sequence of calendar
       properties and one or more calendar components. The calendar
       properties are attributes that apply to the calendar as a whole. The
       calendar components are collections of properties that express a
       particular calendar semantic. For example, the calendar component can
       specify an event, a to-do, a journal entry, time zone information, or
       free/busy time information, or an alarm.
    
       The body of the iCalendar object is defined by the following
       notation:
    
         icalbody   = calprops component
    
         calprops   = 2*(
    
                    ; 'prodid' and 'version' are both REQUIRED,
                    ; but MUST NOT occur more than once
    
                    prodid /version /
    
                    ; 'calscale' and 'method' are optional,
                    ; but MUST NOT occur more than once
    
                    calscale        /
                    method          /
    
                    x-prop
    
                    )
    
         component  = 1*(eventc / todoc / journalc / freebusyc /
                    / timezonec / iana-comp / x-comp)
    
         iana-comp  = "BEGIN" ":" iana-token CRLF
    
                      1*contentline
    
                      "END" ":" iana-token CRLF
    
         x-comp     = "BEGIN" ":" x-name CRLF
    
                      1*contentline
    
                      "END" ":" x-name CRLF

Example 1 - Creating a new calendar:


 Calendar calendar = new Calendar();
 calendar.getProperties().add(new ProdId("-//Ben Fortuna//iCal4j 1.0//EN"));
 calendar.getProperties().add(Version.VERSION_2_0);
 calendar.getProperties().add(CalScale.GREGORIAN);
 
 // Add events, etc..

See Also:: Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String BEGIN
Begin token.

static java.lang.String END
End token.

static java.lang.String VCALENDAR
Calendar token.

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`BEGIN` Begin token.
`static java.lang.String`	`END` End token.
`static java.lang.String`	`VCALENDAR` Calendar token.

Constructor Summary

Constructors
Constructor and Description
`Calendar()` Default constructor.
`Calendar(Calendar c)` Creates a deep copy of the specified calendar.
`Calendar(ComponentList<CalendarComponent> components)` Constructs a new calendar with no properties and the specified components.
`Calendar(PropertyList<Property> properties, ComponentList<CalendarComponent> components)` Initialise a Calendar object using the default configured validator.
`Calendar(PropertyList<Property> p, ComponentList<CalendarComponent> c, Validator<Calendar> validator)` Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object arg0)`
`CalScale`	`getCalendarScale()` Returns the optional calscale property.
`CalendarComponent`	`getComponent(java.lang.String name)` Convenience method for retrieving a named component.
`ComponentList<CalendarComponent>`	`getComponents()`
`<C extends CalendarComponent> ComponentList<C>`	`getComponents(java.lang.String name)` Convenience method for retrieving a list of named components.
`Method`	`getMethod()` Returns the optional method property.
`ProdId`	`getProductId()` Returns the mandatory prodid property.
`PropertyList<Property>`	`getProperties()`
`PropertyList<Property>`	`getProperties(java.lang.String name)` Convenience method for retrieving a list of named properties.
`<T extends Property> T`	`getProperty(java.lang.String name)` Convenience method for retrieving a named property.
`Version`	`getVersion()` Returns the mandatory version property.
`int`	`hashCode()`
`java.lang.String`	`toString()`
`void`	`validate()` Perform validation on the calendar, its properties and its components in its current state.
`void`	`validate(boolean recurse)` Perform validation on the calendar in its current state.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - BEGIN
```
public static final java.lang.String BEGIN
```
    Begin token.
    
    See Also:
    
    Constant Field Values
  - VCALENDAR
```
public static final java.lang.String VCALENDAR
```
    Calendar token.
    
    See Also:
    
    Constant Field Values
  - END
```
public static final java.lang.String END
```
    End token.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Calendar
```
public Calendar()
```
    Default constructor.
  - Calendar
```
public Calendar(ComponentList<CalendarComponent> components)
```
    Constructs a new calendar with no properties and the specified components.
    
    Parameters:
    
    components - a list of components to add to the calendar
  - Calendar
```
public Calendar(PropertyList<Property> properties,
                ComponentList<CalendarComponent> components)
```
    Initialise a Calendar object using the default configured validator.
    
    Parameters:
    
    properties - a list of initial calendar properties
    
    components - a list of initial calendar components
  - Calendar
```
public Calendar(PropertyList<Property> p,
                ComponentList<CalendarComponent> c,
                Validator<Calendar> validator)
```
    Constructor.
    
    Parameters:
    
    p - a list of properties
    
    c - a list of components
    
    validator - used to ensure the validity of the calendar instance
  - Calendar
```
public Calendar(Calendar c)
         throws java.text.ParseException,
                java.io.IOException,
                java.net.URISyntaxException
```
    Creates a deep copy of the specified calendar.
    
    Parameters:
    
    c - the calendar to copy
    
    Throws:
    
    java.io.IOException - where an error occurs reading calendar data
    
    java.text.ParseException - where calendar parsing fails
    
    java.net.URISyntaxException - where an invalid URI string is encountered
- Method Detail
  - toString
```
public final java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - getComponents
```
public final ComponentList<CalendarComponent> getComponents()
```
    Returns:
    
    Returns the components.
  - getComponents
```
public final <C extends CalendarComponent> ComponentList<C> getComponents(java.lang.String name)
```
    Convenience method for retrieving a list of named components.
    
    Parameters:
    
    name - name of components to retrieve
    
    Returns:
    
    a component list containing only components with the specified name
  - getComponent
```
public final CalendarComponent getComponent(java.lang.String name)
```
    Convenience method for retrieving a named component.
    
    Parameters:
    
    name - name of the component to retrieve
    
    Returns:
    
    the first matching component in the component list with the specified name
  - getProperties
```
public final PropertyList<Property> getProperties()
```
    Returns:
    
    Returns the properties.
  - getProperties
```
public final PropertyList<Property> getProperties(java.lang.String name)
```
    Convenience method for retrieving a list of named properties.
    
    Parameters:
    
    name - name of properties to retrieve
    
    Returns:
    
    a property list containing only properties with the specified name
  - getProperty
```
public final <T extends Property> T getProperty(java.lang.String name)
```
    Convenience method for retrieving a named property.
    
    Parameters:
    
    name - name of the property to retrieve
    
    Returns:
    
    the first matching property in the property list with the specified name
  - validate
```
public final void validate()
                    throws ValidationException
```
    Perform validation on the calendar, its properties and its components in its current state.
    
    Throws:
    
    ValidationException - where the calendar is not in a valid state
  - validate
```
public void validate(boolean recurse)
              throws ValidationException
```
    Perform validation on the calendar in its current state.
    
    Parameters:
    
    recurse - indicates whether to validate the calendar's properties and components
    
    Throws:
    
    ValidationException - where the calendar is not in a valid state
  - getProductId
```
public final ProdId getProductId()
```
    Returns the mandatory prodid property.
    
    Returns:
    
    the PRODID property, or null if property doesn't exist
  - getVersion
```
public final Version getVersion()
```
    Returns the mandatory version property.
    
    Returns:
    
    the VERSION property, or null if property doesn't exist
  - getCalendarScale
```
public final CalScale getCalendarScale()
```
    Returns the optional calscale property.
    
    Returns:
    
    the CALSCALE property, or null if property doesn't exist
  - getMethod
```
public final Method getMethod()
```
    Returns the optional method property.
    
    Returns:
    
    the METHOD property, or null if property doesn't exist
  - equals
```
public final boolean equals(java.lang.Object arg0)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object

Class Calendar

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

BEGIN

VCALENDAR

END

Constructor Detail

Calendar

Calendar

Calendar

Calendar

Calendar

Method Detail

toString

getComponents

getComponents

getComponent

getProperties

getProperties

getProperty

validate

validate

getProductId

getVersion

getCalendarScale

getMethod

equals

hashCode