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

public Class XProperty

extends Property
implements Encodable
Class Inheritance
All Implemented Interfaces
net.fortuna.ical4j.model.Encodable
Imports
net.fortuna.ical4j.model.Encodable, .ParameterList, .Property, .PropertyFactory, net.fortuna.ical4j.util.CompatibilityHints, net.fortuna.ical4j.validate.ValidationEntry, .ValidationException, .ValidationResult
$Id$ Created: [15/06/2004] Defines an extension property.
Author
benfortuna

Field Summary

Modifier and TypeField and Description
private static final long
serialVersionUID

Hides net.fortuna.ical4j.model.Property.serialVersionUID.

private String
value

Inherited from net.fortuna.ical4j.model.Property:
ACKNOWLEDGEDACTIONATTACHATTENDEEBUSYTYPECALENDAR_ADDRESSCALSCALECATEGORIESCLASSCOMMENTCOMPLETEDCONTACTCOUNTRYCREATEDDESCRIPTIONDTENDDTSTAMPDTSTARTDUEDURATIONEXDATEEXPERIMENTAL_PREFIXEXRULEEXTENDED_ADDRESSFREEBUSYGEOLAST_MODIFIEDLOCALITYLOCATIONLOCATION_TYPEMETHODNAMEORGANIZERPARTICIPANT_TYPEPERCENT_COMPLETEPOSTALCODEPRIORITYPRODIDPROXIMITYRDATERECURRENCE_IDREGIONRELATED_TOREPEATREQUEST_STATUSRESOURCE_TYPERESOURCESRRULESEQUENCESTATUSSTREET_ADDRESSSTRUCTURED_DATASTYLED_DESCRIPTIONSUMMARYTELTRANSPTRIGGERTZIDTZID_ALIAS_OFTZNAMETZOFFSETFROMTZOFFSETTOTZUNTILTZURLUIDURLVERSIONXML

Constructor Summary

AccessConstructor and Description
public
XProperty(final String
a non-standard property name
name)

Constructs an uninitialised non-standard property.

public
XProperty(final String
a non-standard property name
aName, final String
a property value
aValue)

public
XProperty(final String
a non-standard property name
aName, final ParameterList
a list of parameters
aList, final String
a property value
aValue)

Method Summary

Modifier and TypeMethod and Description
public final String
getValue()

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

protected PropertyFactory<XProperty>
newFactory()

Implements abstract net.fortuna.ical4j.model.Property.newFactory.

Returns a new property factory used to create deep copies.

public final void
setValue(final String
a string representation of the property value
aValue)

Implements abstract net.fortuna.ical4j.model.Property.setValue.

Sets the current value of the property.

public ValidationResult
validate()

Implements abstract net.fortuna.ical4j.model.Property.validate.

Perform validation on a property.

Inherited from net.fortuna.ical4j.model.Property:
addcompareTocopyequalsgetFluentTargetgetNamegetParametergetParametergetParameterListgetParametersgetPrefixgetRequiredParametergetRequiredParameterhashCoderemoveremoveAllreplacesetParameterssetPrefixtoString

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

Hides net.fortuna.ical4j.model.Property.serialVersionUID.

valueback to summary
private String value

Constructor Detail

XPropertyback to summary
public XProperty(final String name)

Constructs an uninitialised non-standard property.

Parameters
name:String

a non-standard property name

XPropertyback to summary
public XProperty(final String aName, final String aValue)
Parameters
aName:String

a non-standard property name

aValue:String

a property value

XPropertyback to summary
public XProperty(final String aName, final ParameterList aList, final String aValue)
Parameters
aName:String

a non-standard property name

aList:ParameterList

a list of parameters

aValue:String

a property value

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
newFactoryback to summary
protected PropertyFactory<XProperty> newFactory()

Implements abstract net.fortuna.ical4j.model.Property.newFactory.

Doc from net.fortuna.ical4j.model.Property.newFactory.

Returns a new property factory used to create deep copies.

Returns:PropertyFactory<XProperty>

a property factory instance

Annotations
@Override
setValueback to summary
public final void setValue(final String aValue)

Implements abstract net.fortuna.ical4j.model.Property.setValue.

Doc from net.fortuna.ical4j.model.Property.setValue.

Sets the current value of the property.

Parameters
aValue:String

a string representation of the property value

Annotations
@Override
validateback to summary
public ValidationResult validate() throws ValidationException

Implements abstract net.fortuna.ical4j.model.Property.validate.

Doc from net.fortuna.ical4j.model.Property.validate.

Perform validation on a property.

Annotations
@Override
Exceptions
ValidationException:
where the property is not in a valid state