1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/src/net/fortuna/ical4j/model/property/Summary.java Tue Feb 10 18:12:00 2015 +0100
1.3 @@ -0,0 +1,158 @@
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.Escapable;
1.38 +import net.fortuna.ical4j.model.Parameter;
1.39 +import net.fortuna.ical4j.model.ParameterList;
1.40 +import net.fortuna.ical4j.model.Property;
1.41 +import net.fortuna.ical4j.model.PropertyFactoryImpl;
1.42 +import net.fortuna.ical4j.model.ValidationException;
1.43 +import net.fortuna.ical4j.util.ParameterValidator;
1.44 +
1.45 +/**
1.46 + * $Id$
1.47 + *
1.48 + * Created: [Apr 6, 2004]
1.49 + *
1.50 + * Defines a SUMMARY iCalendar component property.
1.51 + *
1.52 + * <pre>
1.53 + * 4.8.1.12 Summary
1.54 + *
1.55 + * Property Name: SUMMARY
1.56 + *
1.57 + * Purpose: This property defines a short summary or subject for the
1.58 + * calendar component.
1.59 + *
1.60 + * Value Type: TEXT
1.61 + *
1.62 + * Property Parameters: Non-standard, alternate text representation and
1.63 + * language property parameters can be specified on this property.
1.64 + *
1.65 + * Conformance: The property can be specified in "VEVENT", "VTODO",
1.66 + * "VJOURNAL" or "VALARM" calendar components.
1.67 + *
1.68 + * Description: This property is used in the "VEVENT", "VTODO" and
1.69 + * "VJOURNAL" calendar components to capture a short, one line summary
1.70 + * about the activity or journal entry.
1.71 + *
1.72 + * This property is used in the "VALARM" calendar component to capture
1.73 + * the subject of an EMAIL category of alarm.
1.74 + *
1.75 + * Format Definition: The property is defined by the following notation:
1.76 + *
1.77 + * summary = "SUMMARY" summparam ":" text CRLF
1.78 + *
1.79 + * summparam = *(
1.80 + *
1.81 + * ; the following are optional,
1.82 + * ; but MUST NOT occur more than once
1.83 + *
1.84 + * (";" altrepparam) / (";" languageparam) /
1.85 + *
1.86 + * ; the following is optional,
1.87 + * ; and MAY occur more than once
1.88 + *
1.89 + * (";" xparam)
1.90 + *
1.91 + * )
1.92 + *
1.93 + * Example: The following is an example of this property:
1.94 + *
1.95 + * SUMMARY:Department Party
1.96 + * </pre>
1.97 + *
1.98 + * @author Ben Fortuna
1.99 + */
1.100 +public class Summary extends Property implements Escapable {
1.101 +
1.102 + private static final long serialVersionUID = 7709437653910363024L;
1.103 +
1.104 + private String value;
1.105 +
1.106 + /**
1.107 + * Default constructor.
1.108 + */
1.109 + public Summary() {
1.110 + super(SUMMARY, PropertyFactoryImpl.getInstance());
1.111 + }
1.112 +
1.113 + /**
1.114 + * @param aValue a value string for this component
1.115 + */
1.116 + public Summary(final String aValue) {
1.117 + super(SUMMARY, PropertyFactoryImpl.getInstance());
1.118 + setValue(aValue);
1.119 + }
1.120 +
1.121 + /**
1.122 + * @param aList a list of parameters for this component
1.123 + * @param aValue a value string for this component
1.124 + */
1.125 + public Summary(final ParameterList aList, final String aValue) {
1.126 + super(SUMMARY, aList, PropertyFactoryImpl.getInstance());
1.127 + setValue(aValue);
1.128 + }
1.129 +
1.130 + /**
1.131 + * {@inheritDoc}
1.132 + */
1.133 + public final void validate() throws ValidationException {
1.134 +
1.135 + /*
1.136 + * ; the following are optional, ; but MUST NOT occur more than once (";" altrepparam) / (";" languageparam) /
1.137 + */
1.138 + ParameterValidator.getInstance().assertOneOrLess(Parameter.ALTREP,
1.139 + getParameters());
1.140 + ParameterValidator.getInstance().assertOneOrLess(Parameter.LANGUAGE,
1.141 + getParameters());
1.142 +
1.143 + /*
1.144 + * ; the following is optional, ; and MAY occur more than once (";" xparam)
1.145 + */
1.146 + }
1.147 +
1.148 + /**
1.149 + * {@inheritDoc}
1.150 + */
1.151 + public final void setValue(final String aValue) {
1.152 + this.value = aValue;
1.153 + }
1.154 +
1.155 + /**
1.156 + * {@inheritDoc}
1.157 + */
1.158 + public final String getValue() {
1.159 + return value;
1.160 + }
1.161 +}
