src/net/fortuna/ical4j/transform/Transformer.java

changeset 0
fb9019fb1bf7
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/src/net/fortuna/ical4j/transform/Transformer.java	Tue Feb 10 18:12:00 2015 +0100
     1.3 @@ -0,0 +1,64 @@
     1.4 +/**
     1.5 + * Copyright (c) 2012, Ben Fortuna
     1.6 + * All rights reserved.
     1.7 + *
     1.8 + * Redistribution and use in source and binary forms, with or without
     1.9 + * modification, are permitted provided that the following conditions
    1.10 + * are met:
    1.11 + *
    1.12 + *  o Redistributions of source code must retain the above copyright
    1.13 + * notice, this list of conditions and the following disclaimer.
    1.14 + *
    1.15 + *  o Redistributions in binary form must reproduce the above copyright
    1.16 + * notice, this list of conditions and the following disclaimer in the
    1.17 + * documentation and/or other materials provided with the distribution.
    1.18 + *
    1.19 + *  o Neither the name of Ben Fortuna nor the names of any other contributors
    1.20 + * may be used to endorse or promote products derived from this software
    1.21 + * without specific prior written permission.
    1.22 + *
    1.23 + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
    1.24 + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
    1.25 + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
    1.26 + * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
    1.27 + * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
    1.28 + * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
    1.29 + * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
    1.30 + * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
    1.31 + * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
    1.32 + * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
    1.33 + * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
    1.34 + */
    1.35 +package net.fortuna.ical4j.transform;
    1.36 +
    1.37 +import net.fortuna.ical4j.model.Calendar;
    1.38 +import net.fortuna.ical4j.model.Component;
    1.39 +import net.fortuna.ical4j.util.Calendars;
    1.40 +
    1.41 +/**
    1.42 + * $Id$
    1.43 + *
    1.44 + * Created: 23/09/2004
    1.45 + *
    1.46 + * Base class of calendar transformations.
    1.47 + * @author benfortuna
    1.48 + */
    1.49 +public abstract class Transformer {
    1.50 +
    1.51 +    /**
    1.52 +     * Transforms the specified calendar according to the implementation of this method. By definition this method will
    1.53 +     * modify the existing calendar instance and return it for convenience.
    1.54 +     * @param calendar a calendar to transform
    1.55 +     * @return a transformed calendar
    1.56 +     */
    1.57 +    public abstract Calendar transform(final Calendar calendar);
    1.58 +
    1.59 +    /**
    1.60 +     * Transforms the specified component according to the transformer implementation.
    1.61 +     * @param component a component to transform
    1.62 +     * @return a calendar containing the transformed component
    1.63 +     */
    1.64 +    public final Calendar transform(final Component component) {
    1.65 +        return transform(Calendars.wrap(component));
    1.66 +    }
    1.67 +}

mercurial