org.hl7.fhir.dstu3.model

Class Binary

java.lang.Object

org.hl7.fhir.dstu3.model.Base

org.hl7.fhir.dstu3.model.BaseResource

org.hl7.fhir.dstu3.model.Resource

org.hl7.fhir.dstu3.model.BaseBinary

org.hl7.fhir.dstu3.model.Binary

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseBinary, org.hl7.fhir.instance.model.api.IBaseResource

public class Binary
extends BaseBinary
implements org.hl7.fhir.instance.model.api.IBaseBinary

A binary resource can contain any content, whether text, image, pdf, zip archive, etc.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Base64BinaryType	content The actual content, base64 encoded.
protected CodeType	contentType MimeType of the binary content represented as a standard MimeType (BCP 13).
static ca.uhn.fhir.rest.gclient.TokenClientParam	CONTENTTYPE Fluent Client search parameter constant for contenttype
protected Reference	securityContext Treat this binary as if it was this other resource for access control purposes.
protected Resource	securityContextTarget The actual object that is the target of the reference (Treat this binary as if it was this other resource for access control purposes.)
static String	SP_CONTENTTYPE Search parameter: contenttype

Fields inherited from class org.hl7.fhir.dstu3.model.Resource

id, implicitRules, language, meta

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

INCLUDE_ALL, WILDCARD_ALL_SET

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

RES_ID, SP_RES_ID, SP_RES_LANGUAGE

Constructor Summary

Constructors

Constructor and Description
Binary() Constructor
Binary(CodeType contentType, Base64BinaryType content) Constructor

Method Summary

