ical4j 4.1.1 · net.fortuna.ical4j.model.Property · APIdia, the JavaDoc alternative

Field Summary

Modifier and Type	Field and Description
public static final String	ACKNOWLEDGED Acknowledged Property taken from draft-daboo-valarm-extensions
public static final String	ACTION Alarm action property name.
public static final String	ATTACH Attachment property name.
public static final String	ATTENDEE Attendee property name.
public static final String	BUSYTYPE Busy type property name.
public static final String	CALENDAR_ADDRESS Participant cua property name.
public static final String	CALSCALE Calendar scale property name.
public static final String	CATEGORIES Categories property name.
public static final String	CLASS Classifier property name.
public static final String	COMMENT Comment property name.
public static final String	COMPLETED Completed date property name.
public static final String	CONTACT Contact property name.
public static final String	COUNTRY VVENUE country property name.
public static final String	CREATED Creation date property name.
public static final String	DESCRIPTION Description property name.
public static final String	DTEND End date property name.
public static final String	DTSTAMP Date-stamp property name.
public static final String	DTSTART Start date property name.
public static final String	DUE Due date property name.
public static final String	DURATION Duration property name.
public static final String	EXDATE Exclusion date property name.
public static final String	EXPERIMENTAL_PREFIX Prefix for non-standard properties.
public static final String	EXRULE Exclusion rule property name.
public static final String	EXTENDED_ADDRESS VVENUE extended address property name.
public static final String	FREEBUSY Free/busy property name.
public static final String	GEO Geographic location property name.
public static final String	LAST_MODIFIED Last modified date property name.
public static final String	LOCALITY VVENUE locality property name.
public static final String	LOCATION Location property name.
public static final String	LOCATION_TYPE Location type property name.
public static final String	METHOD iTIP method property name.
public static final String	NAME VVENUE name property name.
private final String	name
public static final String	ORGANIZER Organiser property name.
private ParameterList	parameters
public static final String	PARTICIPANT_TYPE Participant type.
public static final String	PERCENT_COMPLETE Percentage complete property name.
public static final String	POSTALCODE VVENUE postal code property name.
private String	prefix Support for a content line prefix used to group related properties.
public static final String	PRIORITY Prority property name.
public static final String	PRODID Product identifier property name.
public static final String	PROXIMITY
public static final String	RDATE Recurrence date property name.
public static final String	RECURRENCE_ID Recurrence identifier property name.
public static final String	REGION VVENUE region property name.
public static final String	RELATED_TO Relationship property name.
public static final String	REPEAT Repeat rule property name.
public static final String	REQUEST_STATUS Request status property name.
public static final String	RESOURCE_TYPE Resource type property name.
public static final String	RESOURCES Resources property name.
public static final String	RRULE Recurrence rule property name.
public static final String	SEQUENCE Sequence property name.
private static final long	serialVersionUID Hides net.fortuna.ical4j.model.Content.serialVersionUID.
public static final String	STATUS Status property name.
public static final String	STREET_ADDRESS VVENUE street address property name.
public static final String	STRUCTURED_DATA Structured data property name.
public static final String	STYLED_DESCRIPTION Styled description property name.
public static final String	SUMMARY Summary property name.
public static final String	TEL VVENUE telephone property name.
public static final String	TRANSP Transparency property name.
public static final String	TRIGGER Alarm trigger property name.
public static final String	TZID Timezone identifier property name.
public static final String	TZID_ALIAS_OF
public static final String	TZNAME Timezone name property name.
public static final String	TZOFFSETFROM Prior timezone offset property name.
public static final String	TZOFFSETTO New timezone offset property name.
public static final String	TZUNTIL
public static final String	TZURL URL for timezone definition property name.
public static final String	UID Unique identifier property name.
public static final String	URL Uniform resource locator property name.
public static final String	VERSION iCalendar version property name.
public static final String	XML

Constructor Summary

Access	Constructor and Description
protected	Property(final String property name aName) Constructor.
protected	Property(@NotNull Enum<?> name)
protected	Property(final String a property identifier aName, final ParameterList a list of initial parameters aList)
protected	Property(@NotNull Enum<?> name, final ParameterList aList)

Method Summary

