michael@0: /**
michael@0:  * Copyright (c) 2012, Ben Fortuna
michael@0:  * All rights reserved.
michael@0:  *
michael@0:  * Redistribution and use in source and binary forms, with or without
michael@0:  * modification, are permitted provided that the following conditions
michael@0:  * are met:
michael@0:  *
michael@0:  *  o Redistributions of source code must retain the above copyright
michael@0:  * notice, this list of conditions and the following disclaimer.
michael@0:  *
michael@0:  *  o Redistributions in binary form must reproduce the above copyright
michael@0:  * notice, this list of conditions and the following disclaimer in the
michael@0:  * documentation and/or other materials provided with the distribution.
michael@0:  *
michael@0:  *  o Neither the name of Ben Fortuna nor the names of any other contributors
michael@0:  * may be used to endorse or promote products derived from this software
michael@0:  * without specific prior written permission.
michael@0:  *
michael@0:  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
michael@0:  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
michael@0:  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
michael@0:  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
michael@0:  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
michael@0:  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
michael@0:  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
michael@0:  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
michael@0:  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
michael@0:  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
michael@0:  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
michael@0:  */
michael@0: package net.fortuna.ical4j.model.property;
michael@0: 
michael@0: import net.fortuna.ical4j.model.ParameterList;
michael@0: import net.fortuna.ical4j.model.Property;
michael@0: import net.fortuna.ical4j.model.PropertyFactoryImpl;
michael@0: import net.fortuna.ical4j.model.ValidationException;
michael@0: 
michael@0: /**
michael@0:  * $Id$
michael@0:  * 
michael@0:  * Created: [Apr 6, 2004]
michael@0:  *
michael@0:  * Defines a TRANSP iCalendar component property.
michael@0:  * 
michael@0:  * <pre>
michael@0:  *     4.8.2.7 Time Transparency
michael@0:  *     
michael@0:  *        Property Name: TRANSP
michael@0:  *     
michael@0:  *        Purpose: This property defines whether an event is transparent or not
michael@0:  *        to busy time searches.
michael@0:  *     
michael@0:  *        Value Type: TEXT
michael@0:  *     
michael@0:  *        Property Parameters: Non-standard property parameters can be
michael@0:  *        specified on this property.
michael@0:  *     
michael@0:  *        Conformance: This property can be specified once in a &quot;VEVENT&quot;
michael@0:  *        calendar component.
michael@0:  *     
michael@0:  *        Description: Time Transparency is the characteristic of an event that
michael@0:  *        determines whether it appears to consume time on a calendar. Events
michael@0:  *        that consume actual time for the individual or resource associated
michael@0:  *        with the calendar SHOULD be recorded as OPAQUE, allowing them to be
michael@0:  *        detected by free-busy time searches. Other events, which do not take
michael@0:  *        up the individual's (or resource's) time SHOULD be recorded as
michael@0:  *        TRANSPARENT, making them invisible to free-busy time searches.
michael@0:  *     
michael@0:  *        Format Definition: The property is specified by the following
michael@0:  *        notation:
michael@0:  *     
michael@0:  *          transp     = &quot;TRANSP&quot; tranparam &quot;:&quot; transvalue CRLF
michael@0:  *     
michael@0:  *          tranparam  = *(&quot;;&quot; xparam)
michael@0:  *     
michael@0:  *          transvalue = &quot;OPAQUE&quot;      ;Blocks or opaque on busy time searches.
michael@0:  *                     / &quot;TRANSPARENT&quot; ;Transparent on busy time searches.
michael@0:  *             ;Default value is OPAQUE
michael@0:  *     
michael@0:  *        Example: The following is an example of this property for an event
michael@0:  *        that is transparent or does not block on free/busy time searches:
michael@0:  *     
michael@0:  *          TRANSP:TRANSPARENT
michael@0:  *     
michael@0:  *        The following is an example of this property for an event that is
michael@0:  *        opaque or blocks on free/busy time searches:
michael@0:  *     
michael@0:  *          TRANSP:OPAQUE
michael@0:  * </pre>
michael@0:  * 
michael@0:  * @author Ben Fortuna
michael@0:  */
michael@0: public class Transp extends Property {
michael@0: 
michael@0:     private static final long serialVersionUID = 3801479657311785518L;
michael@0: 
michael@0:     /**
michael@0:      * Opaque.
michael@0:      */
michael@0:     public static final Transp OPAQUE = new ImmutableTransp("OPAQUE");
michael@0: 
michael@0:     /**
michael@0:      * Transparent.
michael@0:      */
michael@0:     public static final Transp TRANSPARENT = new ImmutableTransp("TRANSPARENT");
michael@0: 
michael@0:     /**
michael@0:      * @author Ben Fortuna An immutable instance of Transp.
michael@0:      */
michael@0:     private static final class ImmutableTransp extends Transp {
michael@0: 
michael@0:         private static final long serialVersionUID = -6595830107310111996L;
michael@0: 
michael@0:         private ImmutableTransp(final String value) {
michael@0:             super(new ParameterList(true), value);
michael@0:         }
michael@0: 
michael@0:         public void setValue(final String aValue) {
michael@0:             throw new UnsupportedOperationException(
michael@0:                     "Cannot modify constant instances");
michael@0:         }
michael@0:     }
michael@0: 
michael@0:     private String value;
michael@0: 
michael@0:     /**
michael@0:      * Default constructor.
michael@0:      */
michael@0:     public Transp() {
michael@0:         super(TRANSP, PropertyFactoryImpl.getInstance());
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * @param aValue a value string for this component
michael@0:      */
michael@0:     public Transp(final String aValue) {
michael@0:         super(TRANSP, PropertyFactoryImpl.getInstance());
michael@0:         this.value = aValue;
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * @param aList a list of parameters for this component
michael@0:      * @param aValue a value string for this component
michael@0:      */
michael@0:     public Transp(final ParameterList aList, final String aValue) {
michael@0:         super(TRANSP, aList, PropertyFactoryImpl.getInstance());
michael@0:         this.value = aValue;
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * {@inheritDoc}
michael@0:      */
michael@0:     public void setValue(final String aValue) {
michael@0:         this.value = aValue;
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * {@inheritDoc}
michael@0:      */
michael@0:     public final String getValue() {
michael@0:         return value;
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * {@inheritDoc}
michael@0:      */
michael@0:     public final void validate() throws ValidationException {
michael@0:         // TODO: Auto-generated method stub
michael@0:     }
michael@0: }