001    package ezvcard.types;
002    
003    import java.util.HashSet;
004    import java.util.Set;
005    
006    import ezvcard.parameters.TypeParameter;
007    
008    /*
009     Copyright (c) 2012, 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     The views and conclusions contained in the software and documentation are those
033     of the authors and should not be interpreted as representing official policies, 
034     either expressed or implied, of the FreeBSD Project.
035     */
036    
037    /**
038     * Represents a vCard Type that has a TYPE parameter that can have multiple
039     * values. For example, the ADR type. This class contrasts with the
040     * {@link SingleValuedTypeParameterType} class.
041     * @author Michael Angstadt
042     */
043    public abstract class MultiValuedTypeParameterType<T extends TypeParameter> extends TypeParameterType<T> {
044            /**
045             * @param typeName the type name  (e.g. "ADR")
046             */
047            public MultiValuedTypeParameterType(String typeName) {
048                    super(typeName);
049            }
050    
051            /**
052             * Gets all the TYPE parameters.
053             * @return all the TYPE parameters or empty set if there are none
054             */
055            public Set<T> getTypes() {
056                    Set<String> typesStr = subTypes.getTypes();
057                    Set<T> types = new HashSet<T>();
058                    for (String value : typesStr) {
059                            T type = buildTypeObj(value);
060                            if (type != null) {
061                                    types.add(type);
062                            }
063                    }
064                    return types;
065            }
066    
067            /**
068             * Adds a TYPE parameter.
069             * @param type the TYPE parameter to add
070             */
071            public void addType(T type) {
072                    subTypes.addType(type.getValue());
073            }
074    
075            /**
076             * Removes a TYPE parameter.
077             * @param type the TYPE parameter to remove
078             */
079            public void removeType(T type) {
080                    subTypes.removeType(type.getValue());
081            }
082    }