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