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".

Examples:

 //creating a new property
 Classification classification = Classification.public_();
 
 if (classification.isPublic()) {
        //its value is "PUBLIC"
 }
 

Author:

Michael Angstadt

Specification Reference:

RFC 5545 p.82-3

Field Summary

Fields inherited from class biweekly.property.ValuedProperty

value

Fields inherited from class biweekly.property.ICalProperty

parameters

Constructor Summary

Classification(String classification)
Creates a new classification property.

Method Summary

static Classification	confidential() Creates a "confidential" classification property.
protected Collection<String>	getStandardValues() 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

is, validate

Methods inherited from class biweekly.property.ValuedProperty

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()

Description copied from class: EnumProperty

Gets the list of acceptable values for this property.

Specified by:

getStandardValues in class EnumProperty

Returns:

the list of acceptable values