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