Top Description Fields Constructors Methods
net.fortuna.ical4j.model

public abstract Class Parameter

extends Content
implements Comparable<Parameter>
Class Inheritance
All Implemented Interfaces
java.lang.Comparable
Known Direct Subclasses
net.fortuna.ical4j.model.parameter.Member, net.fortuna.ical4j.model.parameter.Abbrev, net.fortuna.ical4j.model.parameter.AltRep, net.fortuna.ical4j.model.parameter.Cn, net.fortuna.ical4j.model.parameter.CuType, net.fortuna.ical4j.model.parameter.DelegatedFrom, net.fortuna.ical4j.model.parameter.DelegatedTo, net.fortuna.ical4j.model.parameter.Derived, net.fortuna.ical4j.model.parameter.Dir, net.fortuna.ical4j.model.parameter.Display, net.fortuna.ical4j.model.parameter.Email, net.fortuna.ical4j.model.parameter.Encoding, net.fortuna.ical4j.model.parameter.FbType, net.fortuna.ical4j.model.parameter.Feature, net.fortuna.ical4j.model.parameter.FmtType, net.fortuna.ical4j.model.parameter.Gap, net.fortuna.ical4j.model.parameter.Label, net.fortuna.ical4j.model.parameter.Language, net.fortuna.ical4j.model.parameter.LinkRel, net.fortuna.ical4j.model.parameter.Order, net.fortuna.ical4j.model.parameter.PartStat, net.fortuna.ical4j.model.parameter.Range, net.fortuna.ical4j.model.parameter.Related, net.fortuna.ical4j.model.parameter.RelType, net.fortuna.ical4j.model.parameter.Role, net.fortuna.ical4j.model.parameter.Rsvp, net.fortuna.ical4j.model.parameter.ScheduleAgent, net.fortuna.ical4j.model.parameter.ScheduleStatus, net.fortuna.ical4j.model.parameter.Schema, net.fortuna.ical4j.model.parameter.SentBy, net.fortuna.ical4j.model.parameter.Type, net.fortuna.ical4j.model.parameter.TzId, net.fortuna.ical4j.model.parameter.Value, net.fortuna.ical4j.model.parameter.Vvenue, net.fortuna.ical4j.model.parameter.XParameter
Imports
net.fortuna.ical4j.util.Strings, org.apache.commons.codec.EncoderException, org.apache.commons.lang3.builder.EqualsBuilder, .HashCodeBuilder, org.jetbrains.annotations.NotNull, java.util.Comparator

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

$Id$ [Apr 5, 2004]

Field Summary

Modifier and TypeField and Description
public static final String
ABBREV

Region abbreviation.

public static final String
ALTREP

Alternate text representation.

public static final String
CN

Common name.

public static final String
CUTYPE

Calendar user type.

public static final String
DELEGATED_FROM

Delegator.

public static final String
DELEGATED_TO

Delegatee.

public static final String
DERIVED

Derived.

public static final String
DIR

Directory entry.

public static final String
DISPLAY

Display format.

public static final String
EMAIL

Email address.

public static final String
ENCODING

Inline encoding.

public static final String
EXPERIMENTAL_PREFIX

Prefix to all experimental parameters.

public static final String
FBTYPE

Free/busy time type.

public static final String
FEATURE

Feature specification.

public static final String
FMTTYPE

Format type.

public static final String
LABEL

Label.

public static final String
LANGUAGE

Language for text.

public static final String
MEMBER

Group or list membership.

private final String
public static final String
ORDER

Order.

public static final String
PARTSTAT

Participation status.

public static final String
RANGE

Recurrence identifier range.

public static final String
RELATED

Alarm trigger relationship.

public static final String
RELTYPE

Relationship type.

public static final String
ROLE

Participation role.

public static final String
RSVP

RSVP expectation.

public static final String
SCHEDULE_AGENT

Schedule agent.

public static final String
SCHEDULE_STATUS

Schedule status.

public static final String
SCHEMA

Schema for structured data.

public static final String
SENT_BY

Sent by.

private static final long
public static final String
TYPE

Type.

public static final String
TZID

Reference to time zone object.

public static final String
VALUE

Property value data type.

public static final String
VVENUE

Reference to vvenue component.

Constructor Summary

AccessConstructor and Description
public
Parameter(final String
the parameter identifier
aName
)

public

Method Summary

Modifier and TypeMethod and Description
public int
compareTo(Parameter
the object to be compared.
o
)

Implements java.lang.Comparable.compareTo.

Compares this object with the specified object for order.

public final 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 final String

Returns:

Returns the name.
getName
()

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

public final int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public final String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

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

Field Detail

ABBREVback to summary
public static final String ABBREV

Region abbreviation.

ALTREPback to summary
public static final String ALTREP

Alternate text representation.

CNback to summary
public static final String CN

Common name.

CUTYPEback to summary
public static final String CUTYPE

Calendar user type.

DELEGATED_FROMback to summary
public static final String DELEGATED_FROM

Delegator.

DELEGATED_TOback to summary
public static final String DELEGATED_TO

Delegatee.

DERIVEDback to summary
public static final String DERIVED

Derived.

DIRback to summary
public static final String DIR

Directory entry.

DISPLAYback to summary
public static final String DISPLAY

Display format.

EMAILback to summary
public static final String EMAIL

Email address.

ENCODINGback to summary
public static final String ENCODING

Inline encoding.

EXPERIMENTAL_PREFIXback to summary
public static final String EXPERIMENTAL_PREFIX

Prefix to all experimental parameters.

FBTYPEback to summary
public static final String FBTYPE

Free/busy time type.

FEATUREback to summary
public static final String FEATURE

Feature specification.

FMTTYPEback to summary
public static final String FMTTYPE

Format type.

LABELback to summary
public static final String LABEL

Label.

LANGUAGEback to summary
public static final String LANGUAGE

Language for text.

MEMBERback to summary
public static final String MEMBER

Group or list membership.

nameback to summary
private final String name
ORDERback to summary
public static final String ORDER

Order.

PARTSTATback to summary
public static final String PARTSTAT

Participation status.

RANGEback to summary
public static final String RANGE

Recurrence identifier range.

RELTYPEback to summary
public static final String RELTYPE

Relationship type.

ROLEback to summary
public static final String ROLE

Participation role.

RSVPback to summary
public static final String RSVP

RSVP expectation.

SCHEDULE_AGENTback to summary
public static final String SCHEDULE_AGENT

Schedule agent.

SCHEDULE_STATUSback to summary
public static final String SCHEDULE_STATUS

Schedule status.

SCHEMAback to summary
public static final String SCHEMA

Schema for structured data.

SENT_BYback to summary
public static final String SENT_BY

Sent by.

serialVersionUIDback to summary
private static final long serialVersionUID

Hides net.fortuna.ical4j.model.Content.serialVersionUID.

TYPEback to summary
public static final String TYPE

Type.

TZIDback to summary
public static final String TZID

Reference to time zone object.

VALUEback to summary
public static final String VALUE

Property value data type.

VVENUEback to summary
public static final String VVENUE

Reference to vvenue component.

Constructor Detail

Parameterback to summary
public Parameter(final String aName)
Parameters
aName:String

the parameter identifier

Parameterback to summary
public Parameter(@NotNull Enum<?> name)

Method Detail

compareToback to summary
public int compareTo(Parameter 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:Parameter

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
equalsback to summary
public final 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
getNameback to summary
public final String getName()

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

Returns:String

Returns the name.

Annotations
@Override
hashCodeback to summary
public final 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
@Override
toStringback to summary
public final String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override