Modifier and Type	Method and Description
Base	addChild(String name)
Binary	copy()
boolean	equalsDeep(Base other)
boolean	equalsShallow(Base other)
String	fhirType()
byte[]	getContent()
Base64BinaryType	getContentElement()
String	getContentType()
CodeType	getContentTypeElement()
Base[]	getProperty(int hash, String name, boolean checkValid)
ResourceType	getResourceType()
Reference	getSecurityContext()
Resource	getSecurityContextTarget()
String[]	getTypesForProperty(int hash, String name)
boolean	hasContent()
boolean	hasContentElement()
boolean	hasContentType()
boolean	hasContentTypeElement()
boolean	hasSecurityContext()
boolean	isEmpty()
protected void	listChildren(List<Property> childrenList)
Base	makeProperty(int hash, String name)
Binary	setContent(byte[] value)
Binary	setContentElement(Base64BinaryType value)
Binary	setContentType(String value)
Binary	setContentTypeElement(CodeType value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
Binary	setSecurityContext(Reference value)
Binary	setSecurityContextTarget(Resource value)
protected Binary	typedCopy()

Methods inherited from class org.hl7.fhir.dstu3.model.BaseBinary

getContentAsBase64, setContentAsBase64

Methods inherited from class org.hl7.fhir.dstu3.model.Resource

copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta

Methods inherited from class org.hl7.fhir.dstu3.model.BaseResource

getStructureFhirVersionEnum, isResource, setId

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

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

Methods inherited from class java.lang.Object

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

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

getContentAsBase64, setContentAsBase64

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

getIdElement, getMeta, getStructureFhirVersionEnum, setId, setId

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

getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

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

getUserData, setUserData

Field Detail

contentType

protected CodeType contentType

MimeType of the binary content represented as a standard MimeType (BCP 13).

securityContext

protected Reference securityContext

Treat this binary as if it was this other resource for access control purposes.

securityContextTarget

protected Resource securityContextTarget

The actual object that is the target of the reference (Treat this binary as if it was this other resource for access control purposes.)

content

protected Base64BinaryType content

The actual content, base64 encoded.

SP_CONTENTTYPE

public static final String SP_CONTENTTYPE

Search parameter: contenttype

Description: MimeType of the binary content
Type: token
Path: Binary.contentType

See Also:

Constant Field Values

CONTENTTYPE

public static final ca.uhn.fhir.rest.gclient.TokenClientParam CONTENTTYPE

Fluent Client search parameter constant for contenttype

Description: MimeType of the binary content
Type: token
Path: Binary.contentType

Constructor Detail

Binary

public Binary()

Constructor

Binary

public Binary(CodeType contentType,
              Base64BinaryType content)

Constructor

Method Detail

getContentTypeElement

public CodeType getContentTypeElement()

Returns:

contentType (MimeType of the binary content represented as a standard MimeType (BCP 13).). This is the underlying object with id, value and extensions. The accessor "getContentType" gives direct access to the value

hasContentTypeElement

public boolean hasContentTypeElement()

hasContentType

public boolean hasContentType()

setContentTypeElement

public Binary setContentTypeElement(CodeType value)

Parameters:

value - contentType (MimeType of the binary content represented as a standard MimeType (BCP 13).). This is the underlying object with id, value and extensions. The accessor "getContentType" gives direct access to the value

getContentType

public String getContentType()

Specified by:

getContentType in interface org.hl7.fhir.instance.model.api.IBaseBinary

Returns:

MimeType of the binary content represented as a standard MimeType (BCP 13).

setContentType

public Binary setContentType(String value)

Specified by:

setContentType in interface org.hl7.fhir.instance.model.api.IBaseBinary

Parameters:

value - MimeType of the binary content represented as a standard MimeType (BCP 13).

getSecurityContext

public Reference getSecurityContext()

Returns:

securityContext (Treat this binary as if it was this other resource for access control purposes.)

hasSecurityContext

public boolean hasSecurityContext()

setSecurityContext

public Binary setSecurityContext(Reference value)

Parameters:

value - securityContext (Treat this binary as if it was this other resource for access control purposes.)

getSecurityContextTarget

public Resource getSecurityContextTarget()

Returns:

securityContext The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (Treat this binary as if it was this other resource for access control purposes.)

setSecurityContextTarget

public Binary setSecurityContextTarget(Resource value)

Parameters:

value - securityContext The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (Treat this binary as if it was this other resource for access control purposes.)

getContentElement

public Base64BinaryType getContentElement()

Returns:

content (The actual content, base64 encoded.). This is the underlying object with id, value and extensions. The accessor "getContent" gives direct access to the value

hasContentElement

public boolean hasContentElement()

hasContent

public boolean hasContent()

setContentElement

public Binary setContentElement(Base64BinaryType value)

Parameters:

value - content (The actual content, base64 encoded.). This is the underlying object with id, value and extensions. The accessor "getContent" gives direct access to the value

getContent

public byte[] getContent()

Specified by:

getContent in interface org.hl7.fhir.instance.model.api.IBaseBinary

Returns:

The actual content, base64 encoded.

setContent

public Binary setContent(byte[] value)

Specified by:

setContent in interface org.hl7.fhir.instance.model.api.IBaseBinary

Parameters:

value - The actual content, base64 encoded.

listChildren

protected void listChildren(List<Property> childrenList)

Overrides:

listChildren in class Resource

getProperty

public Base[] getProperty(int hash,
                          String name,
                          boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getProperty in class Resource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(int hash,
                        String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class Resource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class Resource

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

public Base makeProperty(int hash,
                         String name)
                  throws org.hl7.fhir.exceptions.FHIRException

Overrides:

makeProperty in class Resource

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

public String[] getTypesForProperty(int hash,
                                    String name)
                             throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getTypesForProperty in class Resource

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException

Overrides:

addChild in class Resource

Throws:

org.hl7.fhir.exceptions.FHIRException

fhirType

public String fhirType()

Overrides:

fhirType in class Resource

copy

public Binary copy()

Specified by:

copy in class Resource

typedCopy

protected Binary typedCopy()

equalsDeep

public boolean equalsDeep(Base other)

Overrides:

equalsDeep in class Resource

equalsShallow

public boolean equalsShallow(Base other)

Overrides:

equalsShallow in class Resource

isEmpty

public boolean isEmpty()

Specified by:

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

Overrides:

isEmpty in class Resource

getResourceType

public ResourceType getResourceType()

Specified by:

getResourceType in class Resource