Package net.fortuna.ical4j.model

Class Parameter

java.lang.Object

net.fortuna.ical4j.model.Content

net.fortuna.ical4j.model.Parameter

All Implemented Interfaces:

Serializable, Comparable<Parameter>

Direct Known Subclasses:

Abbrev, AltRep, Cn, CuType, DelegatedFrom, DelegatedTo, Derived, Dir, Display, Email, Encoding, FbType, Feature, FmtType, Gap, Label, Language, LinkRel, Member, Order, PartStat, Range, Related, RelType, Role, Rsvp, ScheduleAgent, ScheduleStatus, Schema, SentBy, Type, TzId, Value, Vvenue, XParameter

public abstract class Parameter
extends Content
implements Comparable<Parameter>

Defines an iCalendar parameter. Subclasses of this class provide additional validation and typed values for specific iCalendar parameters.

Note that subclasses must provide a reference to the factory used to create the parameter to support parameter cloning (copy). If no factory is specified an UnsupportedOperationException will be thrown by the copy() method.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class net.fortuna.ical4j.model.Content

Content.Factory

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ABBREV	Region abbreviation.
static final String	ALTREP	Alternate text representation.
static final String	CN	Common name.
static final String	CUTYPE	Calendar user type.
static final String	DELEGATED_FROM	Delegator.
static final String	DELEGATED_TO	Delegatee.
static final String	DERIVED	Derived.
static final String	DIR	Directory entry.
static final String	DISPLAY	Display format.
static final String	EMAIL	Email address.
static final String	ENCODING	Inline encoding.
static final String	EXPERIMENTAL_PREFIX	Prefix to all experimental parameters.
static final String	FBTYPE	Free/busy time type.
static final String	FEATURE	Feature specification.
static final String	FMTTYPE	Format type.
static final String	LABEL	Label.
static final String	LANGUAGE	Language for text.
static final String	MEMBER	Group or list membership.
static final String	ORDER	Order.
static final String	PARTSTAT	Participation status.
static final String	RANGE	Recurrence identifier range.
static final String	RELATED	Alarm trigger relationship.
static final String	RELTYPE	Relationship type.
static final String	ROLE	Participation role.
static final String	RSVP	RSVP expectation.
static final String	SCHEDULE_AGENT	Schedule agent.
static final String	SCHEDULE_STATUS	Schedule status.
static final String	SCHEMA	Schema for structured data.
static final String	SENT_BY	Sent by.
static final String	TYPE	Type.
static final String	TZID	Reference to time zone object.
static final String	VALUE	Property value data type.
static final String	VVENUE	Reference to vvenue component.

Constructor Summary

Constructors

Constructor	Description
Parameter(String aName, ParameterFactory factory)

Method Summary

Modifier and Type	Method	Description
int	compareTo(Parameter o)
<T extends Parameter> T	copy()	Deep copy of parameter.
final boolean	equals(Object arg0)
final String	getName()
final int	hashCode()
final String	toString()

Methods inherited from class net.fortuna.ical4j.model.Content

getValue

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

ABBREV

public static final String ABBREV

Region abbreviation.

See Also:

• Constant Field Values

ALTREP

public static final String ALTREP

Alternate text representation.

See Also:

• Constant Field Values

CN

public static final String CN

Common name.

See Also:

• Constant Field Values

CUTYPE

public static final String CUTYPE

Calendar user type.

See Also:

• Constant Field Values

DELEGATED_FROM

public static final String DELEGATED_FROM

Delegator.

See Also:

• Constant Field Values

DELEGATED_TO

public static final String DELEGATED_TO

Delegatee.

See Also:

• Constant Field Values

DERIVED

public static final String DERIVED

Derived.

See Also:

• Constant Field Values

DIR

public static final String DIR

Directory entry.

See Also:

• Constant Field Values

DISPLAY

public static final String DISPLAY

Display format.

See Also:

• Constant Field Values

EMAIL

public static final String EMAIL

Email address.

See Also:

• Constant Field Values

ENCODING

public static final String ENCODING

Inline encoding.

See Also:

• Constant Field Values

FEATURE

public static final String FEATURE

Feature specification.

See Also:

• Constant Field Values

FMTTYPE

public static final String FMTTYPE

Format type.

See Also:

• Constant Field Values

FBTYPE

public static final String FBTYPE

Free/busy time type.

See Also:

• Constant Field Values

LABEL

public static final String LABEL

Label.

See Also:

• Constant Field Values

LANGUAGE

public static final String LANGUAGE

Language for text.

See Also:

• Constant Field Values

MEMBER

public static final String MEMBER

Group or list membership.

See Also:

• Constant Field Values

ORDER

public static final String ORDER

Order.

See Also:

• Constant Field Values

PARTSTAT

public static final String PARTSTAT

Participation status.

See Also:

• Constant Field Values

RANGE

public static final String RANGE

Recurrence identifier range.

See Also:

• Constant Field Values

RELATED

public static final String RELATED

Alarm trigger relationship.

See Also:

• Constant Field Values

RELTYPE

public static final String RELTYPE

Relationship type.

See Also:

• Constant Field Values

ROLE

public static final String ROLE

Participation role.

See Also:

• Constant Field Values

RSVP

public static final String RSVP

RSVP expectation.

See Also:

• Constant Field Values

SCHEDULE_AGENT

public static final String SCHEDULE_AGENT

Schedule agent.

See Also:

• Constant Field Values

SCHEDULE_STATUS

public static final String SCHEDULE_STATUS

Schedule status.

See Also:

• Constant Field Values

SCHEMA

public static final String SCHEMA

Schema for structured data.

See Also:

• Constant Field Values

SENT_BY

public static final String SENT_BY

Sent by.

See Also:

• Constant Field Values

TYPE

public static final String TYPE

Type.

See Also:

• Constant Field Values

TZID

public static final String TZID

Reference to time zone object.

See Also:

• Constant Field Values

VALUE

public static final String VALUE

Property value data type.

See Also:

• Constant Field Values

VVENUE

public static final String VVENUE

Reference to vvenue component.

See Also:

• Constant Field Values

EXPERIMENTAL_PREFIX

public static final String EXPERIMENTAL_PREFIX

Prefix to all experimental parameters.

See Also:

• Constant Field Values

Constructor Details

Parameter

public Parameter(String aName,
 ParameterFactory factory)

Parameters:

aName - the parameter identifier

factory - the factory used to create the parameter

Method Details

toString

public final String toString()

Overrides:

toString in class Object

getName

public final String getName()

Specified by:

getName in class Content

Returns:

Returns the name.

equals

public final boolean equals(Object arg0)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

copy

public <T extends Parameter> T copy()
                             throws URISyntaxException

Deep copy of parameter.

Returns:

new parameter

Throws:

URISyntaxException - where an invalid URI is encountered

compareTo

public int compareTo(Parameter o)

Specified by:

compareTo in interface Comparable<Parameter>