Package org.dcm4che.typeddicom.dataelements

Interface InstructionSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

InstructionsModule

All Known Implementing Classes:

CTDefinedProcedureProtocolIOD, CTPerformedProcedureProtocolIOD, InstructionSequence.SimpleHolder, XADefinedProcedureProtocolIOD, XAPerformedProcedureProtocolIOD

Enclosing class:

InstructionSequence

public static interface InstructionSequence.Holder
extends org.dcm4che.typeddicom.AttributesWrapper

A class implementing this interface can hold attributes which contain the DICOM tag "Instruction Sequence" (see InstructionSequence)

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	InstructionSequence.Holder.Builder

Method Summary

Modifier and Type	Method	Description
static InstructionSequence.Holder.Builder	builder()
static InstructionSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsInstructionSequence()
default InstructionSequence	ensureInstructionSequence()	Adds a new Instruction Sequence (see InstructionSequence) with initial capacity 1 (see ensureInstructionSequence(int)) if it does not already exist.
default InstructionSequence	ensureInstructionSequence(int initialCapacity)	Adds a new Instruction Sequence (see InstructionSequence) if it does not already exist.
default InstructionSequence	getInstructionSequence()
default InstructionSequence	newInstructionSequence(int initialCapacity)	Adds a new Instruction Sequence.
default void	removeInstructionSequence()	Removes the Instruction Sequence (see InstructionSequence
static InstructionSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

static InstructionSequence.Holder wrap(org.dcm4che3.data.Attributes attributes)

Parameters:

attributes - an attributes object containing the Instruction Sequence (see InstructionSequence)

Returns:

a wrapper object implementing the InstructionSequence.Holder interface.

builder

static InstructionSequence.Holder.Builder builder()

Returns:

a InstructionSequence.Holder.Builder to create Instruction Sequence Items with a fluent API.

builder

static InstructionSequence.Holder.Builder builder(org.dcm4che3.data.Attributes attributes)

Parameters:

attributes - the Attributes to be wrapped by the InstructionSequence.Holder.Builder.

Returns:

a InstructionSequence.Holder.Builder to create Instruction Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getInstructionSequence

default InstructionSequence getInstructionSequence()

Returns:

the Instruction Sequence (see InstructionSequence)

newInstructionSequence

default InstructionSequence newInstructionSequence(int initialCapacity)

Adds a new Instruction Sequence. (see InstructionSequence)

Parameters:

initialCapacity - the initial capacity for the new Instruction Sequence

Returns:

the newly created InstructionSequence.

ensureInstructionSequence

default InstructionSequence ensureInstructionSequence(int initialCapacity)

Adds a new Instruction Sequence (see InstructionSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

initialCapacity - the initial capacity (see ArrayList(int)) if a new Instruction Sequence is created.

Returns:

either the already existing Instruction Sequence (see InstructionSequence) or a new one with capacity initialCapacity.

ensureInstructionSequence

default InstructionSequence ensureInstructionSequence()

Adds a new Instruction Sequence (see InstructionSequence) with initial capacity 1 (see ensureInstructionSequence(int)) if it does not already exist.

Returns:

either the already existing Instruction Sequence (see InstructionSequence) or a new one with capacity 1.

containsInstructionSequence

default boolean containsInstructionSequence()

Returns:

whether it contains the Instruction Sequence (see InstructionSequence)

removeInstructionSequence

default void removeInstructionSequence()

Removes the Instruction Sequence (see InstructionSequence