001/*
002Copyright (c) 2011+, HL7, Inc
003All rights reserved.
004
005Redistribution and use in source and binary forms, with or without modification, 
006are permitted provided that the following conditions are met:
007
008 * Redistributions of source code must retain the above copyright notice, this 
009   list of conditions and the following disclaimer.
010 * Redistributions in binary form must reproduce the above copyright notice, 
011   this list of conditions and the following disclaimer in the documentation 
012   and/or other materials provided with the distribution.
013 * Neither the name of HL7 nor the names of its contributors may be used to 
014   endorse or promote products derived from this software without specific 
015   prior written permission.
016
017THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 
018ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
019WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 
020IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 
021INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 
022NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 
023PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
024WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
025ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
026POSSIBILITY OF SUCH DAMAGE.
027
028*/
029package org.hl7.fhir.dstu3.model;
030
031import org.apache.commons.lang3.StringUtils;
032
033import ca.uhn.fhir.model.api.annotation.DatatypeDef;
034
035
036/**
037 * Primitive type "string" in FHIR - any sequence of unicode characters less than 1MB in length
038 */
039@DatatypeDef(name = "string")
040public class StringType extends PrimitiveType<String> {
041
042        private static final long serialVersionUID = 3L;
043
044        /**
045         * Create a new String
046         */
047        public StringType() {
048                super();
049        }
050
051        /**
052         * Create a new String
053         */
054        public StringType(String theValue) {
055                setValue(theValue);
056        }
057
058        /**
059         * Returns the value of this StringType, or an empty string ("") if the
060         * value is <code>null</code>. This method is provided as a convenience to
061         * users of this API.
062         */
063        public String getValueNotNull() {
064                return StringUtils.defaultString(getValue());
065        }
066
067        /**
068         * Returns the value of this string, or <code>null</code> if no value
069         * is present
070         */
071        @Override
072        public String toString() {
073                return getValue();
074        }
075
076        @Override
077        protected String parse(String theValue) {
078                return theValue;
079        }
080
081        @Override
082        protected String encode(String theValue) {
083                return theValue;
084        }
085
086        @Override
087        public StringType copy() {
088                return new StringType(getValue());
089        }
090
091        public String fhirType() {
092                return "string";
093        }
094
095}