|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.fortuna.ical4j.model.Component
public abstract class Component
$Id$ [Apr 5, 2004] Defines an iCalendar component. Subclasses of this class provide additional validation and typed values for specific iCalendar components.
Field Summary | |
---|---|
static String |
AVAILABLE
Component token. |
static String |
BEGIN
Component start token. |
static String |
END
Component end token. |
static String |
EXPERIMENTAL_PREFIX
Prefix for non-standard components. |
static String |
VALARM
Component token. |
static String |
VAVAILABILITY
Component token. |
static String |
VEVENT
Component token. |
static String |
VFREEBUSY
Component token. |
static String |
VJOURNAL
Component token. |
static String |
VTIMEZONE
Component token. |
static String |
VTODO
Component token. |
static String |
VVENUE
Component token. |
Constructor Summary | |
---|---|
protected |
Component(String s)
Constructs a new component containing no properties. |
protected |
Component(String s,
PropertyList p)
Constructor made protected to enforce the use of ComponentFactory for component instantiation. |
Method Summary | |
---|---|
PeriodList |
calculateRecurrenceSet(Period period)
Calculates the recurrence set for this component using the specified period. |
Component |
copy()
Create a (deep) copy of this component. |
boolean |
equals(Object arg0)
|
String |
getName()
|
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. |
int |
hashCode()
|
String |
toString()
|
void |
validate()
Perform validation on a component and its properties. |
abstract void |
validate(boolean recurse)
Perform validation on a component. |
protected void |
validateProperties()
Invoke validation on the component properties in its current state. |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final String BEGIN
public static final String END
public static final String VEVENT
public static final String VTODO
public static final String VJOURNAL
public static final String VFREEBUSY
public static final String VTIMEZONE
public static final String VALARM
public static final String VAVAILABILITY
public static final String VVENUE
public static final String AVAILABLE
public static final String EXPERIMENTAL_PREFIX
Constructor Detail |
---|
protected Component(String s)
s
- a component nameprotected Component(String s, PropertyList p)
ComponentFactory
for component instantiation.
s
- component namep
- a list of propertiesMethod Detail |
---|
public String toString()
toString
in class Object
public final String getName()
public final PropertyList getProperties()
public final PropertyList getProperties(String name)
name
- name of properties to retrieve
public final Property getProperty(String name)
name
- name of the property to retrieve
public final void validate() throws ValidationException
ValidationException
- where the component is not in a valid statepublic abstract void validate(boolean recurse) throws ValidationException
recurse
- indicates whether to validate the component's properties
ValidationException
- where the component is not in a valid stateprotected final void validateProperties() throws ValidationException
ValidationException
- where any of the component properties is not in a valid statepublic boolean equals(Object arg0)
equals
in class Object
public int hashCode()
hashCode
in class Object
public Component copy() throws ParseException, IOException, URISyntaxException
IOException
- where an error occurs reading the component data
ParseException
- where parsing component data fails
URISyntaxException
- where component data contains an invalid URIpublic final PeriodList calculateRecurrenceSet(Period period)
If an explicit DURATION is not specified, the effective duration of each returned period is derived from the DTSTART and DTEND or DUE properties. If the component has no DURATION, DTEND or DUE, the effective duration is set to PT0S
period
- a range to calculate recurrences for
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |