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