001    package biweekly.component.marshaller;
002    
003    import java.util.Collection;
004    
005    import biweekly.component.ICalComponent;
006    import biweekly.property.ICalProperty;
007    
008    /*
009     Copyright (c) 2013, Michael Angstadt
010     All rights reserved.
011    
012     Redistribution and use in source and binary forms, with or without
013     modification, are permitted provided that the following conditions are met: 
014    
015     1. Redistributions of source code must retain the above copyright notice, this
016     list of conditions and the following disclaimer. 
017     2. Redistributions in binary form must reproduce the above copyright notice,
018     this list of conditions and the following disclaimer in the documentation
019     and/or other materials provided with the distribution. 
020    
021     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
022     ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
023     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
024     DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
025     ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
026     (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
027     LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
028     ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
029     (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
030     SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
031     */
032    
033    /**
034     * Base class for iCalendar component marshallers.
035     * @author Michael Angstadt
036     */
037    public abstract class ICalComponentMarshaller<T extends ICalComponent> {
038            protected final Class<T> clazz;
039            protected final String componentName;
040    
041            /**
042             * Creates a new component marshaller.
043             * @param clazz the component's class
044             * @param componentName the component's name (e.g. "VEVENT")
045             */
046            public ICalComponentMarshaller(Class<T> clazz, String componentName) {
047                    this.clazz = clazz;
048                    this.componentName = componentName;
049            }
050    
051            /**
052             * Gets the component class.
053             * @return the component class.
054             */
055            public Class<T> getComponentClass() {
056                    return clazz;
057            }
058    
059            /**
060             * Gets the component's name.
061             * @return the compent's name (e.g. "VEVENT")
062             */
063            public String getComponentName() {
064                    return componentName;
065            }
066    
067            /**
068             * Creates a new instance of the component class that doesn't have any
069             * properties or sub-components.
070             * @return the new instance
071             */
072            public T emptyInstance() {
073                    T component = _newInstance();
074    
075                    //remove any properties/components that were created in the constructor
076                    component.getProperties().clear();
077                    component.getComponents().clear();
078    
079                    return component;
080            }
081    
082            /**
083             * Creates a new instance of the component class.
084             * @return the new instance
085             */
086            protected abstract T _newInstance();
087    
088            /**
089             * Gets the sub-components to marshal. Child classes can override this for
090             * better control over which components are marshalled.
091             * @param component the component
092             * @return the sub-components to marshal
093             */
094            public Collection<ICalComponent> getComponents(T component) {
095                    return component.getComponents().values();
096            }
097    
098            /**
099             * Gets the properties to marshal. Child classes can override this for
100             * better control over which properties are marshalled.
101             * @param component the component
102             * @return the properties to marshal
103             */
104            public Collection<ICalProperty> getProperties(T component) {
105                    return component.getProperties().values();
106            }
107    }