diff -r 000000000000 -r fb9019fb1bf7 src/net/fortuna/ical4j/model/Parameter.java --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/net/fortuna/ical4j/model/Parameter.java Tue Feb 10 18:12:00 2015 +0100 @@ -0,0 +1,264 @@ +/** + * 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; + +import java.net.URISyntaxException; + +import net.fortuna.ical4j.util.Strings; + +import org.apache.commons.lang.builder.EqualsBuilder; +import org.apache.commons.lang.builder.HashCodeBuilder; + +/** + * Defines an iCalendar parameter. Subclasses of this class provide additional validation and typed values for specific + * iCalendar parameters. + * + * Note that subclasses must provide a reference to the factory used to create the + * parameter to support parameter cloning (copy). If no factory is specified an + * {@link UnsupportedOperationException} will be thrown by the {@link #copy()} method. + * + * @author Ben Fortuna + * + * $Id$ [Apr 5, 2004] + */ +public abstract class Parameter extends Content { + + private static final long serialVersionUID = -2058497904769713528L; + + /** + * Region abbreviation. + */ + public static final String ABBREV = "ABBREV"; + + /** + * Alternate text representation. + */ + public static final String ALTREP = "ALTREP"; + + /** + * Common name. + */ + public static final String CN = "CN"; + + /** + * Calendar user type. + */ + public static final String CUTYPE = "CUTYPE"; + + /** + * Delegator. + */ + public static final String DELEGATED_FROM = "DELEGATED-FROM"; + + /** + * Delegatee. + */ + public static final String DELEGATED_TO = "DELEGATED-TO"; + + /** + * Directory entry. + */ + public static final String DIR = "DIR"; + + /** + * Inline encoding. + */ + public static final String ENCODING = "ENCODING"; + + /** + * Format type. + */ + public static final String FMTTYPE = "FMTTYPE"; + + /** + * Free/busy time type. + */ + public static final String FBTYPE = "FBTYPE"; + + /** + * Language for text. + */ + public static final String LANGUAGE = "LANGUAGE"; + + /** + * Group or list membership. + */ + public static final String MEMBER = "MEMBER"; + + /** + * Participation status. + */ + public static final String PARTSTAT = "PARTSTAT"; + + /** + * Recurrence identifier range. + */ + public static final String RANGE = "RANGE"; + + /** + * Alarm trigger relationship. + */ + public static final String RELATED = "RELATED"; + + /** + * Relationship type. + */ + public static final String RELTYPE = "RELTYPE"; + + /** + * Participation role. + */ + public static final String ROLE = "ROLE"; + + /** + * RSVP expectation. + */ + public static final String RSVP = "RSVP"; + + /** + * Schedule agent. + */ + public static final String SCHEDULE_AGENT = "SCHEDULE-AGENT"; + + /** + * Schedule status. + */ + public static final String SCHEDULE_STATUS = "SCHEDULE-STATUS"; + + /** + * Sent by. + */ + public static final String SENT_BY = "SENT-BY"; + + /** + * Type. + */ + public static final String TYPE = "TYPE"; + + /** + * Reference to time zone object. + */ + public static final String TZID = "TZID"; + + /** + * Property value data type. + */ + public static final String VALUE = "VALUE"; + + /** + * Reference to vvenue component. + */ + public static final String VVENUE = "VVENUE"; + + /** + * Prefix to all experimental parameters. + */ + public static final String EXPERIMENTAL_PREFIX = "X-"; + + private String name; + + private final ParameterFactory factory; + + /** + * @param aName the parameter identifier + * @param factory the factory used to create the parameter + */ + public Parameter(final String aName, ParameterFactory factory) { + this.name = aName; + this.factory = factory; + } + + /** + * {@inheritDoc} + */ + public final String toString() { + final StringBuffer b = new StringBuffer(); + b.append(getName()); + b.append('='); + if (isQuotable()) { + b.append(Strings.quote(Strings.valueOf(getValue()))); + } + else { + b.append(Strings.valueOf(getValue())); + } + return b.toString(); + } + + /** + * Indicates whether the current parameter value should be quoted. + * @return true if the value should be quoted, otherwise false + */ + protected boolean isQuotable() { + return Strings.PARAM_QUOTE_PATTERN.matcher(Strings.valueOf(getValue())) + .find(); + } + + /** + * @return Returns the name. + */ + public final String getName() { + return name; + } + + /** + * {@inheritDoc} + */ + public final boolean equals(final Object arg0) { + if (arg0 instanceof Parameter) { + final Parameter p = (Parameter) arg0; + return new EqualsBuilder().append(getName(), p.getName()) + .append(getValue(), p.getValue()).isEquals(); + } + return super.equals(arg0); + } + + /** + * {@inheritDoc} + */ + public final int hashCode() { + // as parameter name is case-insensitive generate hash for uppercase.. + return new HashCodeBuilder().append(getName().toUpperCase()).append( + getValue()).toHashCode(); + } + + /** + * Deep copy of parameter. + * @return new parameter + * @throws URISyntaxException where an invalid URI is encountered + */ + public Parameter copy() throws URISyntaxException { + if (factory == null) { + throw new UnsupportedOperationException("No factory specified"); + } + return factory.createParameter(getName(), getValue()); + } +}