biweekly.property

Class Classification

java.lang.Object

biweekly.property.ICalProperty

biweekly.property.ValuedProperty<String>

biweekly.property.TextProperty

biweekly.property.EnumProperty

biweekly.property.Classification

public class Classification
extends EnumProperty

Defines the level of sensitivity of the iCalendar data. If not specified, the data should be considered "public".

Code sample (creating):

 VEvent event = new VEvent();
 event.setClassification(Classification.public_());
 

Code sample (retrieving):

 ICalendar ical = ...
 VEvent event = ical.getEvents().get(0);
 
 Classification classification = event.getClassification();
 if (classification.isPublic()) {
         ...
 } else if (classification.isPrivate()){
   ...
 } else if (classification.isConfidential()){
   ...
 }
 

Author:

Michael Angstadt

See Also:

RFC 5545 p.82-3, RFC 2445 p.79-80, vCal 1.0 p.28-9

Field Summary

Fields inherited from class biweekly.property.ValuedProperty

value

Fields inherited from class biweekly.property.ICalProperty

parameters

Constructor Summary

Constructors

Constructor and Description
Classification(String classification) Creates a new classification property.

Method Summary

Methods

Modifier and Type	Method and Description
static Classification	confidential() Creates a "confidential" classification property.
protected Collection<String>	getStandardValues(ICalVersion version) Gets the list of acceptable values for this property.
boolean	isConfidential() Determines if the classification level is "confidential".
boolean	isPrivate() Determines if the classification level is "private".
boolean	isPublic() Determines if the classification level is "public".
static Classification	private_() Creates a "private" classification property.
static Classification	public_() Creates a "public" classification property.

Methods inherited from class biweekly.property.EnumProperty

getValueSupportedVersions, is, validate

Methods inherited from class biweekly.property.ValuedProperty

getValue, getValue, setValue

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

Constructor Detail

Classification

public Classification(String classification)

Creates a new classification property. Use the static factory methods to create a property with a standard classification level.

Parameters:

classification - the classification level (e.g. "PUBLIC")

Method Detail

public_

public static Classification public_()

Creates a "public" classification property.

Returns:

the property

isPublic

public boolean isPublic()

Determines if the classification level is "public".

Returns:

true if it's "public", false if not

private_

public static Classification private_()

Creates a "private" classification property.

Returns:

the property

isPrivate

public boolean isPrivate()

Determines if the classification level is "private".

Returns:

true if it's "private", false if not

confidential

public static Classification confidential()

Creates a "confidential" classification property.

Returns:

the property

isConfidential

public boolean isConfidential()

Determines if the classification level is "confidential".

Returns:

true if it's "confidential", false if not

getStandardValues

protected Collection<String> getStandardValues(ICalVersion version)

Description copied from class: EnumProperty

Gets the list of acceptable values for this property.

Specified by:

getStandardValues in class EnumProperty

Parameters:

version - the version

Returns:

the list of acceptable values