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 * Shows how the person's name should be displayed.
036 *
037 * <p>
038 * <b>Code sample</b>
039 * </p>
040 *
041 * <pre class="brush:java">
042 * VCard vcard = new VCard();
043 * FormattedName fn = new FormattedName("Dr. Gregory House M.D.");
044 * vcard.setFormattedName(fn);
045 * </pre>
046 *
047 * <p>
048 * <b>Property name:</b> {@code FN}
049 * </p>
050 * <p>
051 * <b>Supported versions:</b> {@code 2.1, 3.0, 4.0}
052 * </p>
053 * @author Michael Angstadt
054 */
055 public class FormattedName extends TextProperty implements HasAltId {
056 /**
057 * Creates a formatted name property.
058 * @param name the person's name (e.g. "John Doe")
059 */
060 public FormattedName(String name) {
061 super(name);
062 }
063
064 /**
065 * Gets the TYPE parameter.
066 * <p>
067 * <b>Supported versions:</b> {@code 4.0}
068 * </p>
069 * @return the TYPE value (typically, this will be either "work" or "home")
070 * or null if it doesn't exist
071 */
072 public String getType() {
073 return parameters.getType();
074 }
075
076 /**
077 * Sets the TYPE parameter.
078 * <p>
079 * <b>Supported versions:</b> {@code 4.0}
080 * </p>
081 * @param type the TYPE value (this should be either "work" or "home") or
082 * null to remove
083 */
084 public void setType(String type) {
085 parameters.setType(type);
086 }
087
088 @Override
089 public String getLanguage() {
090 return super.getLanguage();
091 }
092
093 @Override
094 public void setLanguage(String language) {
095 super.setLanguage(language);
096 }
097
098 @Override
099 public List<Integer[]> getPids() {
100 return super.getPids();
101 }
102
103 @Override
104 public void addPid(int localId, int clientPidMapRef) {
105 super.addPid(localId, clientPidMapRef);
106 }
107
108 @Override
109 public void removePids() {
110 super.removePids();
111 }
112
113 @Override
114 public Integer getPref() {
115 return super.getPref();
116 }
117
118 @Override
119 public void setPref(Integer pref) {
120 super.setPref(pref);
121 }
122
123 //@Override
124 public String getAltId() {
125 return parameters.getAltId();
126 }
127
128 //@Override
129 public void setAltId(String altId) {
130 parameters.setAltId(altId);
131 }
132 }