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
031/*-
032 * #%L
033 * org.hl7.fhir.dstu3
034 * %%
035 * Copyright (C) 2014 - 2019 Health Level 7
036 * %%
037 * Licensed under the Apache License, Version 2.0 (the "License");
038 * you may not use this file except in compliance with the License.
039 * You may obtain a copy of the License at
040 * 
041 *      http://www.apache.org/licenses/LICENSE-2.0
042 * 
043 * Unless required by applicable law or agreed to in writing, software
044 * distributed under the License is distributed on an "AS IS" BASIS,
045 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
046 * See the License for the specific language governing permissions and
047 * limitations under the License.
048 * #L%
049 */
050
051
052import org.apache.commons.lang3.StringUtils;
053
054import ca.uhn.fhir.model.api.annotation.DatatypeDef;
055
056
057/**
058 * Primitive type "string" in FHIR - any sequence of unicode characters less than 1MB in length
059 */
060@DatatypeDef(name = "string")
061public class StringType extends PrimitiveType<String> {
062
063        private static final long serialVersionUID = 3L;
064
065        /**
066         * Create a new String
067         */
068        public StringType() {
069                super();
070        }
071
072        /**
073         * Create a new String
074         */
075        public StringType(String theValue) {
076                setValue(theValue);
077        }
078
079        /**
080         * Returns the value of this StringType, or an empty string ("") if the
081         * value is <code>null</code>. This method is provided as a convenience to
082         * users of this API.
083         */
084        public String getValueNotNull() {
085                return StringUtils.defaultString(getValue());
086        }
087
088        /**
089         * Returns the value of this string, or <code>null</code> if no value
090         * is present
091         */
092        @Override
093        public String toString() {
094                return getValue();
095        }
096
097        @Override
098        protected String parse(String theValue) {
099                return theValue;
100        }
101
102        @Override
103        protected String encode(String theValue) {
104                return theValue;
105        }
106
107        @Override
108        public StringType copy() {
109                return new StringType(getValue());
110        }
111
112        public String fhirType() {
113                return "string";
114        }
115
116}