Caldavsync Sources / annotate

src/net/fortuna/ical4j/model/property/Summary.java@fb9019fb1bf7 (annotated)

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

Tue, 10 Feb 2015 18:12:00 +0100

author
Michael Schloh von Bennewitz <michael@schloh.com>
date
Tue, 10 Feb 2015 18:12:00 +0100
changeset 0
fb9019fb1bf7
permissions
-rw-r--r--

Import initial revisions of existing project AndroidCaldavSyncAdapater,
forked from upstream repository at 27e8a0f8495c92e0780d450bdf0c7cec77a03a55.

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.Escapable;
michael@0 35 import net.fortuna.ical4j.model.Parameter;
michael@0 36 import net.fortuna.ical4j.model.ParameterList;
michael@0 37 import net.fortuna.ical4j.model.Property;
michael@0 38 import net.fortuna.ical4j.model.PropertyFactoryImpl;
michael@0 39 import net.fortuna.ical4j.model.ValidationException;
michael@0 40 import net.fortuna.ical4j.util.ParameterValidator;
michael@0 41
michael@0 42 /**
michael@0 43 * $Id$
michael@0 44 *
michael@0 45 * Created: [Apr 6, 2004]
michael@0 46 *
michael@0 47 * Defines a SUMMARY iCalendar component property.
michael@0 48 *
michael@0 49 * <pre>
michael@0 50 * 4.8.1.12 Summary
michael@0 51 *
michael@0 52 * Property Name: SUMMARY
michael@0 53 *
michael@0 54 * Purpose: This property defines a short summary or subject for the
michael@0 55 * calendar component.
michael@0 56 *
michael@0 57 * Value Type: TEXT
michael@0 58 *
michael@0 59 * Property Parameters: Non-standard, alternate text representation and
michael@0 60 * language property parameters can be specified on this property.
michael@0 61 *
michael@0 62 * Conformance: The property can be specified in &quot;VEVENT&quot;, &quot;VTODO&quot;,
michael@0 63 * &quot;VJOURNAL&quot; or &quot;VALARM&quot; calendar components.
michael@0 64 *
michael@0 65 * Description: This property is used in the &quot;VEVENT&quot;, &quot;VTODO&quot; and
michael@0 66 * &quot;VJOURNAL&quot; calendar components to capture a short, one line summary
michael@0 67 * about the activity or journal entry.
michael@0 68 *
michael@0 69 * This property is used in the &quot;VALARM&quot; calendar component to capture
michael@0 70 * the subject of an EMAIL category of alarm.
michael@0 71 *
michael@0 72 * Format Definition: The property is defined by the following notation:
michael@0 73 *
michael@0 74 * summary = &quot;SUMMARY&quot; summparam &quot;:&quot; text CRLF
michael@0 75 *
michael@0 76 * summparam = *(
michael@0 77 *
michael@0 78 * ; the following are optional,
michael@0 79 * ; but MUST NOT occur more than once
michael@0 80 *
michael@0 81 * (&quot;;&quot; altrepparam) / (&quot;;&quot; languageparam) /
michael@0 82 *
michael@0 83 * ; the following is optional,
michael@0 84 * ; and MAY occur more than once
michael@0 85 *
michael@0 86 * (&quot;;&quot; xparam)
michael@0 87 *
michael@0 88 * )
michael@0 89 *
michael@0 90 * Example: The following is an example of this property:
michael@0 91 *
michael@0 92 * SUMMARY:Department Party
michael@0 93 * </pre>
michael@0 94 *
michael@0 95 * @author Ben Fortuna
michael@0 96 */
michael@0 97 public class Summary extends Property implements Escapable {
michael@0 98
michael@0 99 private static final long serialVersionUID = 7709437653910363024L;
michael@0 100
michael@0 101 private String value;
michael@0 102
michael@0 103 /**
michael@0 104 * Default constructor.
michael@0 105 */
michael@0 106 public Summary() {
michael@0 107 super(SUMMARY, PropertyFactoryImpl.getInstance());
michael@0 108 }
michael@0 109
michael@0 110 /**
michael@0 111 * @param aValue a value string for this component
michael@0 112 */
michael@0 113 public Summary(final String aValue) {
michael@0 114 super(SUMMARY, PropertyFactoryImpl.getInstance());
michael@0 115 setValue(aValue);
michael@0 116 }
michael@0 117
michael@0 118 /**
michael@0 119 * @param aList a list of parameters for this component
michael@0 120 * @param aValue a value string for this component
michael@0 121 */
michael@0 122 public Summary(final ParameterList aList, final String aValue) {
michael@0 123 super(SUMMARY, aList, PropertyFactoryImpl.getInstance());
michael@0 124 setValue(aValue);
michael@0 125 }
michael@0 126
michael@0 127 /**
michael@0 128 * {@inheritDoc}
michael@0 129 */
michael@0 130 public final void validate() throws ValidationException {
michael@0 131
michael@0 132 /*
michael@0 133 * ; the following are optional, ; but MUST NOT occur more than once (";" altrepparam) / (";" languageparam) /
michael@0 134 */
michael@0 135 ParameterValidator.getInstance().assertOneOrLess(Parameter.ALTREP,
michael@0 136 getParameters());
michael@0 137 ParameterValidator.getInstance().assertOneOrLess(Parameter.LANGUAGE,
michael@0 138 getParameters());
michael@0 139
michael@0 140 /*
michael@0 141 * ; the following is optional, ; and MAY occur more than once (";" xparam)
michael@0 142 */
michael@0 143 }
michael@0 144
michael@0 145 /**
michael@0 146 * {@inheritDoc}
michael@0 147 */
michael@0 148 public final void setValue(final String aValue) {
michael@0 149 this.value = aValue;
michael@0 150 }
michael@0 151
michael@0 152 /**
michael@0 153 * {@inheritDoc}
michael@0 154 */
michael@0 155 public final String getValue() {
michael@0 156 return value;
michael@0 157 }
michael@0 158 }

Mercurial Repository: Caldavsync Sources

Europalab SCM Repository Server

mercurial