net.fortuna.ical4j.model
Class Calendar
java.lang.Object
net.fortuna.ical4j.model.Calendar
- Serializable
public class Calendar
extends java.lang.Object
implements Serializable
$Id: Calendar.java,v 1.33 2009/01/10 07:27:24 fortuna Exp $ [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..
Calendar() - Default constructor.
|
Calendar(Calendar c) - Creates a deep copy of the specified calendar.
|
Calendar(ComponentList components) - Constructs a new calendar with no properties and the specified components.
|
Calendar(PropertyList p, ComponentList c) - Constructor.
|
boolean | equals(Object arg0) - Uses
EqualsBuilder to test equality.
|
CalScale | getCalendarScale() - Returns the optional calscale property.
|
Component | getComponent(String name) - Convenience method for retrieving a named component.
|
ComponentList | getComponents()
|
ComponentList | getComponents(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 | getProperties()
|
PropertyList | getProperties(String name) - Convenience method for retrieving a list of named properties.
|
Property | getProperty(String name) - Convenience method for retrieving a named property.
|
Version | getVersion() - Returns the mandatory version property.
|
int | hashCode() - Uses
HashCodeBuilder to build hashcode.
|
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.
|
BEGIN
public static final String BEGIN
END
public static final String END
VCALENDAR
public static final String VCALENDAR
Calendar
public Calendar()
Default constructor.
Calendar
public Calendar(Calendar c)
throws ParseException,
IOException,
URISyntaxException
Creates a deep copy of the specified calendar.
Calendar
public Calendar(ComponentList components)
Constructs a new calendar with no properties and the specified components.
components
- a list of components to add to the calendar
Calendar
public Calendar(PropertyList p,
ComponentList c)
Constructor.
p
- a list of propertiesc
- a list of components
equals
public final boolean equals(Object arg0)
Uses EqualsBuilder
to test equality. Two calendars are equal if and only if their property lists and
component lists are equal.
getCalendarScale
public final CalScale getCalendarScale()
Returns the optional calscale property.
getComponent
public final Component getComponent(String name)
Convenience method for retrieving a named component.
name
- name of the component to retrieve
- the first matching component in the component list with the specified name
getComponents
public final ComponentList getComponents()
getComponents
public final ComponentList getComponents(String name)
Convenience method for retrieving a list of named components.
name
- name of components to retrieve
- a component list containing only components with the specified name
getMethod
public final Method getMethod()
Returns the optional method property.
getProductId
public final ProdId getProductId()
Returns the mandatory prodid property.
getProperties
public final PropertyList getProperties()
getProperties
public final PropertyList getProperties(String name)
Convenience method for retrieving a list of named properties.
name
- name of properties to retrieve
- a property list containing only properties with the specified name
getProperty
public final Property getProperty(String name)
Convenience method for retrieving a named property.
name
- name of the property to retrieve
- the first matching property in the property list with the specified name
getVersion
public final Version getVersion()
Returns the mandatory version property.
hashCode
public final int hashCode()
Uses HashCodeBuilder
to build hashcode.
toString
public final String toString()
java.lang.Object.toString()
validate
public final void validate()
throws ValidationException
Perform validation on the calendar, its properties and its components in its current state.
validate
public void validate(boolean recurse)
throws ValidationException
Perform validation on the calendar in its current state.
recurse
- indicates whether to validate the calendar's properties and components