Calendar (ical4j 4.0.0-alpha6 API)

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

All Implemented Interfaces:: Serializable

public class Calendar
extends Object
implements 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.add(new ProdId("-//Ben Fortuna//iCal4j 1.0//EN"));
 calendar.add(Version.VERSION_2_0);
 calendar.add(CalScale.GREGORIAN);
 
 // Add events, etc..

See Also:: Serialized Form

Field Summary

Fields
Modifier and Type Field Description

static String BEGIN
Begin token.

static String END
End token.

static String VCALENDAR
Calendar token.

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

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`Calendar`	`add(CalendarComponent component)`	Add a component to the calendar's component list.
`Calendar`	`add(Property property)`	Add a property to the calendar's property list.
`Calendar`	`copy()`	Creates a deep copy of the calendar.
`boolean`	`equals(Object arg0)`
`Optional<CalScale>`	`getCalendarScale()`	Deprecated. use `getProperty(String)`
`<T extends CalendarComponent> Optional<T>`	`getComponent(String name)`	Deprecated. use `ContentContainer.getFirst(String)`
`ComponentList<CalendarComponent>`	`getComponents()`
`<C extends CalendarComponent> List<C>`	`getComponents(String name)`	Deprecated. use `ContentContainer.get(String)`
`Optional<Method>`	`getMethod()`	Deprecated. use `getProperty(String)`
`Optional<ProdId>`	`getProductId()`	Deprecated. use `getProperty(String)`
`PropertyList`	`getProperties()`
`List<Property>`	`getProperties(String name)`	Deprecated. use `ContentContainer.get(String)`
`<T extends Property> Optional<T>`	`getProperty(String name)`	Deprecated. use `ContentContainer.getFirst(String)`
`Optional<Version>`	`getVersion()`	Deprecated. use `getProperty(String)`
`int`	`hashCode()`
`Calendar`	`remove(CalendarComponent component)`	Remove a component from the calendar's component list.
`Calendar`	`remove(Property property)`	Remove a property from the calendar's property list.
`Calendar`	`replace(CalendarComponent component)`	Add a component to the calendar's component list whilst removing all other components with the same component name.
`Calendar`	`replace(Property property)`	Add a property to the calendar's property list whilst removing all other properties with the same property name.
`protected void`	`setComponents(ComponentList<CalendarComponent> components)`
`protected void`	`setProperties(PropertyList properties)`
`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 String BEGIN
```
    Begin token.
    
    See Also:
    
    Constant Field Values
  - VCALENDAR
```
public static final String VCALENDAR
```
    Calendar token.
    
    See Also:
    
    Constant Field Values
  - END
```
public static final 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 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 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)
```
    Creates a shallow copy of the specified calendar.
    
    Parameters:
    
    c - the calendar to copy
- Method Detail
  - toString
```
public final String toString()
```
    Overrides:
    
    toString in class Object
  - getComponents
```
public final ComponentList<CalendarComponent> getComponents()
```
    Returns:
    
    Returns the components.
  - setComponents
```
protected void setComponents(ComponentList<CalendarComponent> components)
```
  - add
```
public Calendar add(CalendarComponent component)
```
    Add a component to the calendar's component list.
    
    Parameters:
    
    component - the component to add
    
    Returns:
    
    a reference to the calendar to support method chaining
  - remove
```
public Calendar remove(CalendarComponent component)
```
    Remove a component from the calendar's component list.
    
    Parameters:
    
    component - the component to remove
    
    Returns:
    
    a reference to the calendar to support method chaining
  - replace
```
public Calendar replace(CalendarComponent component)
```
    Add a component to the calendar's component list whilst removing all other components with the same component name.
    
    Parameters:
    
    component - the component to add
    
    Returns:
    
    a reference to the calendar to support method chaining
  - getComponents
```
@Deprecated
public final <C extends CalendarComponent> List<C> getComponents(String name)
```
    Deprecated. use ContentContainer.get(String)
    
    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
```
@Deprecated
public final <T extends CalendarComponent> Optional<T> getComponent(String name)
```
    Deprecated. use ContentContainer.getFirst(String)
    
    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 getProperties()
```
    Returns:
    
    Returns the properties.
  - setProperties
```
protected void setProperties(PropertyList properties)
```
  - add
```
public Calendar add(Property property)
```
    Add a property to the calendar's property list.
    
    Parameters:
    
    property - the property to add
    
    Returns:
    
    a reference to the calendar to support method chaining
  - remove
```
public Calendar remove(Property property)
```
    Remove a property from the calendar's property list.
    
    Parameters:
    
    property - the property to remove
    
    Returns:
    
    a reference to the calendar to support method chaining
  - replace
```
public Calendar replace(Property property)
```
    Add a property to the calendar's property list whilst removing all other properties with the same property name.
    
    Parameters:
    
    property - the property to add
    
    Returns:
    
    a reference to the calendar to support method chaining
  - getProperties
```
@Deprecated
public final List<Property> getProperties(String name)
```
    Deprecated. use ContentContainer.get(String)
    
    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
```
@Deprecated
public final <T extends Property> Optional<T> getProperty(String name)
```
    Deprecated. use ContentContainer.getFirst(String)
    
    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
  - copy
```
public final Calendar copy()
```
    Creates a deep copy of the calendar.
    
    Returns:
    
    a new calendar instance that protects against mutation of the source calendar
  - getProductId
```
@Deprecated
public final Optional<ProdId> getProductId()
```
    Deprecated. use getProperty(String)
    
    Returns the mandatory prodid property.
    
    Returns:
    
    the PRODID property, or null if property doesn't exist
  - getVersion
```
@Deprecated
public final Optional<Version> getVersion()
```
    Deprecated. use getProperty(String)
    
    Returns the mandatory version property.
    
    Returns:
    
    the VERSION property, or null if property doesn't exist
  - getCalendarScale
```
@Deprecated
public final Optional<CalScale> getCalendarScale()
```
    Deprecated. use getProperty(String)
    
    Returns the optional calscale property.
    
    Returns:
    
    the CALSCALE property, or null if property doesn't exist
  - getMethod
```
@Deprecated
public final Optional<Method> getMethod()
```
    Deprecated. use getProperty(String)
    
    Returns the optional method property.
    
    Returns:
    
    the METHOD property, or null if property doesn't exist
  - equals
```
public final boolean equals(Object arg0)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class 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

setComponents

add

remove

replace

getComponents

getComponent

getProperties

setProperties

add

remove

replace

getProperties

getProperty

validate

validate

copy

getProductId

getVersion

getCalendarScale

getMethod

equals

hashCode