biweekly.property

Class Version

java.lang.Object

biweekly.property.ICalProperty

biweekly.property.Version

public class Version
extends ICalProperty

Defines the min/max iCalendar versions a consumer must support in order to successfully parse the iCalendar object.

Code sample:

 ICalendar ical = new ICalendar();
 
 //all ICalendar objects are given a VERSION property on creation
 ical.getVersion(); //"2.0"
 
 //get the default iCal version
 Version version = Version.v2_0();
 ical.setVersion(version);
 

Author:

Michael Angstadt

See Also:

RFC 5545 p.79-80, RFC 2445 p.76-7, vCal 1.0 p.24

Field Summary

Fields

Modifier and Type	Field and Description
static VersionNumber	ICAL
static VersionNumber	VCAL

Fields inherited from class biweekly.property.ICalProperty

parameters

Constructor Summary

Constructors

Constructor and Description
Version(ICalVersion version) Creates a new version property.
Version(String version) Creates a new version property.
Version(String minVersion, String maxVersion) Creates a new version property.

Method Summary

Methods

Modifier and Type	Method and Description
VersionNumber	getMaxVersion() Gets the maximum version that a consumer must support in order to successfully parse the iCalendar object.
VersionNumber	getMinVersion() Gets the minimum version that a consumer must support in order to successfully parse the iCalendar object.
boolean	isV1_0() Determines if this property is set to the older vCalendar version.
boolean	isV2_0() Determines if this property is set to the latest iCalendar version.
void	setMaxVersion(VersionNumber maxVersion) Sets the maximum version that a consumer must support in order to successfully parse the iCalendar object.
void	setMinVersion(VersionNumber minVersion) Sets the minimum version that a consumer must support in order to successfully parse the iCalendar object.
ICalVersion	toICalVersion() Converts this property's value to an ICalVersion enum.
static Version	v1_0() Creates a version property that is set to the older vCalendar version (1.0).
static Version	v2_0() Creates a version property that is set to the latest iCalendar version (2.0).
protected void	validate(List<ICalComponent> components, ICalVersion version, List<Warning> warnings) Checks the property for data consistency problems or deviations from the spec.

Methods inherited from class biweekly.property.ICalProperty

addParameter, getParameter, getParameters, getParameters, removeParameter, setParameter, setParameter, setParameters, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

VCAL

public static final VersionNumber VCAL

ICAL

public static final VersionNumber ICAL

Constructor Detail

Version

public Version(ICalVersion version)

Creates a new version property.

Parameters:

version - the version that a consumer must support in order to successfully parse the iCalendar object

Version

public Version(String version)

Creates a new version property.

Parameters:

version - the version that a consumer must support in order to successfully parse the iCalendar object

Throws:

IllegalArgumentException - if the version string is invalid

Version

public Version(String minVersion,
       String maxVersion)

Creates a new version property.

Parameters:

minVersion - the minimum version that a consumer must support in order to successfully parse the iCalendar object

maxVersion - the maximum version that a consumer must support in order to successfully parse the iCalendar object

Throws:

IllegalArgumentException - if one of the versions strings are invalid

Method Detail

v1_0

public static Version v1_0()

Creates a version property that is set to the older vCalendar version (1.0).

Returns:

the property instance

v2_0

public static Version v2_0()

Creates a version property that is set to the latest iCalendar version (2.0).

Returns:

the property instance

isV1_0

public boolean isV1_0()

Determines if this property is set to the older vCalendar version.

Returns:

true if the version is "1.0", false if not

isV2_0

public boolean isV2_0()

Determines if this property is set to the latest iCalendar version.

Returns:

true if the version is "2.0", false if not

getMinVersion

public VersionNumber getMinVersion()

Gets the minimum version that a consumer must support in order to successfully parse the iCalendar object.

Returns:

the minimum version or null if not set

setMinVersion

public void setMinVersion(VersionNumber minVersion)

Sets the minimum version that a consumer must support in order to successfully parse the iCalendar object.

Parameters:

minVersion - the minimum version or null to remove

getMaxVersion

public VersionNumber getMaxVersion()

Gets the maximum version that a consumer must support in order to successfully parse the iCalendar object.

Returns:

the maximum version or null if not set

setMaxVersion

public void setMaxVersion(VersionNumber maxVersion)

Sets the maximum version that a consumer must support in order to successfully parse the iCalendar object.

Parameters:

maxVersion - the maximum version (this field is required)

toICalVersion

public ICalVersion toICalVersion()

Converts this property's value to an ICalVersion enum.

Returns:

the ICalVersion enum or null if it couldn't be converted

validate

protected void validate(List<ICalComponent> components,
            ICalVersion version,
            List<Warning> warnings)

Description copied from class: ICalProperty

Checks the property for data consistency problems or deviations from the spec.

This method should be overridden by child classes that wish to provide validation logic. The default implementation of this method does nothing.

Overrides:

validate in class ICalProperty

Parameters:

components - the hierarchy of components that the property belongs to

version - the version to validate against

warnings - the list to add the warnings to