src/net/fortuna/ical4j/transform/Transformer.java@45d57ecba757 (annotated)
src/net/fortuna/ical4j/transform/Transformer.java
Tue, 10 Feb 2015 19:58:00 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Tue, 10 Feb 2015 19:58:00 +0100
- changeset 4
- 45d57ecba757
- permissions
- -rw-r--r--
Upgrade the upgraded ical4j component to use org.apache.commons.lang3.
| michael@0 | 1 | /** |
| michael@0 | 2 | * Copyright (c) 2012, Ben Fortuna |
| michael@0 | 3 | * All rights reserved. |
| michael@0 | 4 | * |
| michael@0 | 5 | * Redistribution and use in source and binary forms, with or without |
| michael@0 | 6 | * modification, are permitted provided that the following conditions |
| michael@0 | 7 | * are met: |
| michael@0 | 8 | * |
| michael@0 | 9 | * o Redistributions of source code must retain the above copyright |
| michael@0 | 10 | * notice, this list of conditions and the following disclaimer. |
| michael@0 | 11 | * |
| michael@0 | 12 | * o Redistributions in binary form must reproduce the above copyright |
| michael@0 | 13 | * notice, this list of conditions and the following disclaimer in the |
| michael@0 | 14 | * documentation and/or other materials provided with the distribution. |
| michael@0 | 15 | * |
| michael@0 | 16 | * o Neither the name of Ben Fortuna nor the names of any other contributors |
| michael@0 | 17 | * may be used to endorse or promote products derived from this software |
| michael@0 | 18 | * without specific prior written permission. |
| michael@0 | 19 | * |
| michael@0 | 20 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
| michael@0 | 21 | * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
| michael@0 | 22 | * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
| michael@0 | 23 | * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR |
| michael@0 | 24 | * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, |
| michael@0 | 25 | * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, |
| michael@0 | 26 | * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR |
| michael@0 | 27 | * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF |
| michael@0 | 28 | * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING |
| michael@0 | 29 | * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS |
| michael@0 | 30 | * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| michael@0 | 31 | */ |
| michael@0 | 32 | package net.fortuna.ical4j.transform; |
| michael@0 | 33 | |
| michael@0 | 34 | import net.fortuna.ical4j.model.Calendar; |
| michael@0 | 35 | import net.fortuna.ical4j.model.Component; |
| michael@0 | 36 | import net.fortuna.ical4j.util.Calendars; |
| michael@0 | 37 | |
| michael@0 | 38 | /** |
| michael@0 | 39 | * $Id$ |
| michael@0 | 40 | * |
| michael@0 | 41 | * Created: 23/09/2004 |
| michael@0 | 42 | * |
| michael@0 | 43 | * Base class of calendar transformations. |
| michael@0 | 44 | * @author benfortuna |
| michael@0 | 45 | */ |
| michael@0 | 46 | public abstract class Transformer { |
| michael@0 | 47 | |
| michael@0 | 48 | /** |
| michael@0 | 49 | * Transforms the specified calendar according to the implementation of this method. By definition this method will |
| michael@0 | 50 | * modify the existing calendar instance and return it for convenience. |
| michael@0 | 51 | * @param calendar a calendar to transform |
| michael@0 | 52 | * @return a transformed calendar |
| michael@0 | 53 | */ |
| michael@0 | 54 | public abstract Calendar transform(final Calendar calendar); |
| michael@0 | 55 | |
| michael@0 | 56 | /** |
| michael@0 | 57 | * Transforms the specified component according to the transformer implementation. |
| michael@0 | 58 | * @param component a component to transform |
| michael@0 | 59 | * @return a calendar containing the transformed component |
| michael@0 | 60 | */ |
| michael@0 | 61 | public final Calendar transform(final Component component) { |
| michael@0 | 62 | return transform(Calendars.wrap(component)); |
| michael@0 | 63 | } |
| michael@0 | 64 | } |
