001package ezvcard.property;
002
003import java.util.List;
004
005import ezvcard.parameter.Pid;
006
007/*
008 Copyright (c) 2012-2023, Michael Angstadt
009 All rights reserved.
010
011 Redistribution and use in source and binary forms, with or without
012 modification, are permitted provided that the following conditions are met: 
013
014 1. Redistributions of source code must retain the above copyright notice, this
015 list of conditions and the following disclaimer. 
016 2. Redistributions in binary form must reproduce the above copyright notice,
017 this list of conditions and the following disclaimer in the documentation
018 and/or other materials provided with the distribution. 
019
020 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
021 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
022 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
023 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
024 ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
025 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
026 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
027 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
028 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
029 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
030
031 The views and conclusions contained in the software and documentation are those
032 of the authors and should not be interpreted as representing official policies, 
033 either expressed or implied, of the FreeBSD Project.
034 */
035
036/**
037 * <p>
038 * Defines the person's full name in a human-readable format.
039 * </p>
040 * 
041 * <p>
042 * <b>Code sample</b>
043 * </p>
044 * 
045 * <pre class="brush:java">
046 * VCard vcard = new VCard();
047 * 
048 * FormattedName fn = new FormattedName("Dr. Gregory House M.D.");
049 * vcard.setFormattedName(fn);
050 * </pre>
051 * 
052 * <p>
053 * <b>Property name:</b> {@code FN}
054 * </p>
055 * <p>
056 * <b>Supported versions:</b> {@code 2.1, 3.0, 4.0}
057 * </p>
058 * @author Michael Angstadt
059 * @see <a href="http://tools.ietf.org/html/rfc6350#page-28">RFC 6350 p.28</a>
060 * @see <a href="http://tools.ietf.org/html/rfc2426#page-8">RFC 2426 p.8</a>
061 * @see <a href="http://www.imc.org/pdi/vcard-21.doc">vCard 2.1 p.9</a>
062 */
063public class FormattedName extends TextProperty implements HasAltId {
064        /**
065         * Creates a formatted name property.
066         * @param name the person's name (e.g. "John Doe")
067         */
068        public FormattedName(String name) {
069                super(name);
070        }
071
072        /**
073         * Copy constructor.
074         * @param original the property to make a copy of
075         */
076        public FormattedName(FormattedName original) {
077                super(original);
078        }
079
080        /**
081         * Gets the TYPE parameter.
082         * <p>
083         * <b>Supported versions:</b> {@code 4.0}
084         * </p>
085         * @return the TYPE value (typically, this will be either "work" or "home")
086         * or null if it doesn't exist
087         */
088        public String getType() {
089                return parameters.getType();
090        }
091
092        /**
093         * Sets the TYPE parameter.
094         * <p>
095         * <b>Supported versions:</b> {@code 4.0}
096         * </p>
097         * @param type the TYPE value (this should be either "work" or "home") or
098         * null to remove
099         */
100        public void setType(String type) {
101                parameters.setType(type);
102        }
103
104        @Override
105        public String getLanguage() {
106                return super.getLanguage();
107        }
108
109        @Override
110        public void setLanguage(String language) {
111                super.setLanguage(language);
112        }
113
114        @Override
115        public List<Pid> getPids() {
116                return super.getPids();
117        }
118
119        @Override
120        public Integer getPref() {
121                return super.getPref();
122        }
123
124        @Override
125        public void setPref(Integer pref) {
126                super.setPref(pref);
127        }
128
129        //@Override
130        public String getAltId() {
131                return parameters.getAltId();
132        }
133
134        //@Override
135        public void setAltId(String altId) {
136                parameters.setAltId(altId);
137        }
138
139        @Override
140        public FormattedName copy() {
141                return new FormattedName(this);
142        }
143}