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 java.util.StringTokenizer; michael@0: 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 REQUEST-STATUS iCalendar component property. michael@0: * @author benf michael@0: */ michael@0: public class RequestStatus extends Property { michael@0: michael@0: private static final long serialVersionUID = -3273944031884755345L; michael@0: michael@0: /** michael@0: * Preliminary success status. michael@0: */ michael@0: public static final String PRELIM_SUCCESS = "1"; michael@0: michael@0: /** michael@0: * Success status. michael@0: */ michael@0: public static final String SUCCESS = "2"; michael@0: michael@0: /** michael@0: * Client error status. michael@0: */ michael@0: public static final String CLIENT_ERROR = "3"; michael@0: michael@0: /** michael@0: * Scheduling error status. michael@0: */ michael@0: public static final String SCHEDULING_ERROR = "4"; michael@0: michael@0: private String statusCode; michael@0: michael@0: private String description; michael@0: michael@0: private String exData; michael@0: michael@0: /** michael@0: * Default constructor. michael@0: */ michael@0: public RequestStatus() { michael@0: super(REQUEST_STATUS, PropertyFactoryImpl.getInstance()); 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 RequestStatus(final ParameterList aList, final String aValue) { michael@0: super(REQUEST_STATUS, aList, PropertyFactoryImpl.getInstance()); michael@0: setValue(aValue); michael@0: } michael@0: michael@0: /** michael@0: * @param aStatusCode a string representation of a status code michael@0: * @param aDescription a description michael@0: * @param data a string representation of extension data michael@0: */ michael@0: public RequestStatus(final String aStatusCode, final String aDescription, michael@0: final String data) { michael@0: super(REQUEST_STATUS, PropertyFactoryImpl.getInstance()); michael@0: statusCode = aStatusCode; michael@0: description = aDescription; michael@0: exData = data; michael@0: } michael@0: michael@0: /** michael@0: * @param aList a list of parameters for this component michael@0: * @param aStatusCode a string representation of a status code michael@0: * @param aDescription a description michael@0: * @param data a string representation of extension data michael@0: */ michael@0: public RequestStatus(final ParameterList aList, final String aStatusCode, michael@0: final String aDescription, final String data) { michael@0: super(REQUEST_STATUS, aList, PropertyFactoryImpl.getInstance()); michael@0: statusCode = aStatusCode; michael@0: description = aDescription; michael@0: exData = data; 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 is optional, ; but MUST NOT occur more than once (";" languageparm) / michael@0: */ 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: * @return Returns the description. michael@0: */ michael@0: public final String getDescription() { michael@0: return description; michael@0: } michael@0: michael@0: /** michael@0: * @return Returns the exData. michael@0: */ michael@0: public final String getExData() { michael@0: return exData; michael@0: } michael@0: michael@0: /** michael@0: * @return Returns the statusCode. michael@0: */ michael@0: public final String getStatusCode() { michael@0: return statusCode; michael@0: } michael@0: michael@0: /** michael@0: * {@inheritDoc} michael@0: */ michael@0: public final void setValue(final String aValue) { michael@0: final StringTokenizer t = new StringTokenizer(aValue, ";"); michael@0: michael@0: if (t.hasMoreTokens()) { michael@0: statusCode = t.nextToken(); michael@0: } michael@0: michael@0: if (t.hasMoreTokens()) { michael@0: description = t.nextToken(); michael@0: } michael@0: michael@0: if (t.hasMoreTokens()) { michael@0: exData = t.nextToken(); michael@0: } michael@0: } michael@0: michael@0: /** michael@0: * {@inheritDoc} michael@0: */ michael@0: public final String getValue() { michael@0: final StringBuffer b = new StringBuffer(); michael@0: michael@0: if ((getStatusCode() != null)) { michael@0: b.append(getStatusCode()); michael@0: } michael@0: michael@0: if ((getDescription() != null)) { michael@0: b.append(';'); michael@0: b.append(getDescription()); michael@0: } michael@0: michael@0: if ((getExData() != null)) { michael@0: b.append(';'); michael@0: b.append(getExData()); michael@0: } michael@0: michael@0: return b.toString(); michael@0: } michael@0: michael@0: /** michael@0: * @param description The description to set. michael@0: */ michael@0: public final void setDescription(final String description) { michael@0: this.description = description; michael@0: } michael@0: michael@0: /** michael@0: * @param exData The exData to set. michael@0: */ michael@0: public final void setExData(final String exData) { michael@0: this.exData = exData; michael@0: } michael@0: michael@0: /** michael@0: * @param statusCode The statusCode to set. michael@0: */ michael@0: public final void setStatusCode(final String statusCode) { michael@0: this.statusCode = statusCode; michael@0: } michael@0: }