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

public Class Clazz

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

$Id$

Created: [Apr 6, 2004]

Defines a CLASS iCalendar property.

    4.8.1.3 Classification

       Property Name: CLASS

       Purpose: This property defines the access classification for a
       calendar component.

       Value Type: TEXT

       Property Parameters: Non-standard property parameters can be
       specified on this property.

       Conformance: The property can be specified once in a "VEVENT",
       "VTODO" or "VJOURNAL" calendar components.

       Description: An access classification is only one component of the
       general security system within a calendar application. It provides a
       method of capturing the scope of the access the calendar owner
       intends for information within an individual calendar entry. The
       access classification of an individual iCalendar component is useful
       when measured along with the other security components of a calendar
       system (e.g., calendar user authentication, authorization, access
       rights, access role, etc.). Hence, the semantics of the individual
       access classifications cannot be completely defined by this memo
       alone. Additionally, due to the "blind" nature of most exchange
       processes using this memo, these access classifications cannot serve
       as an enforcement statement for a system receiving an iCalendar
       object. Rather, they provide a method for capturing the intention of
       the calendar owner for the access to the calendar component.

       Format Definition: The property is defined by the following notation:

         class      = "CLASS" classparam ":" classvalue CRLF

         classparam = *(";" xparam)

         classvalue = "PUBLIC" / "PRIVATE" / "CONFIDENTIAL" / iana-token
                    / x-name
         ;Default is PUBLIC

       Example: The following is an example of this property:

         CLASS:PUBLIC
Author
Ben Fortuna

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

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

Default constructor.

public
Clazz(final String
a value string for this component
aValue
)

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

Method Summary

Modifier and TypeMethod and Description
public final String
protected PropertyFactory<Clazz>
newFactory()

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

Returns a new property factory used to create deep copies.

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

serialVersionUIDback to summary
private static final long serialVersionUID

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

valueback to summary
private String value
VALUE_CONFIDENTIALback to summary
public static final String VALUE_CONFIDENTIAL
VALUE_PRIVATEback to summary
public static final String VALUE_PRIVATE
VALUE_PUBLICback to summary
public static final String VALUE_PUBLIC

Constructor Detail

Clazzback to summary
public Clazz()

Default constructor.

Clazzback to summary
public Clazz(final String aValue)
Parameters
aValue:String

a value string for this component

Clazzback to summary
public Clazz(final ParameterList aList, final String aValue)
Parameters
aList:ParameterList

a list of parameters for this component

aValue:String

a value string for this component

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

a property factory instance

Annotations
@Override
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 Clazz.Factory

extends Factory
implements PropertyFactory<Clazz>
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 Clazz
createProperty(final ParameterList
a list of property parameters
parameters
,
final String
a property value
value
)

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

public Clazz
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 Clazz 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:Clazz

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

a new instance of the specified property

Annotations
@Override
createPropertyback to summary
public Clazz createProperty()

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

Returns:Clazz

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

a new instance of the specified property

Annotations
@Override