Package org.hl7.fhir.r5.model

Class Base64BinaryType

java.lang.Object

org.hl7.fhir.r5.model.Base

org.hl7.fhir.r5.model.Element

org.hl7.fhir.r5.model.DataType

org.hl7.fhir.r5.model.PrimitiveType<byte[]>

org.hl7.fhir.r5.model.Base64BinaryType

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<byte[]>

public class Base64BinaryType
extends PrimitiveType<byte[]>
implements org.hl7.fhir.instance.model.api.IPrimitiveType<byte[]>, org.hl7.fhir.instance.model.api.IBaseHasExtensions, ca.uhn.fhir.model.api.IElement, Externalizable

Primitive type "base64Binary" in FHIR: a sequence of bytes represented in base64

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.hl7.fhir.r5.model.Base

Base.ProfileSource, Base.ValidationInfo, Base.ValidationMode, Base.ValidationReason

Field Summary

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

extension, id

Constructor Summary

Constructors

Constructor	Description
Base64BinaryType()	Constructor
Base64BinaryType(byte[] theBytes)
Base64BinaryType(String theValue)

Method Summary

Modifier and Type	Method	Description
void	checkValidBase64(String toCheck)	Checks if the passed in String is a valid Base64 encoded String.
Base64BinaryType	copy()
protected String	encode(byte[] theValue)	Subclasses must override to convert a "coerced" value into an encoded one.
String	fhirType()
byte[]	getValue()
String	getValueAsString()
boolean	hasValue()
boolean	isEmpty()
protected byte[]	parse(String theValue)	Subclasses must override to convert an encoded representation of this datatype into a "coerced" one
String	primitiveValue()
void	readExternal(ObjectInput in)
Base64BinaryType	setValue(byte[] theValue)
void	setValueAsString(String theValue)
protected DataType	typedCopy()
void	writeExternal(ObjectOutput out)

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

asStringValue, canHavePrimitiveValue, equalsDeep, equalsShallow, forceStringValue, fpValue, fromStringValue, getProperty, getTypesForProperty, hashCode, hasPrimitiveValue, isPrimitive, makeProperty, matches, removeChild, setProperty, setProperty, toString, updateStringValue

Methods inherited from class org.hl7.fhir.r5.model.DataType

copyValues, getTranslation, isTranslatable

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

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

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

addDefinition, addFormatCommentsPost, addFormatCommentsPre, addValidationMessage, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyFormatComments, copyUserData, copyValues, dateTimeValue, equals, executeFunction, getChildByName, getChildValueByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getValidationInfo, getValidationMessages, getXhtml, hasFormatComment, hasFormatCommentPost, hasFormatCommentPre, hasType, hasUserData, hasValidated, hasValidationInfo, hasValidationMessages, isBooleanPrimitive, isCopyUserData, isDateTime, isMetadataBased, isResource, listChildrenByName, listChildrenByName, setCopyUserData, setUserData, setUserDataINN, setXhtml

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.IBase

getFormatCommentsPost, getFormatCommentsPre, getUserData, hasFormatComment, setUserData

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

getUserData, setUserData

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

addExtension, getExtension, hasExtension

Constructor Details

Base64BinaryType

public Base64BinaryType()

Constructor

Base64BinaryType

public Base64BinaryType(byte[] theBytes)

Base64BinaryType

public Base64BinaryType(String theValue)

Method Details

parse

protected byte[] 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<byte[]>

Parameters:

theValue - Will not be null

Returns:

May return null if the value does not correspond to anything

encode

protected String encode(byte[] theValue)

Description copied from class: PrimitiveType

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

Specified by:

encode in class PrimitiveType<byte[]>

Parameters:

theValue - Will not be null

Returns:

May return null if the value does not correspond to anything

copy

public Base64BinaryType copy()

Specified by:

copy in class PrimitiveType<byte[]>

typedCopy

protected DataType typedCopy()

Overrides:

typedCopy in class PrimitiveType<byte[]>

fhirType

public String fhirType()

Specified by:

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

Overrides:

fhirType in class DataType

Returns:

the FHIR type name of the instance (not the java class name)

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Overrides:

writeExternal in class PrimitiveType<byte[]>

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class PrimitiveType<byte[]>

Throws:

IOException

ClassNotFoundException

getValueAsString

public String getValueAsString()

Specified by:

getValueAsString in interface org.hl7.fhir.instance.model.api.IPrimitiveType<byte[]>

Overrides:

getValueAsString in class PrimitiveType<byte[]>

setValueAsString

public void setValueAsString(String theValue)
                      throws IllegalArgumentException

Specified by:

setValueAsString in interface org.hl7.fhir.instance.model.api.IPrimitiveType<byte[]>

Overrides:

setValueAsString in class PrimitiveType<byte[]>

Throws:

IllegalArgumentException

getValue

public byte[] getValue()

Specified by:

getValue in interface org.hl7.fhir.instance.model.api.IPrimitiveType<byte[]>

Overrides:

getValue in class PrimitiveType<byte[]>

setValue

public Base64BinaryType setValue(byte[] theValue)
                          throws IllegalArgumentException

Specified by:

setValue in interface org.hl7.fhir.instance.model.api.IPrimitiveType<byte[]>

Overrides:

setValue in class PrimitiveType<byte[]>

Throws:

IllegalArgumentException

hasValue

public boolean hasValue()

Specified by:

hasValue in interface org.hl7.fhir.instance.model.api.IPrimitiveType<byte[]>

Overrides:

hasValue in class PrimitiveType<byte[]>

isEmpty

public boolean isEmpty()

Specified by:

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

Overrides:

isEmpty in class PrimitiveType<byte[]>

primitiveValue

public String primitiveValue()

Overrides:

primitiveValue in class PrimitiveType<byte[]>

Returns:

the primitive value if there is one, as a string irrespective of the actual type (e.g. dates converted to their FHIR string representation) return null if the value is not a primitive or there is no value (might be extensions instead)

checkValidBase64

public void checkValidBase64(String toCheck)
                      throws DataFormatException

Checks if the passed in String is a valid Base64 encoded String. Will throw a DataFormatException if not formatted correctly.

Parameters:

toCheck - String to check if valid Base64

Throws:

DataFormatException