Package ca.uhn.fhir.model.primitive

Class StringDt

java.lang.Object

ca.uhn.fhir.model.api.BaseElement

ca.uhn.fhir.model.api.BaseIdentifiableElement

ca.uhn.fhir.model.api.BasePrimitive<String>

ca.uhn.fhir.model.primitive.StringDt

All Implemented Interfaces:

IDatatype, IElement, IIdentifiableElement, IPrimitiveDatatype<String>, IQueryParameterType, ISupportsUndeclaredExtensions, Externalizable, Serializable, IBase, IBaseDatatype, IPrimitiveType<String>

Direct Known Subclasses:

MarkdownDt, TimeDt

public class StringDt
extends BasePrimitive<String>
implements IQueryParameterType

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
StringDt()	Create a new String
StringDt(String theValue)	Create a new String

Method Summary

Modifier and Type	Method	Description
protected String	encode(String theValue)	Subclasses must override to convert a "coerced" value into an encoded one.
boolean	equals(Object obj)
Boolean	getMissing()	Deprecated. get/setMissing is not supported in StringDt.
String	getQueryParameterQualifier()	This method will return any qualifier that should be appended to the parameter name (e.g ":exact").
String	getValueAsQueryToken(FhirContext theContext)	Returns a representation of this parameter's value as it will be represented "over the wire".
String	getValueNotNull()
int	hashCode()
boolean	isEmpty()	Returns true if this datatype has no extensions, and has either a null value or an empty ("") value.
protected String	parse(String theValue)	Subclasses must override to convert an encoded representation of this datatype into a "coerced" one
IQueryParameterType	setMissing(Boolean theMissing)	Deprecated. get/setMissing is not supported in StringDt.
void	setValueAsQueryToken(FhirContext theContext, String theParamName, String theQualifier, String theValue)	This method is generally only called by HAPI itself, and should not need to be called from user code.
String	toString()	Returns the value of this string, or null

Methods inherited from class ca.uhn.fhir.model.api.BasePrimitive

getValue, getValueAsString, hasValue, readExternal, setValue, setValueAsString, updateStringValue, writeExternal

Methods inherited from class ca.uhn.fhir.model.api.BaseIdentifiableElement

getElementSpecificId, getId, setElementSpecificId, setId, setId

Methods inherited from class ca.uhn.fhir.model.api.BaseElement

addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getFormatCommentsPost, getFormatCommentsPre, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions, getUserData, hasFormatComment, isBaseEmpty, setUserData

Methods inherited from class java.lang.Object

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

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

fhirType, getFormatCommentsPost, getFormatCommentsPre, getUserData, hasFormatComment, setUserData

Constructor Detail

StringDt

public StringDt()

Create a new String

StringDt

public StringDt(String theValue)

Create a new String

Method Detail

getValueNotNull

public String getValueNotNull()

toString

public String toString()

Returns the value of this string, or null

Overrides:

toString in class BasePrimitive<String>

hashCode

public int hashCode()

Overrides:

hashCode in class BasePrimitive<String>

equals

public boolean equals(Object obj)

Overrides:

equals in class BasePrimitive<String>

setValueAsQueryToken

public void setValueAsQueryToken(FhirContext theContext,
                                 String theParamName,
                                 String theQualifier,
                                 String theValue)

This method is generally only called by HAPI itself, and should not need to be called from user code.

See FHIR specification 2.2.2 Search SearchParameter Types for information on the token format

Specified by:

setValueAsQueryToken in interface IQueryParameterType

Parameters:

theContext - TODO

theParamName - TODO

theQualifier - The parameter name qualifier that accompanied this value. For example, if the complete query was http://foo?name:exact=John, qualifier would be ":exact"

theValue - The actual parameter value. For example, if the complete query was http://foo?name:exact=John, the value would be "John"

getValueAsQueryToken

public String getValueAsQueryToken(FhirContext theContext)

Returns a representation of this parameter's value as it will be represented "over the wire". In other words, how it will be presented in a URL (although not URL escaped)

See FHIR specification 2.2.2 Search SearchParameter Types for information on the token format

Specified by:

getValueAsQueryToken in interface IQueryParameterType

Parameters:

theContext - TODO

Returns:

Returns a representation of this parameter's value as it will be represented "over the wire". In other words, how it will be presented in a URL (although not URL escaped)

isEmpty

public boolean isEmpty()

Returns true if this datatype has no extensions, and has either a null value or an empty ("") value.

Specified by:

isEmpty in interface IBase

Overrides:

isEmpty in class BasePrimitive<String>

getQueryParameterQualifier

public String getQueryParameterQualifier()

Description copied from interface: IQueryParameterType

This method will return any qualifier that should be appended to the parameter name (e.g ":exact"). Returns null if none are present.

Specified by:

getQueryParameterQualifier in interface IQueryParameterType

parse

protected String parse(String theValue)

Description copied from class: BasePrimitive

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

Specified by:

parse in class BasePrimitive<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: BasePrimitive

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

Specified by:

encode in class BasePrimitive<String>

Parameters:

theValue - Will not be null

Returns:

May return null if the value does not correspond to anything

getMissing

@Deprecated
public Boolean getMissing()

Deprecated.

get/setMissing is not supported in StringDt. Use StringParam instead if you need this functionality

Not supported!

Specified by:

getMissing in interface IQueryParameterType

setMissing

@Deprecated
public IQueryParameterType setMissing(Boolean theMissing)

Deprecated.

get/setMissing is not supported in StringDt. Use StringParam instead if you need this functionality

Not supported!

Specified by:

setMissing in interface IQueryParameterType

Returns:

Returns a reference to this for easier method chaining