• file
• revisions
• annotate
• diff
• comparison
• raw

src/net/fortuna/ical4j/model/property/Transp.java@45d57ecba757 (annotated)

src/net/fortuna/ical4j/model/property/Transp.java

Tue, 10 Feb 2015 19:58:00 +0100

author

Michael Schloh von Bennewitz <michael@schloh.com>

date

Tue, 10 Feb 2015 19:58:00 +0100

changeset 4

45d57ecba757

permissions

-rw-r--r--

Upgrade the upgraded ical4j component to use org.apache.commons.lang3.

michael@0	1	/**
michael@0	2	* Copyright (c) 2012, Ben Fortuna
michael@0	3	* All rights reserved.
michael@0	4	*
michael@0	5	* Redistribution and use in source and binary forms, with or without
michael@0	6	* modification, are permitted provided that the following conditions
michael@0	7	* are met:
michael@0	8	*
michael@0	9	* o Redistributions of source code must retain the above copyright
michael@0	10	* notice, this list of conditions and the following disclaimer.
michael@0	11	*
michael@0	12	* o Redistributions in binary form must reproduce the above copyright
michael@0	13	* notice, this list of conditions and the following disclaimer in the
michael@0	14	* documentation and/or other materials provided with the distribution.
michael@0	15	*
michael@0	16	* o Neither the name of Ben Fortuna nor the names of any other contributors
michael@0	17	* may be used to endorse or promote products derived from this software
michael@0	18	* without specific prior written permission.
michael@0	19	*
michael@0	20	* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
michael@0	21	* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
michael@0	22	* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
michael@0	23	* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
michael@0	24	* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
michael@0	25	* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
michael@0	26	* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
michael@0	27	* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
michael@0	28	* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
michael@0	29	* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
michael@0	30	* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
michael@0	31	*/
michael@0	32	package net.fortuna.ical4j.model.property;
michael@0	33
michael@0	34	import net.fortuna.ical4j.model.ParameterList;
michael@0	35	import net.fortuna.ical4j.model.Property;
michael@0	36	import net.fortuna.ical4j.model.PropertyFactoryImpl;
michael@0	37	import net.fortuna.ical4j.model.ValidationException;
michael@0	38
michael@0	39	/**
michael@0	40	* $Id$
michael@0	41	*
michael@0	42	* Created: [Apr 6, 2004]
michael@0	43	*
michael@0	44	* Defines a TRANSP iCalendar component property.
michael@0	45	*
michael@0	46	* <pre>
michael@0	47	* 4.8.2.7 Time Transparency
michael@0	48	*
michael@0	49	* Property Name: TRANSP
michael@0	50	*
michael@0	51	* Purpose: This property defines whether an event is transparent or not
michael@0	52	* to busy time searches.
michael@0	53	*
michael@0	54	* Value Type: TEXT
michael@0	55	*
michael@0	56	* Property Parameters: Non-standard property parameters can be
michael@0	57	* specified on this property.
michael@0	58	*
michael@0	59	* Conformance: This property can be specified once in a &quot;VEVENT&quot;
michael@0	60	* calendar component.
michael@0	61	*
michael@0	62	* Description: Time Transparency is the characteristic of an event that
michael@0	63	* determines whether it appears to consume time on a calendar. Events
michael@0	64	* that consume actual time for the individual or resource associated
michael@0	65	* with the calendar SHOULD be recorded as OPAQUE, allowing them to be
michael@0	66	* detected by free-busy time searches. Other events, which do not take
michael@0	67	* up the individual's (or resource's) time SHOULD be recorded as
michael@0	68	* TRANSPARENT, making them invisible to free-busy time searches.
michael@0	69	*
michael@0	70	* Format Definition: The property is specified by the following
michael@0	71	* notation:
michael@0	72	*
michael@0	73	* transp = &quot;TRANSP&quot; tranparam &quot;:&quot; transvalue CRLF
michael@0	74	*
michael@0	75	* tranparam = *(&quot;;&quot; xparam)
michael@0	76	*
michael@0	77	* transvalue = &quot;OPAQUE&quot; ;Blocks or opaque on busy time searches.
michael@0	78	* / &quot;TRANSPARENT&quot; ;Transparent on busy time searches.
michael@0	79	* ;Default value is OPAQUE
michael@0	80	*
michael@0	81	* Example: The following is an example of this property for an event
michael@0	82	* that is transparent or does not block on free/busy time searches:
michael@0	83	*
michael@0	84	* TRANSP:TRANSPARENT
michael@0	85	*
michael@0	86	* The following is an example of this property for an event that is
michael@0	87	* opaque or blocks on free/busy time searches:
michael@0	88	*
michael@0	89	* TRANSP:OPAQUE
michael@0	90	* </pre>
michael@0	91	*
michael@0	92	* @author Ben Fortuna
michael@0	93	*/
michael@0	94	public class Transp extends Property {
michael@0	95
michael@0	96	private static final long serialVersionUID = 3801479657311785518L;
michael@0	97
michael@0	98	/**
michael@0	99	* Opaque.
michael@0	100	*/
michael@0	101	public static final Transp OPAQUE = new ImmutableTransp("OPAQUE");
michael@0	102
michael@0	103	/**
michael@0	104	* Transparent.
michael@0	105	*/
michael@0	106	public static final Transp TRANSPARENT = new ImmutableTransp("TRANSPARENT");
michael@0	107
michael@0	108	/**
michael@0	109	* @author Ben Fortuna An immutable instance of Transp.
michael@0	110	*/
michael@0	111	private static final class ImmutableTransp extends Transp {
michael@0	112
michael@0	113	private static final long serialVersionUID = -6595830107310111996L;
michael@0	114
michael@0	115	private ImmutableTransp(final String value) {
michael@0	116	super(new ParameterList(true), value);
michael@0	117	}
michael@0	118
michael@0	119	public void setValue(final String aValue) {
michael@0	120	throw new UnsupportedOperationException(
michael@0	121	"Cannot modify constant instances");
michael@0	122	}
michael@0	123	}
michael@0	124
michael@0	125	private String value;
michael@0	126
michael@0	127	/**
michael@0	128	* Default constructor.
michael@0	129	*/
michael@0	130	public Transp() {
michael@0	131	super(TRANSP, PropertyFactoryImpl.getInstance());
michael@0	132	}
michael@0	133
michael@0	134	/**
michael@0	135	* @param aValue a value string for this component
michael@0	136	*/
michael@0	137	public Transp(final String aValue) {
michael@0	138	super(TRANSP, PropertyFactoryImpl.getInstance());
michael@0	139	this.value = aValue;
michael@0	140	}
michael@0	141
michael@0	142	/**
michael@0	143	* @param aList a list of parameters for this component
michael@0	144	* @param aValue a value string for this component
michael@0	145	*/
michael@0	146	public Transp(final ParameterList aList, final String aValue) {
michael@0	147	super(TRANSP, aList, PropertyFactoryImpl.getInstance());
michael@0	148	this.value = aValue;
michael@0	149	}
michael@0	150
michael@0	151	/**
michael@0	152	* {@inheritDoc}
michael@0	153	*/
michael@0	154	public void setValue(final String aValue) {
michael@0	155	this.value = aValue;
michael@0	156	}
michael@0	157
michael@0	158	/**
michael@0	159	* {@inheritDoc}
michael@0	160	*/
michael@0	161	public final String getValue() {
michael@0	162	return value;
michael@0	163	}
michael@0	164
michael@0	165	/**
michael@0	166	* {@inheritDoc}
michael@0	167	*/
michael@0	168	public final void validate() throws ValidationException {
michael@0	169	// TODO: Auto-generated method stub
michael@0	170	}
michael@0	171	}