diff -r 000000000000 -r fb9019fb1bf7 src/net/fortuna/ical4j/model/property/Summary.java --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/net/fortuna/ical4j/model/property/Summary.java Tue Feb 10 18:12:00 2015 +0100 @@ -0,0 +1,158 @@ +/** + * Copyright (c) 2012, Ben Fortuna + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * o Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * o Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * + * o Neither the name of Ben Fortuna nor the names of any other contributors + * may be used to endorse or promote products derived from this software + * without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR + * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR + * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, + * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, + * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR + * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF + * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING + * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS + * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +package net.fortuna.ical4j.model.property; + +import net.fortuna.ical4j.model.Escapable; +import net.fortuna.ical4j.model.Parameter; +import net.fortuna.ical4j.model.ParameterList; +import net.fortuna.ical4j.model.Property; +import net.fortuna.ical4j.model.PropertyFactoryImpl; +import net.fortuna.ical4j.model.ValidationException; +import net.fortuna.ical4j.util.ParameterValidator; + +/** + * $Id$ + * + * Created: [Apr 6, 2004] + * + * Defines a SUMMARY iCalendar component property. + * + *
+ * 4.8.1.12 Summary + * + * Property Name: SUMMARY + * + * Purpose: This property defines a short summary or subject for the + * calendar component. + * + * Value Type: TEXT + * + * Property Parameters: Non-standard, alternate text representation and + * language property parameters can be specified on this property. + * + * Conformance: The property can be specified in "VEVENT", "VTODO", + * "VJOURNAL" or "VALARM" calendar components. + * + * Description: This property is used in the "VEVENT", "VTODO" and + * "VJOURNAL" calendar components to capture a short, one line summary + * about the activity or journal entry. + * + * This property is used in the "VALARM" calendar component to capture + * the subject of an EMAIL category of alarm. + * + * Format Definition: The property is defined by the following notation: + * + * summary = "SUMMARY" summparam ":" text CRLF + * + * summparam = *( + * + * ; the following are optional, + * ; but MUST NOT occur more than once + * + * (";" altrepparam) / (";" languageparam) / + * + * ; the following is optional, + * ; and MAY occur more than once + * + * (";" xparam) + * + * ) + * + * Example: The following is an example of this property: + * + * SUMMARY:Department Party + *+ * + * @author Ben Fortuna + */ +public class Summary extends Property implements Escapable { + + private static final long serialVersionUID = 7709437653910363024L; + + private String value; + + /** + * Default constructor. + */ + public Summary() { + super(SUMMARY, PropertyFactoryImpl.getInstance()); + } + + /** + * @param aValue a value string for this component + */ + public Summary(final String aValue) { + super(SUMMARY, PropertyFactoryImpl.getInstance()); + setValue(aValue); + } + + /** + * @param aList a list of parameters for this component + * @param aValue a value string for this component + */ + public Summary(final ParameterList aList, final String aValue) { + super(SUMMARY, aList, PropertyFactoryImpl.getInstance()); + setValue(aValue); + } + + /** + * {@inheritDoc} + */ + public final void validate() throws ValidationException { + + /* + * ; the following are optional, ; but MUST NOT occur more than once (";" altrepparam) / (";" languageparam) / + */ + ParameterValidator.getInstance().assertOneOrLess(Parameter.ALTREP, + getParameters()); + ParameterValidator.getInstance().assertOneOrLess(Parameter.LANGUAGE, + getParameters()); + + /* + * ; the following is optional, ; and MAY occur more than once (";" xparam) + */ + } + + /** + * {@inheritDoc} + */ + public final void setValue(final String aValue) { + this.value = aValue; + } + + /** + * {@inheritDoc} + */ + public final String getValue() { + return value; + } +}