Class Transp

  • All Implemented Interfaces:
    Serializable, Comparable<Property>

    public class Transp
    extends Property

    Created: [Apr 6, 2004]

    Defines a TRANSP iCalendar component property.
 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
              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:
            The following is an example of this property for an event that is
            opaque or blocks on free/busy time searches:
    See Also:
    Serialized Form
    • Field Detail

      • OPAQUE

        public static final Transp OPAQUE

        public static final Transp TRANSPARENT
    • Constructor Detail

      • Transp

        public Transp()
        Default constructor.
      • Transp

        public Transp​(String aValue)
        aValue - a value string for this component
      • Transp

        public Transp​(ParameterList aList,
                      String aValue)
        aList - a list of parameters for this component
        aValue - a value string for this component
    • Method Detail

      • setValue

        public void setValue​(String aValue)
        Sets the current value of the property.
        Specified by:
        setValue in class Property
        aValue - a string representation of the property value
      • getValue

        public final String getValue()
        Specified by:
        getValue in class Content
        the content value