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