Class MessageHeader.Destination.Builder
- java.lang.Object
-
- org.linuxforhealth.fhir.model.builder.AbstractBuilder<Element>
-
- org.linuxforhealth.fhir.model.type.Element.Builder
-
- org.linuxforhealth.fhir.model.type.BackboneElement.Builder
-
- org.linuxforhealth.fhir.model.resource.MessageHeader.Destination.Builder
-
- Enclosing class:
- MessageHeader.Destination
public static class MessageHeader.Destination.Builder extends BackboneElement.Builder
-
-
Field Summary
-
Fields inherited from class org.linuxforhealth.fhir.model.type.BackboneElement.Builder
modifierExtension
-
Fields inherited from class org.linuxforhealth.fhir.model.type.Element.Builder
extension, id
-
Fields inherited from class org.linuxforhealth.fhir.model.builder.AbstractBuilder
validating
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description MessageHeader.Destination
build()
Build theMessageHeader.Destination
MessageHeader.Destination.Builder
endpoint(Url endpoint)
Indicates where the message should be routed to.MessageHeader.Destination.Builder
extension(java.util.Collection<Extension> extension)
May be used to represent additional information that is not part of the basic definition of the element.MessageHeader.Destination.Builder
extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the element.protected MessageHeader.Destination.Builder
from(MessageHeader.Destination destination)
MessageHeader.Destination.Builder
id(java.lang.String id)
Unique id for the element within a resource (for internal references).MessageHeader.Destination.Builder
modifierExtension(java.util.Collection<Extension> modifierExtension)
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants.MessageHeader.Destination.Builder
modifierExtension(Extension... modifierExtension)
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants.MessageHeader.Destination.Builder
name(java.lang.String name)
Convenience method for settingname
.MessageHeader.Destination.Builder
name(String name)
Human-readable name for the target system.MessageHeader.Destination.Builder
receiver(Reference receiver)
Allows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn't sufficient.MessageHeader.Destination.Builder
target(Reference target)
Identifies the target end system in situations where the initial message transmission is to an intermediary system.protected void
validate(MessageHeader.Destination destination)
-
Methods inherited from class org.linuxforhealth.fhir.model.type.BackboneElement.Builder
from, validate
-
Methods inherited from class org.linuxforhealth.fhir.model.type.Element.Builder
from, validate
-
Methods inherited from class org.linuxforhealth.fhir.model.builder.AbstractBuilder
isValidating, setValidating
-
-
-
-
Method Detail
-
id
public MessageHeader.Destination.Builder id(java.lang.String id)
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.- Overrides:
id
in classBackboneElement.Builder
- Parameters:
id
- Unique id for inter-element referencing- Returns:
- A reference to this Builder instance
-
extension
public MessageHeader.Destination.Builder extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Overrides:
extension
in classBackboneElement.Builder
- Parameters:
extension
- Additional content defined by implementations- Returns:
- A reference to this Builder instance
-
extension
public MessageHeader.Destination.Builder extension(java.util.Collection<Extension> extension)
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.- Overrides:
extension
in classBackboneElement.Builder
- Parameters:
extension
- Additional content defined by implementations- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
modifierExtension
public MessageHeader.Destination.Builder modifierExtension(Extension... modifierExtension)
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Overrides:
modifierExtension
in classBackboneElement.Builder
- Parameters:
modifierExtension
- Extensions that cannot be ignored even if unrecognized- Returns:
- A reference to this Builder instance
-
modifierExtension
public MessageHeader.Destination.Builder modifierExtension(java.util.Collection<Extension> modifierExtension)
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.- Overrides:
modifierExtension
in classBackboneElement.Builder
- Parameters:
modifierExtension
- Extensions that cannot be ignored even if unrecognized- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
name
public MessageHeader.Destination.Builder name(java.lang.String name)
Convenience method for settingname
.- Parameters:
name
- Name of system- Returns:
- A reference to this Builder instance
- See Also:
name(org.linuxforhealth.fhir.model.type.String)
-
name
public MessageHeader.Destination.Builder name(String name)
Human-readable name for the target system.- Parameters:
name
- Name of system- Returns:
- A reference to this Builder instance
-
target
public MessageHeader.Destination.Builder target(Reference target)
Identifies the target end system in situations where the initial message transmission is to an intermediary system.Allowed resource types for this reference:
- Parameters:
target
- Particular delivery destination within the destination- Returns:
- A reference to this Builder instance
-
endpoint
public MessageHeader.Destination.Builder endpoint(Url endpoint)
Indicates where the message should be routed to.This element is required.
- Parameters:
endpoint
- Actual destination address or id- Returns:
- A reference to this Builder instance
-
receiver
public MessageHeader.Destination.Builder receiver(Reference receiver)
Allows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn't sufficient.Allowed resource types for this reference:
- Parameters:
receiver
- Intended "real-world" recipient for the data- Returns:
- A reference to this Builder instance
-
build
public MessageHeader.Destination build()
- Specified by:
build
in interfaceBuilder<Element>
- Specified by:
build
in classBackboneElement.Builder
- Returns:
- An immutable object of type
MessageHeader.Destination
- Throws:
java.lang.IllegalStateException
- if the current state cannot be built into a valid Destination per the base specification
-
validate
protected void validate(MessageHeader.Destination destination)
-
from
protected MessageHeader.Destination.Builder from(MessageHeader.Destination destination)
-
-