Caldavsync Sources / file revision
src/net/fortuna/ical4j/model/property/Summary.java@45d57ecba757
src/net/fortuna/ical4j/model/property/Summary.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.
1 /**
2 * Copyright (c) 2012, Ben Fortuna
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * o Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 *
12 * o Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 *
16 * o Neither the name of Ben Fortuna nor the names of any other contributors
17 * may be used to endorse or promote products derived from this software
18 * without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
24 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
26 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
27 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
28 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
29 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
30 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 */
32 package net.fortuna.ical4j.model.property;
34 import net.fortuna.ical4j.model.Escapable;
35 import net.fortuna.ical4j.model.Parameter;
36 import net.fortuna.ical4j.model.ParameterList;
37 import net.fortuna.ical4j.model.Property;
38 import net.fortuna.ical4j.model.PropertyFactoryImpl;
39 import net.fortuna.ical4j.model.ValidationException;
40 import net.fortuna.ical4j.util.ParameterValidator;
42 /**
43 * $Id$
44 *
45 * Created: [Apr 6, 2004]
46 *
47 * Defines a SUMMARY iCalendar component property.
48 *
49 * <pre>
50 * 4.8.1.12 Summary
51 *
52 * Property Name: SUMMARY
53 *
54 * Purpose: This property defines a short summary or subject for the
55 * calendar component.
56 *
57 * Value Type: TEXT
58 *
59 * Property Parameters: Non-standard, alternate text representation and
60 * language property parameters can be specified on this property.
61 *
62 * Conformance: The property can be specified in "VEVENT", "VTODO",
63 * "VJOURNAL" or "VALARM" calendar components.
64 *
65 * Description: This property is used in the "VEVENT", "VTODO" and
66 * "VJOURNAL" calendar components to capture a short, one line summary
67 * about the activity or journal entry.
68 *
69 * This property is used in the "VALARM" calendar component to capture
70 * the subject of an EMAIL category of alarm.
71 *
72 * Format Definition: The property is defined by the following notation:
73 *
74 * summary = "SUMMARY" summparam ":" text CRLF
75 *
76 * summparam = *(
77 *
78 * ; the following are optional,
79 * ; but MUST NOT occur more than once
80 *
81 * (";" altrepparam) / (";" languageparam) /
82 *
83 * ; the following is optional,
84 * ; and MAY occur more than once
85 *
86 * (";" xparam)
87 *
88 * )
89 *
90 * Example: The following is an example of this property:
91 *
92 * SUMMARY:Department Party
93 * </pre>
94 *
95 * @author Ben Fortuna
96 */
97 public class Summary extends Property implements Escapable {
99 private static final long serialVersionUID = 7709437653910363024L;
101 private String value;
103 /**
104 * Default constructor.
105 */
106 public Summary() {
107 super(SUMMARY, PropertyFactoryImpl.getInstance());
108 }
110 /**
111 * @param aValue a value string for this component
112 */
113 public Summary(final String aValue) {
114 super(SUMMARY, PropertyFactoryImpl.getInstance());
115 setValue(aValue);
116 }
118 /**
119 * @param aList a list of parameters for this component
120 * @param aValue a value string for this component
121 */
122 public Summary(final ParameterList aList, final String aValue) {
123 super(SUMMARY, aList, PropertyFactoryImpl.getInstance());
124 setValue(aValue);
125 }
127 /**
128 * {@inheritDoc}
129 */
130 public final void validate() throws ValidationException {
132 /*
133 * ; the following are optional, ; but MUST NOT occur more than once (";" altrepparam) / (";" languageparam) /
134 */
135 ParameterValidator.getInstance().assertOneOrLess(Parameter.ALTREP,
136 getParameters());
137 ParameterValidator.getInstance().assertOneOrLess(Parameter.LANGUAGE,
138 getParameters());
140 /*
141 * ; the following is optional, ; and MAY occur more than once (";" xparam)
142 */
143 }
145 /**
146 * {@inheritDoc}
147 */
148 public final void setValue(final String aValue) {
149 this.value = aValue;
150 }
152 /**
153 * {@inheritDoc}
154 */
155 public final String getValue() {
156 return value;
157 }
158 }
