001package org.hl7.fhir.r4.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
032import org.apache.commons.lang3.StringUtils;
033import org.hl7.fhir.exceptions.FHIRException;
034import org.hl7.fhir.r4.utils.ToolingExtensions;
035
036import ca.uhn.fhir.model.api.annotation.DatatypeDef;
037
038/**
039 * Primitive type "string" in FHIR - any sequence of unicode characters less
040 * 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 value is
063   * <code>null</code>. This method is provided as a convenience to users of this
064   * 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 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    StringType ret = new StringType(getValue());
091    copyValues(ret);
092    return ret;
093  }
094
095  public String fhirType() {
096    return "string";
097  }
098
099  public String getTranslation(String l) throws FHIRException {
100    for (Extension e : getExtension()) {
101      if (e.getUrl().equals(ToolingExtensions.EXT_TRANSLATION)) {
102        String lang = ToolingExtensions.readStringExtension(e, "lang");
103        if (lang.equals(l))
104          return e.getExtensionString("content");
105      }
106    }
107    return null;
108  }
109
110}