|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.fortuna.ical4j.model.Content
net.fortuna.ical4j.model.Property
public abstract class Property
Defines an iCalendar property. Subclasses of this class provide additional validation and typed values for specific iCalendar properties.
Field Summary | |
---|---|
static java.lang.String |
ACTION
|
static java.lang.String |
ATTACH
the following are optional, and MAY occur more than once. |
static java.lang.String |
ATTENDEE
|
static java.lang.String |
CALSCALE
'calscale' and 'method' are optional, but MUST NOT occur more than once. |
static java.lang.String |
CATEGORIES
|
static java.lang.String |
CLASS
the following are optional, but MUST NOT occur more than once. |
static java.lang.String |
COMMENT
|
static java.lang.String |
COMPLETED
|
static java.lang.String |
CONTACT
|
static java.lang.String |
COUNTRY
the following are vvenue only properties. |
static java.lang.String |
CREATED
|
static java.lang.String |
DESCRIPTION
|
static java.lang.String |
DTEND
either 'dtend' or 'duration' may appear in a 'eventprop', but 'dtend' and 'duration' MUST NOT occur in the same 'eventprop'. |
static java.lang.String |
DTSTAMP
|
static java.lang.String |
DTSTART
|
static java.lang.String |
DUE
|
static java.lang.String |
DURATION
|
static java.lang.String |
EXDATE
|
static java.lang.String |
EXPERIMENTAL_PREFIX
|
static java.lang.String |
EXRULE
|
static java.lang.String |
EXTENDED_ADDRESS
|
static java.lang.String |
FREEBUSY
|
static java.lang.String |
GEO
|
static java.lang.String |
LAST_MODIFIED
|
static java.lang.String |
LOCALITY
|
static java.lang.String |
LOCATION
|
static java.lang.String |
LOCATION_TYPE
|
static java.lang.String |
METHOD
|
static java.lang.String |
NAME
|
static java.lang.String |
ORGANIZER
|
static java.lang.String |
PERCENT_COMPLETE
|
static java.lang.String |
POSTALCODE
|
static java.lang.String |
PRIORITY
|
static java.lang.String |
PRODID
'prodid' and 'version' are both REQUIRED, but MUST NOT occur more than once. |
static java.lang.String |
RDATE
|
static java.lang.String |
RECURRENCE_ID
|
static java.lang.String |
REGION
|
static java.lang.String |
RELATED_TO
|
static java.lang.String |
REPEAT
|
static java.lang.String |
REQUEST_STATUS
|
static java.lang.String |
RESOURCES
|
static java.lang.String |
RRULE
|
static java.lang.String |
SEQUENCE
|
static java.lang.String |
STATUS
|
static java.lang.String |
STREET_ADDRESS
|
static java.lang.String |
SUMMARY
|
static java.lang.String |
TEL
|
static java.lang.String |
TRANSP
|
static java.lang.String |
TRIGGER
|
static java.lang.String |
TZID
|
static java.lang.String |
TZNAME
|
static java.lang.String |
TZOFFSETFROM
|
static java.lang.String |
TZOFFSETTO
|
static java.lang.String |
TZURL
|
static java.lang.String |
UID
|
static java.lang.String |
URL
|
static java.lang.String |
VERSION
|
Constructor Summary | |
---|---|
protected |
Property(Property property)
Creates a deep copy of the specified property. |
protected |
Property(java.lang.String aName)
Constructor. |
protected |
Property(java.lang.String aName,
ParameterList aList)
Constructor made protected to enforce the use of PropertyFactory for property instantiation. |
Method Summary | |
---|---|
Property |
copy()
Create a (deep) copy of this property. |
boolean |
equals(java.lang.Object arg0)
Uses ObjectUtils to test equality. |
java.lang.String |
getName()
|
Parameter |
getParameter(java.lang.String name)
Convenience method for retrieving a single parameter. |
ParameterList |
getParameters()
|
ParameterList |
getParameters(java.lang.String name)
Convenience method for retrieving a list of named parameters. |
abstract java.lang.String |
getValue()
|
int |
hashCode()
Uses HashCodeBuilder to build hashcode. |
boolean |
isCalendarProperty()
Indicates whether this property is a calendar property. |
boolean |
isComponentProperty()
Indicates whether this property is a component property. |
abstract void |
setValue(java.lang.String aValue)
Sets the current value of the property. |
java.lang.String |
toString()
|
abstract void |
validate()
Perform validation on a property. |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String PRODID
public static final java.lang.String VERSION
public static final java.lang.String CALSCALE
public static final java.lang.String METHOD
public static final java.lang.String CLASS
public static final java.lang.String CREATED
public static final java.lang.String DESCRIPTION
public static final java.lang.String DTSTART
public static final java.lang.String GEO
public static final java.lang.String LAST_MODIFIED
public static final java.lang.String LOCATION
public static final java.lang.String ORGANIZER
public static final java.lang.String PERCENT_COMPLETE
public static final java.lang.String PRIORITY
public static final java.lang.String DTSTAMP
public static final java.lang.String SEQUENCE
public static final java.lang.String STATUS
public static final java.lang.String SUMMARY
public static final java.lang.String TRANSP
public static final java.lang.String UID
public static final java.lang.String URL
public static final java.lang.String RECURRENCE_ID
public static final java.lang.String COMPLETED
public static final java.lang.String DUE
public static final java.lang.String FREEBUSY
public static final java.lang.String TZID
public static final java.lang.String TZNAME
public static final java.lang.String TZOFFSETFROM
public static final java.lang.String TZOFFSETTO
public static final java.lang.String TZURL
public static final java.lang.String ACTION
public static final java.lang.String REPEAT
public static final java.lang.String TRIGGER
public static final java.lang.String REQUEST_STATUS
public static final java.lang.String DTEND
public static final java.lang.String DURATION
public static final java.lang.String ATTACH
public static final java.lang.String ATTENDEE
public static final java.lang.String CATEGORIES
public static final java.lang.String COMMENT
public static final java.lang.String CONTACT
public static final java.lang.String EXDATE
public static final java.lang.String EXRULE
public static final java.lang.String RELATED_TO
public static final java.lang.String RESOURCES
public static final java.lang.String RDATE
public static final java.lang.String RRULE
public static final java.lang.String EXPERIMENTAL_PREFIX
public static final java.lang.String COUNTRY
public static final java.lang.String EXTENDED_ADDRESS
public static final java.lang.String LOCALITY
public static final java.lang.String LOCATION_TYPE
public static final java.lang.String NAME
public static final java.lang.String POSTALCODE
public static final java.lang.String REGION
public static final java.lang.String STREET_ADDRESS
public static final java.lang.String TEL
Constructor Detail |
---|
protected Property(java.lang.String aName)
aName
- property nameprotected Property(java.lang.String aName, ParameterList aList)
PropertyFactory
for property instantiation.
aName
- property nameaList
- a list of parametersprotected Property(Property property) throws java.io.IOException, java.net.URISyntaxException, java.text.ParseException
property
- a property to copy
java.net.URISyntaxException
java.io.IOException
java.text.ParseException
Method Detail |
---|
public final java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public boolean isCalendarProperty()
public final boolean isComponentProperty()
public final java.lang.String getName()
public final ParameterList getParameters()
public final ParameterList getParameters(java.lang.String name)
name
- name of parameters to retrieve
public final Parameter getParameter(java.lang.String name)
name
- name of the parameter to retrieve
public abstract void setValue(java.lang.String aValue) throws java.io.IOException, java.net.URISyntaxException, java.text.ParseException
aValue
- a string representation of the property value
java.io.IOException
- possibly thrown by setting the value of certain properties
java.net.URISyntaxException
- possibly thrown by setting the value of certain properties
java.text.ParseException
- possibly thrown by setting the value of certain propertiespublic abstract java.lang.String getValue()
public abstract void validate() throws ValidationException
ValidationException
- where the property is not in a valid statepublic final boolean equals(java.lang.Object arg0)
ObjectUtils
to test equality. Two properties are equal if and only if their name, value and
parameter list are equal.
equals
in class java.lang.Object
Object.equals(java.lang.Object)
public final int hashCode()
HashCodeBuilder
to build hashcode.
hashCode
in class java.lang.Object
public Property copy() throws java.io.IOException, java.net.URISyntaxException, java.text.ParseException
java.io.IOException
java.net.URISyntaxException
java.text.ParseException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |