net.fortuna.ical4j.extensions.caldav.property.AlarmAgent Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ical4j-extensions Show documentation
Support for additional non-standard iCalendar objects
There is a newer version: 2.0.0-rc6
/**
 * 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.extensions.caldav.property;

import net.fortuna.ical4j.extensions.caldav.parameter.AgentId;
import net.fortuna.ical4j.model.*;
import net.fortuna.ical4j.validate.ParameterValidator;
import net.fortuna.ical4j.validate.ValidationException;

/**
 * ALARM-AGENT is a proposed (RFC draft) property for iCalendar
 *
 * @author probert
 * @see draft-daboo-valarm-extensions-04
 */
public class AlarmAgent extends Property {

    private static final long serialVersionUID = 2182103734645261668L;

    public static final String PROPERTY_NAME = "ALARM-AGENT";

    private String value;

    public static final AlarmAgent SERVER = new ImmutableAlarmAgent("SERVER");

    public static final AlarmAgent CLIENT = new ImmutableAlarmAgent("CLIENT");

    public static final AlarmAgent BOTH = new ImmutableAlarmAgent("BOTH");

    public static final AlarmAgent NONE = new ImmutableAlarmAgent("NONE");

    public AlarmAgent() {
        super(PROPERTY_NAME, PropertyFactoryImpl.getInstance());
    }

    public AlarmAgent(ParameterList aList, String value) {
        super(PROPERTY_NAME, aList, PropertyFactoryImpl.getInstance());
        setValue(value);
    }

    @Override
    public void setValue(String aValue) {
        this.value = aValue;
    }

    @Override
    public void validate() throws ValidationException {
    /*
     * ; the following is OPTIONAL,
     * ; but MUST NOT occur more than once
     */
        ParameterValidator.getInstance().assertOneOrLess(AgentId.PARAMETER_NAME,
                getParameters());
    }

    @Override
    public String getValue() {
        return value;
    }

    private static final class ImmutableAlarmAgent extends AlarmAgent {
        private static final long serialVersionUID = -2054338254L;

        private ImmutableAlarmAgent(String value) {
            super(new ParameterList(true), value);
        }

        public void setValue(String aValue) {
            throw new UnsupportedOperationException("Cannot modify constant instances");
        }
    }

    public static class Factory extends Content.Factory implements PropertyFactory {

        private static final long serialVersionUID = 2099427445505899578L;

        public AlarmAgent createProperty() {
            return new AlarmAgent();
        }

        public AlarmAgent createProperty(ParameterList parameters, String value) {
            AlarmAgent property = null;
            if (CLIENT.getValue().equals(value)) {
                property = CLIENT;
            } else {
                property = new AlarmAgent(parameters, value);
            }
            return property;
        }
    }

}