Package net.fortuna.ical4j.model.property

Class Transp

java.lang.Object

net.fortuna.ical4j.model.Content

net.fortuna.ical4j.model.Property

net.fortuna.ical4j.model.property.Transp

All Implemented Interfaces:

Serializable, Comparable<Property>, FluentProperty

public class Transp
extends Property

$Id$

Created: [Apr 6, 2004]

Defines a TRANSP iCalendar component property.

     4.8.2.7 Time Transparency

        Property Name: TRANSP

        Purpose: This property defines whether an event is transparent or not
        to busy time searches.

        Value Type: TEXT

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

        Conformance: This property can be specified once in a "VEVENT"
        calendar component.

        Description: Time Transparency is the characteristic of an event that
        determines whether it appears to consume time on a calendar. Events
        that consume actual time for the individual or resource associated
        with the calendar SHOULD be recorded as OPAQUE, allowing them to be
        detected by free-busy time searches. Other events, which do not take
        up the individual's (or resource's) time SHOULD be recorded as
        TRANSPARENT, making them invisible to free-busy time searches.

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

          transp     = "TRANSP" tranparam ":" transvalue CRLF

          tranparam  = *(";" xparam)

          transvalue = "OPAQUE"      ;Blocks or opaque on busy time searches.
                     / "TRANSPARENT" ;Transparent on busy time searches.
             ;Default value is OPAQUE

        Example: The following is an example of this property for an event
        that is transparent or does not block on free/busy time searches:

          TRANSP:TRANSPARENT

        The following is an example of this property for an event that is
        opaque or blocks on free/busy time searches:

          TRANSP:OPAQUE
 

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Transp.Factory

Field Summary

Fields

Modifier and Type	Field	Description
static final Transp	OPAQUE	Opaque.
static final Transp	TRANSPARENT	Transparent.
static final String	VALUE_OPAQUE
static final String	VALUE_TRANSPARENT

Fields inherited from class net.fortuna.ical4j.model.Property

ACKNOWLEDGED, ACTION, ATTACH, ATTENDEE, BUSYTYPE, CALENDAR_ADDRESS, CALSCALE, CATEGORIES, CLASS, COMMENT, COMPLETED, CONTACT, COUNTRY, CREATED, DESCRIPTION, DTEND, DTSTAMP, DTSTART, DUE, DURATION, EXDATE, EXPERIMENTAL_PREFIX, EXRULE, EXTENDED_ADDRESS, FREEBUSY, GEO, LAST_MODIFIED, LOCALITY, LOCATION, LOCATION_TYPE, METHOD, NAME, ORGANIZER, PARTICIPANT_TYPE, PERCENT_COMPLETE, POSTALCODE, PRIORITY, PRODID, PROXIMITY, RDATE, RECURRENCE_ID, REGION, RELATED_TO, REPEAT, REQUEST_STATUS, RESOURCE_TYPE, RESOURCES, RRULE, SEQUENCE, STATUS, STREET_ADDRESS, STRUCTURED_DATA, STYLED_DESCRIPTION, SUMMARY, TEL, TRANSP, TRIGGER, TZID, TZID_ALIAS_OF, TZNAME, TZOFFSETFROM, TZOFFSETTO, TZUNTIL, TZURL, UID, URL, VERSION, XML

Constructor Summary

Constructors

Constructor	Description
Transp()	Default constructor.
Transp(String aValue)
Transp(ParameterList aList, String aValue)

Method Summary

Modifier and Type	Method	Description
final String	getValue()
void	setValue(String aValue)	Sets the current value of the property.
ValidationResult	validate()	Perform validation on a property.

Methods inherited from class net.fortuna.ical4j.model.Property

compareTo, copy, equals, getFluentTarget, getName, getParameter, getParameters, getParameters, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.fortuna.ical4j.model.FluentProperty

withParameter

Field Details

VALUE_OPAQUE

public static final String VALUE_OPAQUE

See Also:

• Constant Field Values

VALUE_TRANSPARENT

public static final String VALUE_TRANSPARENT

See Also:

• Constant Field Values

OPAQUE

public static final Transp OPAQUE

Opaque.

TRANSPARENT

public static final Transp TRANSPARENT

Transparent.

Constructor Details

Transp

public Transp()

Default constructor.

Transp

public Transp(String aValue)

Parameters:

aValue - a value string for this component

Transp

public Transp(ParameterList aList,
 String aValue)

Parameters:

aList - a list of parameters for this component

aValue - a value string for this component

Method Details

setValue

public void setValue(String aValue)

Sets the current value of the property.

Specified by:

setValue in class Property

Parameters:

aValue - a string representation of the property value

getValue

public final String getValue()

Specified by:

getValue in class Content

Returns:

the content value

validate

public ValidationResult validate()
                          throws ValidationException

Description copied from class: Property

Perform validation on a property.

Specified by:

validate in class Property

Throws:

ValidationException - where the property is not in a valid state