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

public Class Version

extends Property
Class Inheritance
Known Direct Subclasses
net.fortuna.ical4j.model.property.immutable.ImmutableVersion
Imports
net.fortuna.ical4j.model.Content, .ParameterList, .Property, .PropertyFactory, net.fortuna.ical4j.validate.ValidationException, .ValidationResult, net.fortuna.ical4j.validate.property.CalendarPropertyValidators

$Id$

Created: [Apr 6, 2004]

Defines a VERSION iCalendar property. When creating a new calendar you should always add a version property with value "2.0". There is actually a constant defined in the ImmutableVersion class for this. e.g: Calendar calendar = new Calendar(); calendar.add(Immutable.VERSION_2_0);

Author
Ben Fortuna

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
private String
private String
private static final long
public static final String
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
Version()

Default constructor.

public
Version(final ParameterList
a list of parameters for this component
aList
,
final String
a value string for this component
aValue
)

public
Version(final String
a string representation of the minimum version
minVersion
,
final String
a string representation of the maximum version
maxVersion
)

public
Version(final ParameterList
a list of parameters for this component
aList
,
final String
a string representation of the minimum version
aVersion1
,
final String
a string representation of the maximum version
aVersion2
)

Method Summary

Modifier and TypeMethod and Description
public final String

Returns:

Returns the maxVersion.
getMaxVersion
()

public final String

Returns:

Returns the minVersion.
getMinVersion
()

public final String
protected PropertyFactory<Version>
newFactory()

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

Returns a new property factory used to create deep copies.

public void
setMaxVersion(final String
The maxVersion to set.
maxVersion
)

public void
setMinVersion(final String
The minVersion to set.
minVersion
)

public 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

maxVersionback to summary
private String maxVersion
minVersionback to summary
private String minVersion
serialVersionUIDback to summary
private static final long serialVersionUID

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

VALUE_2_0back to summary
public static final String VALUE_2_0

Constructor Detail

Versionback to summary
public Version()

Default constructor.

Versionback to summary
public Version(final ParameterList aList, final String aValue)
Parameters
aList:ParameterList

a list of parameters for this component

aValue:String

a value string for this component

Versionback to summary
public Version(final String minVersion, final String maxVersion)
Parameters
minVersion:String

a string representation of the minimum version

maxVersion:String

a string representation of the maximum version

Versionback to summary
public Version(final ParameterList aList, final String aVersion1, final String aVersion2)
Parameters
aList:ParameterList

a list of parameters for this component

aVersion1:String

a string representation of the minimum version

aVersion2:String

a string representation of the maximum version

Method Detail

getMaxVersionback to summary
public final String getMaxVersion()
Returns:String

Returns the maxVersion.

getMinVersionback to summary
public final String getMinVersion()
Returns:String

Returns the minVersion.

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<Version> 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<Version>

a property factory instance

Annotations
@Override
setMaxVersionback to summary
public void setMaxVersion(final String maxVersion)
Parameters
maxVersion:String

The maxVersion to set.

setMinVersionback to summary
public void setMinVersion(final String minVersion)
Parameters
minVersion:String

The minVersion to set.

setValueback to summary
public 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
net.fortuna.ical4j.model.property back to summary

public Class Version.Factory

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

Field Summary

Modifier and TypeField and Description
private static final long

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public Version
createProperty(final ParameterList
a list of property parameters
parameters
,
final String
a property value
value
)

Implements net.fortuna.ical4j.model.PropertyFactory.createProperty.

public Version
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

createPropertyback to summary
public Version createProperty(final ParameterList parameters, final String value)

Implements net.fortuna.ical4j.model.PropertyFactory.createProperty.

Parameters
parameters:ParameterList

Doc from net.fortuna.ical4j.model.PropertyFactory.createProperty.

a list of property parameters

value:String

Doc from net.fortuna.ical4j.model.PropertyFactory.createProperty.

a property value

Returns:Version

Doc from net.fortuna.ical4j.model.PropertyFactory.createProperty.

a new instance of the specified property

Annotations
@Override
createPropertyback to summary
public Version createProperty()

Implements net.fortuna.ical4j.model.PropertyFactory.createProperty.

Returns:Version

Doc from net.fortuna.ical4j.model.PropertyFactory.createProperty.

a new instance of the specified property

Annotations
@Override