net.fortuna.ical4j.model
Class Parameter

java.lang.Object
  extended by net.fortuna.ical4j.model.Content
      extended by net.fortuna.ical4j.model.Parameter
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
Abbrev, AltRep, Cn, CuType, DelegatedFrom, DelegatedTo, Dir, Encoding, FbType, FmtType, Language, Member, PartStat, Range, Related, RelType, Role, Rsvp, ScheduleAgent, ScheduleStatus, SentBy, Type, TzId, Value, Vvenue, XParameter

public abstract class Parameter
extends Content

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.

Author:
Ben Fortuna $Id: Parameter.java,v 1.28 2011/05/19 14:12:51 fortuna Exp $ [Apr 5, 2004]
See Also:
Serialized Form

Field Summary
static java.lang.String ABBREV
          Region abbreviation.
static java.lang.String ALTREP
          Alternate text representation.
static java.lang.String CN
          Common name.
static java.lang.String CUTYPE
          Calendar user type.
static java.lang.String DELEGATED_FROM
          Delegator.
static java.lang.String DELEGATED_TO
          Delegatee.
static java.lang.String DIR
          Directory entry.
static java.lang.String ENCODING
          Inline encoding.
static java.lang.String EXPERIMENTAL_PREFIX
          Prefix to all experimental parameters.
static java.lang.String FBTYPE
          Free/busy time type.
static java.lang.String FMTTYPE
          Format type.
static java.lang.String LANGUAGE
          Language for text.
static java.lang.String MEMBER
          Group or list membership.
static java.lang.String PARTSTAT
          Participation status.
static java.lang.String RANGE
          Recurrence identifier range.
static java.lang.String RELATED
          Alarm trigger relationship.
static java.lang.String RELTYPE
          Relationship type.
static java.lang.String ROLE
          Participation role.
static java.lang.String RSVP
          RSVP expectation.
static java.lang.String SCHEDULE_AGENT
          Schedule agent.
static java.lang.String SCHEDULE_STATUS
          Schedule status.
static java.lang.String SENT_BY
          Sent by.
static java.lang.String TYPE
          Type.
static java.lang.String TZID
          Reference to time zone object.
static java.lang.String VALUE
          Property value data type.
static java.lang.String VVENUE
          Reference to vvenue component.
 
Constructor Summary
Parameter(java.lang.String aName, ParameterFactory factory)
           
 
Method Summary
 Parameter copy()
          Deep copy of parameter.
 boolean equals(java.lang.Object arg0)
          
 java.lang.String getName()
           
 int hashCode()
          
protected  boolean isQuotable()
          Indicates whether the current parameter value should be quoted.
 java.lang.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 Detail

ABBREV

public static final java.lang.String ABBREV
Region abbreviation.

See Also:
Constant Field Values

ALTREP

public static final java.lang.String ALTREP
Alternate text representation.

See Also:
Constant Field Values

CN

public static final java.lang.String CN
Common name.

See Also:
Constant Field Values

CUTYPE

public static final java.lang.String CUTYPE
Calendar user type.

See Also:
Constant Field Values

DELEGATED_FROM

public static final java.lang.String DELEGATED_FROM
Delegator.

See Also:
Constant Field Values

DELEGATED_TO

public static final java.lang.String DELEGATED_TO
Delegatee.

See Also:
Constant Field Values

DIR

public static final java.lang.String DIR
Directory entry.

See Also:
Constant Field Values

ENCODING

public static final java.lang.String ENCODING
Inline encoding.

See Also:
Constant Field Values

FMTTYPE

public static final java.lang.String FMTTYPE
Format type.

See Also:
Constant Field Values

FBTYPE

public static final java.lang.String FBTYPE
Free/busy time type.

See Also:
Constant Field Values

LANGUAGE

public static final java.lang.String LANGUAGE
Language for text.

See Also:
Constant Field Values

MEMBER

public static final java.lang.String MEMBER
Group or list membership.

See Also:
Constant Field Values

PARTSTAT

public static final java.lang.String PARTSTAT
Participation status.

See Also:
Constant Field Values

RANGE

public static final java.lang.String RANGE
Recurrence identifier range.

See Also:
Constant Field Values

RELATED

public static final java.lang.String RELATED
Alarm trigger relationship.

See Also:
Constant Field Values

RELTYPE

public static final java.lang.String RELTYPE
Relationship type.

See Also:
Constant Field Values

ROLE

public static final java.lang.String ROLE
Participation role.

See Also:
Constant Field Values

RSVP

public static final java.lang.String RSVP
RSVP expectation.

See Also:
Constant Field Values

SCHEDULE_AGENT

public static final java.lang.String SCHEDULE_AGENT
Schedule agent.

See Also:
Constant Field Values

SCHEDULE_STATUS

public static final java.lang.String SCHEDULE_STATUS
Schedule status.

See Also:
Constant Field Values

SENT_BY

public static final java.lang.String SENT_BY
Sent by.

See Also:
Constant Field Values

TYPE

public static final java.lang.String TYPE
Type.

See Also:
Constant Field Values

TZID

public static final java.lang.String TZID
Reference to time zone object.

See Also:
Constant Field Values

VALUE

public static final java.lang.String VALUE
Property value data type.

See Also:
Constant Field Values

VVENUE

public static final java.lang.String VVENUE
Reference to vvenue component.

See Also:
Constant Field Values

EXPERIMENTAL_PREFIX

public static final java.lang.String EXPERIMENTAL_PREFIX
Prefix to all experimental parameters.

See Also:
Constant Field Values
Constructor Detail

Parameter

public Parameter(java.lang.String aName,
                 ParameterFactory factory)
Parameters:
aName - the parameter identifier
factory - the factory used to create the parameter
Method Detail

toString

public final java.lang.String toString()

Overrides:
toString in class java.lang.Object

isQuotable

protected boolean isQuotable()
Indicates whether the current parameter value should be quoted.

Returns:
true if the value should be quoted, otherwise false

getName

public final java.lang.String getName()
Specified by:
getName in class Content
Returns:
Returns the name.

equals

public final boolean equals(java.lang.Object arg0)

Overrides:
equals in class java.lang.Object

hashCode

public final int hashCode()

Overrides:
hashCode in class java.lang.Object

copy

public final Parameter copy()
                     throws java.net.URISyntaxException
Deep copy of parameter.

Returns:
new parameter
Throws:
java.net.URISyntaxException - where an invalid URI is encountered


Copyright © 2004-2011 Modularity. All Rights Reserved.