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