Modifier and Type	Method and Description
public <T extends Property> T	Returns: a reference to the property to support method chaining add(Parameter the parameter to add parameter) Add a parameter to the property's parameter list.
public int	compareTo(@NotNull Property the object to be compared. o) Implements java.lang.Comparable.compareTo. Compares this object with the specified object for order.
public final Property	Returns: the copy of the property copy() Create a (deep) copy of this property.
public boolean	equals(final Object the reference object with which to compare. arg0) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public Property	getFluentTarget() Implements net.fortuna.ical4j.model.FluentProperty.getFluentTarget.
public final String	Returns: Returns the name. getName() Implements abstract net.fortuna.ical4j.model.Content.getName.
public final <P extends Parameter> Optional<P>	Returns: the first parameter from the parameter list with the specified name getParameter(final String name of the parameter to retrieve name) Convenience method for retrieving a single parameter.
public final <P extends Parameter> Optional<P>	getParameter(@NotNull Enum<?> name)
public final ParameterList	Returns: Returns the underlying parameter list. getParameterList()
public final List<Parameter>	Returns: a parameter list containing only parameters with the specified name getParameters(final String... name of parameters to retrieve name) Convenience method for retrieving a list of named parameters.
public String	Returns: a string prefix, or null if not applicable getPrefix() Returns the property prefix for applicable property types.
public final < expected parameter type P extends Parameter> P	Returns: a parameter of the specified type getRequiredParameter(final String parameter name name) Retrieve a single required parameter.
public final <P extends Parameter> P	getRequiredParameter(@NotNull Enum<?> name)
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
protected abstract PropertyFactory<?>	Returns: a property factory instance newFactory() Returns a new property factory used to create deep copies.
public <T extends Property> T	Returns: a reference to the property to support method chaining remove(Parameter the parameter to remove parameter) Remove a parameter from the property's parameter list.
public <T extends Property> T	Returns: a reference to the property to support method chaining removeAll(String... the name of parameters to remove parameterName) Remove all parameters with the specified name from the property's parameter list.
public <T extends Property> T	Returns: a reference to the property to support method chaining replace(Parameter the parameter to add parameter) Add a parameter to the property's parameter list whilst removing all other parameters with the same name.
protected void	setParameters(ParameterList parameters)
public void	setPrefix(String prefix)
public abstract void	setValue(String a string representation of the property value aValue) Sets the current value of the property.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public abstract ValidationResult	validate() Perform validation on a property.

Inherited from net.fortuna.ical4j.model.Content:: getValue

Field Detail

ACKNOWLEDGED	back to summary
public static final String ACKNOWLEDGED Acknowledged Property taken from draft-daboo-valarm-extensions

ACTION	back to summary
public static final String ACTION Alarm action property name.

ATTACH	back to summary
public static final String ATTACH Attachment property name.

ATTENDEE	back to summary
public static final String ATTENDEE Attendee property name.

BUSYTYPE	back to summary
public static final String BUSYTYPE Busy type property name.

CALENDAR_ADDRESS	back to summary
public static final String CALENDAR_ADDRESS Participant cua property name.

CALSCALE	back to summary
public static final String CALSCALE Calendar scale property name.

CATEGORIES	back to summary
public static final String CATEGORIES Categories property name.

CLASS	back to summary
public static final String CLASS Classifier property name.

COMMENT	back to summary
public static final String COMMENT Comment property name.

COMPLETED	back to summary
public static final String COMPLETED Completed date property name.

CONTACT	back to summary
public static final String CONTACT Contact property name.

COUNTRY	back to summary
public static final String COUNTRY VVENUE country property name.

CREATED	back to summary
public static final String CREATED Creation date property name.

DESCRIPTION	back to summary
public static final String DESCRIPTION Description property name.

DTEND	back to summary
public static final String DTEND End date property name.

DTSTAMP	back to summary
public static final String DTSTAMP Date-stamp property name.

DTSTART	back to summary
public static final String DTSTART Start date property name.

DUE	back to summary
public static final String DUE Due date property name.

DURATION	back to summary
public static final String DURATION Duration property name.

EXDATE	back to summary
public static final String EXDATE Exclusion date property name.

EXPERIMENTAL_PREFIX	back to summary
public static final String EXPERIMENTAL_PREFIX Prefix for non-standard properties.

EXRULE	back to summary
public static final String EXRULE Exclusion rule property name.

EXTENDED_ADDRESS	back to summary
public static final String EXTENDED_ADDRESS VVENUE extended address property name.

FREEBUSY	back to summary
public static final String FREEBUSY Free/busy property name.

GEO	back to summary
public static final String GEO Geographic location property name.

LAST_MODIFIED	back to summary
public static final String LAST_MODIFIED Last modified date property name.

LOCALITY	back to summary
public static final String LOCALITY VVENUE locality property name.

LOCATION	back to summary
public static final String LOCATION Location property name.

LOCATION_TYPE	back to summary
public static final String LOCATION_TYPE Location type property name.

METHOD	back to summary
public static final String METHOD iTIP method property name.

NAME	back to summary
public static final String NAME VVENUE name property name.

name	back to summary
private final String name

ORGANIZER	back to summary
public static final String ORGANIZER Organiser property name.

parameters	back to summary
private ParameterList parameters

PARTICIPANT_TYPE	back to summary
public static final String PARTICIPANT_TYPE Participant type.

PERCENT_COMPLETE	back to summary
public static final String PERCENT_COMPLETE Percentage complete property name.

POSTALCODE	back to summary
public static final String POSTALCODE VVENUE postal code property name.

prefix	back to summary
private String prefix Support for a content line prefix used to group related properties. This is only used with vCard properties.

PRIORITY	back to summary
public static final String PRIORITY Prority property name.

PRODID	back to summary
public static final String PRODID Product identifier property name.

PROXIMITY	back to summary
public static final String PROXIMITY

RDATE	back to summary
public static final String RDATE Recurrence date property name.

RECURRENCE_ID	back to summary
public static final String RECURRENCE_ID Recurrence identifier property name.

