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 URL pointing to the person's homepage or business website.
036     * 
037     * <p>
038     * <b>Code sample</b>
039     * </p>
040     * 
041     * <pre class="brush:java">
042     * VCard vcard = new VCard();
043     * Url url = new Url(&quot;http://www.company.com&quot;);
044     * vcard.addUrl(url);
045     * </pre>
046     * 
047     * <p>
048     * <b>Property name:</b> {@code URL}
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 Url extends UriProperty implements HasAltId {
056            /**
057             * Creates a URL property.
058             * @param url the URL (e.g. "http://example.com")
059             */
060            public Url(String url) {
061                    super(url);
062            }
063    
064            /**
065             * Gets the MEDIATYPE parameter.
066             * <p>
067             * <b>Supported versions:</b> {@code 4.0}
068             * </p>
069             * @return the media type or null if not set
070             */
071            public String getMediaType() {
072                    return parameters.getMediaType();
073            }
074    
075            /**
076             * Sets the MEDIATYPE parameter.
077             * <p>
078             * <b>Supported versions:</b> {@code 4.0}
079             * </p>
080             * @param mediaType the media type or null to remove
081             */
082            public void setMediaType(String mediaType) {
083                    parameters.setMediaType(mediaType);
084            }
085    
086            @Override
087            public List<Integer[]> getPids() {
088                    return super.getPids();
089            }
090    
091            @Override
092            public void addPid(int localId, int clientPidMapRef) {
093                    super.addPid(localId, clientPidMapRef);
094            }
095    
096            @Override
097            public void removePids() {
098                    super.removePids();
099            }
100    
101            @Override
102            public Integer getPref() {
103                    return super.getPref();
104            }
105    
106            @Override
107            public void setPref(Integer pref) {
108                    super.setPref(pref);
109            }
110    
111            //@Override
112            public String getAltId() {
113                    return parameters.getAltId();
114            }
115    
116            //@Override
117            public void setAltId(String altId) {
118                    parameters.setAltId(altId);
119            }
120    
121            /**
122             * Gets the TYPE parameter.
123             * <p>
124             * <b>Supported versions:</b> {@code 4.0*}
125             * </p>
126             * 
127             * <p>
128             * <i>* Some mail clients will add this parameter to URL properties in 2.1
129             * and 3.0 vCards, however.</i>
130             * </p>
131             * 
132             * @return the TYPE value (typically, this will be either "work" or "home")
133             * or null if it doesn't exist
134             */
135            public String getType() {
136                    return parameters.getType();
137            }
138    
139            /**
140             * Sets the TYPE parameter.
141             * <p>
142             * <b>Supported versions:</b> {@code 4.0*}
143             * </p>
144             * 
145             * <p>
146             * <i>* Some mail clients will add this parameter to URL properties in 2.1
147             * and 3.0 vCards, however.</i>
148             * </p>
149             * @param type the TYPE value (this should be either "work" or "home") or
150             * null to remove
151             */
152            public void setType(String type) {
153                    parameters.setType(type);
154            }
155    }