org.hl7.fhir.r4.model

Class StringType

java.lang.Object

org.hl7.fhir.r4.model.Base

org.hl7.fhir.r4.model.Element

org.hl7.fhir.r4.model.Type

org.hl7.fhir.r4.model.PrimitiveType<String>

org.hl7.fhir.r4.model.StringType

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Externalizable, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseDatatype, org.hl7.fhir.instance.model.api.IBaseElement, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IPrimitiveType<String>

Direct Known Subclasses:

CodeType, MarkdownType

public class StringType
extends PrimitiveType<String>

Primitive type "string" in FHIR - any sequence of unicode characters less than 1MB in length

See Also:

Serialized Form

Field Summary

Fields inherited from class org.hl7.fhir.r4.model.Element

extension, id

Constructor Summary

Constructors

Constructor and Description
StringType() Create a new String
StringType(String theValue) Create a new String

Method Summary

Modifier and Type	Method and Description
StringType	copy()
protected String	encode(String theValue) Subclasses must override to convert a "coerced" value into an encoded one.
String	fhirType()
String	getTranslation(String l)
String	getValueNotNull() Returns the value of this StringType, or an empty string ("") if the value is null.
protected String	parse(String theValue) Subclasses must override to convert an encoded representation of this datatype into a "coerced" one
String	toString() Returns the value of this string, or null if no value is present

Methods inherited from class org.hl7.fhir.r4.model.PrimitiveType

asStringValue, equalsDeep, equalsShallow, forceStringValue, fpValue, fromStringValue, getProperty, getTypesForProperty, getValue, getValueAsString, hashCode, hasPrimitiveValue, hasValue, isEmpty, isPrimitive, makeProperty, primitiveValue, readExternal, setProperty, setProperty, setValue, setValueAsString, typedCopy, updateStringValue, writeExternal

Methods inherited from class org.hl7.fhir.r4.model.Element

addChild, addExtension, addExtension, addExtension, copyValues, getExtension, getExtensionByUrl, getExtensionFirstRep, getExtensionsByUrl, getExtensionString, getId, getIdBase, getIdElement, getNamedProperty, hasExtension, hasExtension, hasId, hasIdElement, isDisallowExtensions, listChildren, noExtensions, removeExtension, setDisallowExtensions, setExtension, setId, setIdBase, setIdElement

Methods inherited from class org.hl7.fhir.r4.model.Base

castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isResource, listChildrenByName, listChildrenByName, setUserData, setUserDataINN

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.hl7.fhir.instance.model.api.IPrimitiveType

toValueOrNull

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

getFormatCommentsPost, getFormatCommentsPre, getUserData, hasFormatComment, setUserData

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseHasExtensions

addExtension, getExtension, hasExtension

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseElement

getUserData, setUserData

Constructor Detail

StringType

public StringType()

Create a new String

StringType

public StringType(String theValue)

Create a new String

Method Detail

getValueNotNull

public String getValueNotNull()

Returns the value of this StringType, or an empty string ("") if the value is null. This method is provided as a convenience to users of this API.

toString

public String toString()

Returns the value of this string, or null if no value is present

Overrides:

toString in class PrimitiveType<String>

parse

protected String parse(String theValue)

Description copied from class: PrimitiveType

Subclasses must override to convert an encoded representation of this datatype into a "coerced" one

Specified by:

parse in class PrimitiveType<String>

Parameters:

theValue - Will not be null

Returns:

May return null if the value does not correspond to anything

encode

protected String encode(String theValue)

Description copied from class: PrimitiveType

Subclasses must override to convert a "coerced" value into an encoded one.

Specified by:

encode in class PrimitiveType<String>

Parameters:

theValue - Will not be null

Returns:

May return null if the value does not correspond to anything

copy

public StringType copy()

Specified by:

copy in class PrimitiveType<String>

fhirType

public String fhirType()

Specified by:

fhirType in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

fhirType in class Element

getTranslation

public String getTranslation(String l)
                      throws org.hl7.fhir.exceptions.FHIRException

Throws:

org.hl7.fhir.exceptions.FHIRException