Transformer.java

/*
 * $Id: Transformer.java,v 1.3 2006/04/05 10:49:18 fortuna Exp $
 * 
 * Created: 23/09/2004
 *
 * Copyright (c) 2004, 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.transform;

import net.fortuna.ical4j.model.Calendar;
import net.fortuna.ical4j.model.Component;
import net.fortuna.ical4j.model.ComponentList;

/**
 * Base class of calendar transformations.
 * 
 * @author benfortuna
 */
public abstract class Transformer {

    /**
     * Wraps a component in a calendar.
     * 
     * @param component
     *            the component to wrap with a calendar
     * @return a calendar containing the specified component
     */
    public final Calendar wrap(final Component component) {
        ComponentList components = new ComponentList();
        components.add(component);

        return new Calendar(components);
    }
    
    /**
     * Transforms the specified calendar according to the
     * implementation of this method. By definition this
     * method will modify the existing calendar instance
     * and return it for convenience.
     * @param calendar a calendar to transform
     * @return a transformed calendar
     */
    public abstract Calendar transform(final Calendar calendar);
    
    /**
     * Transforms the specified component according to the
     * transformer implementation.
     * @param component a component to transform
     * @return a calendar containing the transformed component
     */
    public final Calendar transform(final Component component) {
        return transform(wrap(component));
    }
}