|
||||||||||
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
Defines an iCalendar component. Subclasses of this class provide additional validation and typed values for specific iCalendar components.
Field Summary | |
---|---|
static String |
BEGIN
|
static String |
END
|
static String |
EXPERIMENTAL_PREFIX
|
static String |
VALARM
|
static String |
VEVENT
|
static String |
VFREEBUSY
|
static String |
VJOURNAL
|
static String |
VTIMEZONE
|
static String |
VTODO
|
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 | |
---|---|
boolean |
equals(Object arg0)
Uses ObjectUtils to test equality. |
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()
Uses HashCodeBuilder to build 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 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
Object.toString()
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 final boolean equals(Object arg0)
ObjectUtils
to test equality.
Two components are equal if and only if their
name and property lists are equal.
equals
in class Object
public final int hashCode()
HashCodeBuilder
to build hashcode.
hashCode
in class Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |