001package ezvcard.property; 002 003import ezvcard.SupportedVersions; 004import ezvcard.VCardVersion; 005 006/* 007 Copyright (c) 2012-2023, Michael Angstadt 008 All rights reserved. 009 010 Redistribution and use in source and binary forms, with or without 011 modification, are permitted provided that the following conditions are met: 012 013 1. Redistributions of source code must retain the above copyright notice, this 014 list of conditions and the following disclaimer. 015 2. Redistributions in binary form must reproduce the above copyright notice, 016 this list of conditions and the following disclaimer in the documentation 017 and/or other materials provided with the distribution. 018 019 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 020 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 021 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 022 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR 023 ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 024 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 025 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 026 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 027 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 028 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 029 030 The views and conclusions contained in the software and documentation are those 031 of the authors and should not be interpreted as representing official policies, 032 either expressed or implied, of the FreeBSD Project. 033 */ 034 035/** 036 * <p> 037 * Defines the location of the person's birth. 038 * </p> 039 * 040 * <p> 041 * <b>Code sample (creating)</b> 042 * </p> 043 * 044 * <pre class="brush:java"> 045 * VCard vcard = new VCard(); 046 * 047 * //text 048 * Birthplace birthplace = new Birthplace("Maida Vale, London, United Kingdom"); 049 * vcard.setBirthplace(birthplace); 050 * 051 * //geo coordinates 052 * birthplace = new Birthplace(51.5274, -0.1899); 053 * vcard.setBirthplace(birthplace); 054 * 055 * //URI 056 * birthplace = new Birthplace(); 057 * birthplace.setUri("http://en.wikipedia.org/wiki/Maida_Vale"); 058 * vcard.setBirthplace(birthplace); 059 * </pre> 060 * 061 * <p> 062 * <b>Code sample (retrieving)</b> 063 * </p> 064 * 065 * <pre class="brush:java"> 066 * VCard vcard = ... 067 * Birthplace birthplace = vcard.getBirthplace(); 068 * 069 * String text = birthplace.getText(); 070 * if (text != null) { 071 * //property value is plain text 072 * } 073 * 074 * Double latitude = birthplace.getLatitude(); 075 * Double longitude = birthplace.getLongitude(); 076 * if (latitude != null) { 077 * //property value is a set of geo coordinates 078 * } 079 * 080 * String uri = birthplace.getUri(); 081 * if (uri != null) { 082 * //property value is a URI 083 * } 084 * </pre> 085 * 086 * <p> 087 * <b>Property name:</b> {@code BIRTHPLACE} 088 * </p> 089 * <p> 090 * <b>Supported versions:</b> {@code 4.0} 091 * </p> 092 * @author Michael Angstadt 093 * @see <a href="http://tools.ietf.org/html/rfc6474#page-2">RFC 6474 p.2</a> 094 */ 095@SupportedVersions(VCardVersion.V4_0) 096public class Birthplace extends PlaceProperty { 097 /** 098 * Creates a new birthplace property. 099 */ 100 public Birthplace() { 101 super(); 102 } 103 104 /** 105 * Creates a new birthplace property. 106 * @param latitude the latitude coordinate of the place 107 * @param longitude the longitude coordinate of the place 108 */ 109 public Birthplace(double latitude, double longitude) { 110 super(latitude, longitude); 111 } 112 113 /** 114 * Creates a new birthplace property. 115 * @param text a text value representing the place 116 */ 117 public Birthplace(String text) { 118 super(text); 119 } 120 121 /** 122 * Copy constructor. 123 * @param original the property to make a copy of 124 */ 125 public Birthplace(Birthplace original) { 126 super(original); 127 } 128 129 @Override 130 public Birthplace copy() { 131 return new Birthplace(this); 132 } 133}