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

public Class Role

extends Parameter
implements Encodable
Class Inheritance
All Implemented Interfaces
net.fortuna.ical4j.model.Encodable
Imports
net.fortuna.ical4j.model.Content, .Encodable, .Parameter, .ParameterFactory, net.fortuna.ical4j.util.Strings
$Id$ [18-Apr-2004]

Defines a Participation Role parameter.

Author
benfortuna

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
Role.Factory

Field Summary

Modifier and TypeField and Description
public static final Role
CHAIR

Chair.

public static final Role
NON_PARTICIPANT

Non-participant.

public static final Role
OPT_PARTICIPANT

Optional participant.

public static final Role
REQ_PARTICIPANT

Required participant.

private static final long
serialVersionUID

Hides net.fortuna.ical4j.model.Parameter.serialVersionUID.

private final String
value

private static final String
VALUE_CHAIR

private static final String
VALUE_NON_PARTICIPANT

private static final String
VALUE_OPT_PARTICIPANT

private static final String
VALUE_REQ_PARTICIPANT

Inherited from net.fortuna.ical4j.model.Parameter:
ABBREVALTREPCNCUTYPEDELEGATED_FROMDELEGATED_TODERIVEDDIRDISPLAYEMAILENCODINGEXPERIMENTAL_PREFIXFBTYPEFEATUREFMTTYPELABELLANGUAGEMEMBERORDERPARTSTATRANGERELATEDRELTYPEROLERSVPSCHEDULE_AGENTSCHEDULE_STATUSSCHEMASENT_BYTYPETZIDVALUEVVENUE

Constructor Summary

AccessConstructor and Description
public
Role(final String
a string representation of a participation role
aValue)

Method Summary

Modifier and TypeMethod and Description
public final String
getValue()

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

Inherited from net.fortuna.ical4j.model.Parameter:
compareToequalsgetNamehashCodetoString

Field Detail

CHAIRback to summary
public static final Role CHAIR

Chair.

NON_PARTICIPANTback to summary
public static final Role NON_PARTICIPANT

Non-participant.

OPT_PARTICIPANTback to summary
public static final Role OPT_PARTICIPANT

Optional participant.

REQ_PARTICIPANTback to summary
public static final Role REQ_PARTICIPANT

Required participant.

serialVersionUIDback to summary
private static final long serialVersionUID

Hides net.fortuna.ical4j.model.Parameter.serialVersionUID.

valueback to summary
private final String value
VALUE_CHAIRback to summary
private static final String VALUE_CHAIR
VALUE_NON_PARTICIPANTback to summary
private static final String VALUE_NON_PARTICIPANT
VALUE_OPT_PARTICIPANTback to summary
private static final String VALUE_OPT_PARTICIPANT
VALUE_REQ_PARTICIPANTback to summary
private static final String VALUE_REQ_PARTICIPANT

Constructor Detail

Roleback to summary
public Role(final String aValue)
Parameters
aValue:String

a string representation of a participation role

Method Detail

getValueback to summary
public final String getValue()

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

Returns:String

Doc from net.fortuna.ical4j.model.Content.getValue.

the content value

Annotations
@Override
net.fortuna.ical4j.model.parameter back to summary

public Class Role.Factory

extends Factory
implements ParameterFactory<Role>
Class Inheritance
All Implemented Interfaces
net.fortuna.ical4j.model.ParameterFactory, java.io.Serializable

Field Summary

Modifier and TypeField and Description
private static final long
serialVersionUID

Constructor Summary

AccessConstructor and Description
public
Factory()

Method Summary

Modifier and TypeMethod and Description
public Role
createParameter(final String
a value to assign to the returned parameter
value)

Implements net.fortuna.ical4j.model.ParameterFactory.createParameter.

Returns a parameter instance of the appropriate type with the specified value.

Inherited from net.fortuna.ical4j.model.Content.Factory:
supports

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

Constructor Detail

Factoryback to summary
public Factory()

Method Detail

createParameterback to summary
public Role createParameter(final String value)

Implements net.fortuna.ical4j.model.ParameterFactory.createParameter.

Doc from net.fortuna.ical4j.model.ParameterFactory.createParameter.

Returns a parameter instance of the appropriate type with the specified value.

Parameters
value:String

a value to assign to the returned parameter

Returns:Role

a parameter instance, or null if this factory is unable to create an appropriate parameter

Annotations
@Override