001package org.hl7.fhir.r5.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;
035import org.hl7.fhir.exceptions.FHIRException;
036import org.hl7.fhir.r5.utils.ToolingExtensions;
037
038import ca.uhn.fhir.model.api.annotation.DatatypeDef;
039
040
041/**
042 * Primitive type "string" in FHIR - any sequence of unicode characters less than 1MB in length
043 */
044@DatatypeDef(name = "string")
045public class StringType extends PrimitiveType<String> {
046
047        private static final long serialVersionUID = 3L;
048
049        /**
050         * Create a new String
051         */
052        public StringType() {
053                super();
054        }
055
056        /**
057         * Create a new String
058         */
059        public StringType(String theValue) {
060                setValue(theValue);
061        }
062
063        /**
064         * Returns the value of this StringType, or an empty string ("") if the
065         * value is <code>null</code>. This method is provided as a convenience to
066         * users of this API.
067         */
068        public String getValueNotNull() {
069                return StringUtils.defaultString(getValue());
070        }
071
072        /**
073         * Returns the value of this string, or <code>null</code> if no value
074         * is present
075         */
076        @Override
077        public String toString() {
078                return getValue();
079        }
080
081        @Override
082        protected String parse(String theValue) {
083                return theValue;
084        }
085
086        @Override
087        protected String encode(String theValue) {
088                return theValue;
089        }
090
091        @Override
092        public StringType copy() {
093                StringType ret = new StringType(getValue());
094    copyValues(ret);
095    return ret;
096        }
097
098        public String fhirType() {
099                return "string";
100        }
101
102  @Override
103  public boolean isTranslatable() {
104    return true;
105  }
106}