1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/src/net/fortuna/ical4j/model/property/Transp.java Tue Feb 10 18:12:00 2015 +0100
1.3 @@ -0,0 +1,171 @@
1.4 +/**
1.5 + * Copyright (c) 2012, Ben Fortuna
1.6 + * All rights reserved.
1.7 + *
1.8 + * Redistribution and use in source and binary forms, with or without
1.9 + * modification, are permitted provided that the following conditions
1.10 + * are met:
1.11 + *
1.12 + * o Redistributions of source code must retain the above copyright
1.13 + * notice, this list of conditions and the following disclaimer.
1.14 + *
1.15 + * o Redistributions in binary form must reproduce the above copyright
1.16 + * notice, this list of conditions and the following disclaimer in the
1.17 + * documentation and/or other materials provided with the distribution.
1.18 + *
1.19 + * o Neither the name of Ben Fortuna nor the names of any other contributors
1.20 + * may be used to endorse or promote products derived from this software
1.21 + * without specific prior written permission.
1.22 + *
1.23 + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
1.24 + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
1.25 + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
1.26 + * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
1.27 + * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
1.28 + * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
1.29 + * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
1.30 + * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
1.31 + * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
1.32 + * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
1.33 + * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
1.34 + */
1.35 +package net.fortuna.ical4j.model.property;
1.36 +
1.37 +import net.fortuna.ical4j.model.ParameterList;
1.38 +import net.fortuna.ical4j.model.Property;
1.39 +import net.fortuna.ical4j.model.PropertyFactoryImpl;
1.40 +import net.fortuna.ical4j.model.ValidationException;
1.41 +
1.42 +/**
1.43 + * $Id$
1.44 + *
1.45 + * Created: [Apr 6, 2004]
1.46 + *
1.47 + * Defines a TRANSP iCalendar component property.
1.48 + *
1.49 + * <pre>
1.50 + * 4.8.2.7 Time Transparency
1.51 + *
1.52 + * Property Name: TRANSP
1.53 + *
1.54 + * Purpose: This property defines whether an event is transparent or not
1.55 + * to busy time searches.
1.56 + *
1.57 + * Value Type: TEXT
1.58 + *
1.59 + * Property Parameters: Non-standard property parameters can be
1.60 + * specified on this property.
1.61 + *
1.62 + * Conformance: This property can be specified once in a "VEVENT"
1.63 + * calendar component.
1.64 + *
1.65 + * Description: Time Transparency is the characteristic of an event that
1.66 + * determines whether it appears to consume time on a calendar. Events
1.67 + * that consume actual time for the individual or resource associated
1.68 + * with the calendar SHOULD be recorded as OPAQUE, allowing them to be
1.69 + * detected by free-busy time searches. Other events, which do not take
1.70 + * up the individual's (or resource's) time SHOULD be recorded as
1.71 + * TRANSPARENT, making them invisible to free-busy time searches.
1.72 + *
1.73 + * Format Definition: The property is specified by the following
1.74 + * notation:
1.75 + *
1.76 + * transp = "TRANSP" tranparam ":" transvalue CRLF
1.77 + *
1.78 + * tranparam = *(";" xparam)
1.79 + *
1.80 + * transvalue = "OPAQUE" ;Blocks or opaque on busy time searches.
1.81 + * / "TRANSPARENT" ;Transparent on busy time searches.
1.82 + * ;Default value is OPAQUE
1.83 + *
1.84 + * Example: The following is an example of this property for an event
1.85 + * that is transparent or does not block on free/busy time searches:
1.86 + *
1.87 + * TRANSP:TRANSPARENT
1.88 + *
1.89 + * The following is an example of this property for an event that is
1.90 + * opaque or blocks on free/busy time searches:
1.91 + *
1.92 + * TRANSP:OPAQUE
1.93 + * </pre>
1.94 + *
1.95 + * @author Ben Fortuna
1.96 + */
1.97 +public class Transp extends Property {
1.98 +
1.99 + private static final long serialVersionUID = 3801479657311785518L;
1.100 +
1.101 + /**
1.102 + * Opaque.
1.103 + */
1.104 + public static final Transp OPAQUE = new ImmutableTransp("OPAQUE");
1.105 +
1.106 + /**
1.107 + * Transparent.
1.108 + */
1.109 + public static final Transp TRANSPARENT = new ImmutableTransp("TRANSPARENT");
1.110 +
1.111 + /**
1.112 + * @author Ben Fortuna An immutable instance of Transp.
1.113 + */
1.114 + private static final class ImmutableTransp extends Transp {
1.115 +
1.116 + private static final long serialVersionUID = -6595830107310111996L;
1.117 +
1.118 + private ImmutableTransp(final String value) {
1.119 + super(new ParameterList(true), value);
1.120 + }
1.121 +
1.122 + public void setValue(final String aValue) {
1.123 + throw new UnsupportedOperationException(
1.124 + "Cannot modify constant instances");
1.125 + }
1.126 + }
1.127 +
1.128 + private String value;
1.129 +
1.130 + /**
1.131 + * Default constructor.
1.132 + */
1.133 + public Transp() {
1.134 + super(TRANSP, PropertyFactoryImpl.getInstance());
1.135 + }
1.136 +
1.137 + /**
1.138 + * @param aValue a value string for this component
1.139 + */
1.140 + public Transp(final String aValue) {
1.141 + super(TRANSP, PropertyFactoryImpl.getInstance());
1.142 + this.value = aValue;
1.143 + }
1.144 +
1.145 + /**
1.146 + * @param aList a list of parameters for this component
1.147 + * @param aValue a value string for this component
1.148 + */
1.149 + public Transp(final ParameterList aList, final String aValue) {
1.150 + super(TRANSP, aList, PropertyFactoryImpl.getInstance());
1.151 + this.value = aValue;
1.152 + }
1.153 +
1.154 + /**
1.155 + * {@inheritDoc}
1.156 + */
1.157 + public void setValue(final String aValue) {
1.158 + this.value = aValue;
1.159 + }
1.160 +
1.161 + /**
1.162 + * {@inheritDoc}
1.163 + */
1.164 + public final String getValue() {
1.165 + return value;
1.166 + }
1.167 +
1.168 + /**
1.169 + * {@inheritDoc}
1.170 + */
1.171 + public final void validate() throws ValidationException {
1.172 + // TODO: Auto-generated method stub
1.173 + }
1.174 +}