REGION	back to summary
public static final String REGION VVENUE region property name.

RELATED_TO	back to summary
public static final String RELATED_TO Relationship property name.

REPEAT	back to summary
public static final String REPEAT Repeat rule property name.

REQUEST_STATUS	back to summary
public static final String REQUEST_STATUS Request status property name.

RESOURCE_TYPE	back to summary
public static final String RESOURCE_TYPE Resource type property name.

RESOURCES	back to summary
public static final String RESOURCES Resources property name.

RRULE	back to summary
public static final String RRULE Recurrence rule property name.

SEQUENCE	back to summary
public static final String SEQUENCE Sequence property name.

serialVersionUID	back to summary
private static final long serialVersionUID Hides net.fortuna.ical4j.model.Content.serialVersionUID.

STATUS	back to summary
public static final String STATUS Status property name.

STREET_ADDRESS	back to summary
public static final String STREET_ADDRESS VVENUE street address property name.

STRUCTURED_DATA	back to summary
public static final String STRUCTURED_DATA Structured data property name.

STYLED_DESCRIPTION	back to summary
public static final String STYLED_DESCRIPTION Styled description property name.

SUMMARY	back to summary
public static final String SUMMARY Summary property name.

TEL	back to summary
public static final String TEL VVENUE telephone property name.

TRANSP	back to summary
public static final String TRANSP Transparency property name.

TRIGGER	back to summary
public static final String TRIGGER Alarm trigger property name.

TZID	back to summary
public static final String TZID Timezone identifier property name.

TZID_ALIAS_OF	back to summary
public static final String TZID_ALIAS_OF

TZNAME	back to summary
public static final String TZNAME Timezone name property name.

TZOFFSETFROM	back to summary
public static final String TZOFFSETFROM Prior timezone offset property name.

TZOFFSETTO	back to summary
public static final String TZOFFSETTO New timezone offset property name.

TZUNTIL	back to summary
public static final String TZUNTIL

TZURL	back to summary
public static final String TZURL URL for timezone definition property name.

UID	back to summary
public static final String UID Unique identifier property name.

URL	back to summary
public static final String URL Uniform resource locator property name.

VERSION	back to summary
public static final String VERSION iCalendar version property name.

XML	back to summary
public static final String XML

Constructor Detail

Property

back to summary

protected Property(final String aName)

Constructor.

Parameters

aName:String: property name

Property	back to summary
protected Property(@NotNull Enum<?> name)

Property	back to summary
protected Property(final String aName, final ParameterList aList) Parameters aName:String a property identifier aList:ParameterList a list of initial parameters

Property	back to summary
protected Property(@NotNull Enum<?> name, final ParameterList aList)

Method Detail

add

back to summary

public <T extends Property> T add(Parameter parameter)

Add a parameter to the property's parameter list.

Parameters

parameter:Parameter: the parameter to add

Returns:T

a reference to the property to support method chaining

Annotations

@SuppressWarnings:unchecked

compareTo back to summary

public int compareTo(@NotNull Property o)

Implements java.lang.Comparable.compareTo.

Doc from java.lang.Comparable.compareTo.

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure signum(x.compareTo(y)) == -signum(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception if and only if y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y) > 0 && y.compareTo(z) > 0) implies x.compareTo(z) > 0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that signum(x.compareTo(z)) == signum(y.compareTo(z)), for all z.

Parameters

o:@NotNull Property: the object to be compared.

Returns:int

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Annotations

@Override

copy

back to summary

public final Property copy()

Create a (deep) copy of this property.

Returns:Property: the copy of the property

equals back to summary

public boolean equals(final Object arg0)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

arg0:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getFluentTarget

back to summary

public Property getFluentTarget()

Implements net.fortuna.ical4j.model.FluentProperty.getFluentTarget.

Annotations

@Override

getName

back to summary

public final String getName()

Implements abstract net.fortuna.ical4j.model.Content.getName.

Returns:String

Returns the name.

Annotations

@Override

getParameter

back to summary

public final Optional getParameter(final String name)

Convenience method for retrieving a single parameter.

Parameters

name:String: name of the parameter to retrieve

Returns:Optional

the first parameter from the parameter list with the specified name

getParameter	back to summary
public final <P extends Parameter> Optional<P> getParameter(@NotNull Enum<?> name)

getParameterList	back to summary
public final ParameterList getParameterList() Returns:ParameterList Returns the underlying parameter list.

getParameters

back to summary

public final List<Parameter> getParameters(final String... name)

Convenience method for retrieving a list of named parameters.

Parameters

name:String[]: name of parameters to retrieve

Returns:List<Parameter>

a parameter list containing only parameters with the specified name

getPrefix

back to summary

public String getPrefix()

Returns the property prefix for applicable property types.

Returns:String: a string prefix, or null if not applicable

getRequiredParameter

back to summary

public final P getRequiredParameter(final String name)

Retrieve a single required parameter.

Parameters

: expected parameter type
name:String: parameter name

Returns:P

a parameter of the specified type

getRequiredParameter	back to summary
public final <P extends Parameter> P getRequiredParameter(@NotNull Enum<?> name)

hashCode back to summary

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations