001 package ezvcard.property;
002
003 import java.util.List;
004
005 /*
006 Copyright (c) 2013, Michael Angstadt
007 All rights reserved.
008
009 Redistribution and use in source and binary forms, with or without
010 modification, are permitted provided that the following conditions are met:
011
012 1. Redistributions of source code must retain the above copyright notice, this
013 list of conditions and the following disclaimer.
014 2. Redistributions in binary form must reproduce the above copyright notice,
015 this list of conditions and the following disclaimer in the documentation
016 and/or other materials provided with the distribution.
017
018 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
019 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
020 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
021 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
022 ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
023 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
024 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
025 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
026 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
027 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
028
029 The views and conclusions contained in the software and documentation are those
030 of the authors and should not be interpreted as representing official policies,
031 either expressed or implied, of the FreeBSD Project.
032 */
033
034 /**
035 * A list of keywords (aka "tags") that can be used to describe the person.
036 *
037 * <p>
038 * <b>Code sample</b>
039 * </p>
040 *
041 * <pre class="brush:java">
042 * VCard vcard = new VCard();
043 * Categories categories = new Categories();
044 * categories.addValue("programmer");
045 * categories.addValue("developer");
046 * categories.addValue("java-coder");
047 * categories.addValue("ladies-man");
048 * vcard.setCategories(categories);
049 * </pre>
050 *
051 * <p>
052 * <b>Property name:</b> {@code CATEGORIES}
053 * </p>
054 * <p>
055 * <b>Supported versions:</b> {@code 2.1, 3.0, 4.0}
056 * </p>
057 * @author Michael Angstadt
058 */
059 public class Categories extends TextListProperty implements HasAltId {
060 @Override
061 public List<Integer[]> getPids() {
062 return super.getPids();
063 }
064
065 @Override
066 public void addPid(int localId, int clientPidMapRef) {
067 super.addPid(localId, clientPidMapRef);
068 }
069
070 @Override
071 public void removePids() {
072 super.removePids();
073 }
074
075 @Override
076 public Integer getPref() {
077 return super.getPref();
078 }
079
080 @Override
081 public void setPref(Integer pref) {
082 super.setPref(pref);
083 }
084
085 //@Override
086 public String getAltId() {
087 return parameters.getAltId();
088 }
089
090 //@Override
091 public void setAltId(String altId) {
092 parameters.setAltId(altId);
093 }
094
095 /**
096 * Gets the TYPE parameter.
097 * <p>
098 * <b>Supported versions:</b> {@code 4.0}
099 * </p>
100 * @return the TYPE value (typically, this will be either "work" or "home")
101 * or null if it doesn't exist
102 */
103 public String getType() {
104 return parameters.getType();
105 }
106
107 /**
108 * Sets the TYPE parameter.
109 * <p>
110 * <b>Supported versions:</b> {@code 4.0}
111 * </p>
112 * @param type the TYPE value (this should be either "work" or "home") or
113 * null to remove
114 */
115 public void setType(String type) {
116 parameters.setType(type);
117 }
118 }