Package org.dcm4che.typeddicom.dataelements

Interface ConfirmationSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

RTRadiationRecordCommonModule

All Known Implementing Classes:

CArmPhotonElectronRadiationRecordIOD, ConfirmationSequence.SimpleHolder, RoboticArmRadiationRecordIOD, RTRadiationSalvageRecordIOD, TomotherapeuticRadiationRecordIOD

Enclosing class:

ConfirmationSequence

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

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ConfirmationSequence.Holder.Builder	builder()
static ConfirmationSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsConfirmationSequence()
default ConfirmationSequence	ensureConfirmationSequence()	Adds a new Confirmation Sequence (see ConfirmationSequence) with initial capacity 1 (see ensureConfirmationSequence(int)) if it does not already exist.
default ConfirmationSequence	ensureConfirmationSequence(int initialCapacity)	Adds a new Confirmation Sequence (see ConfirmationSequence) if it does not already exist.
default ConfirmationSequence	getConfirmationSequence()
default ConfirmationSequence	newConfirmationSequence(int initialCapacity)	Adds a new Confirmation Sequence.
default void	removeConfirmationSequence()	Removes the Confirmation Sequence (see ConfirmationSequence
static ConfirmationSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Confirmation Sequence (see ConfirmationSequence)

Returns:

a wrapper object implementing the ConfirmationSequence.Holder interface.

builder

static ConfirmationSequence.Holder.Builder builder()

Returns:

a ConfirmationSequence.Holder.Builder to create Confirmation Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getConfirmationSequence

default ConfirmationSequence getConfirmationSequence()

Returns:

the Confirmation Sequence (see ConfirmationSequence)

newConfirmationSequence

default ConfirmationSequence newConfirmationSequence(int initialCapacity)

Adds a new Confirmation Sequence. (see ConfirmationSequence)

Parameters:

initialCapacity - the initial capacity for the new Confirmation Sequence

Returns:

the newly created ConfirmationSequence.

ensureConfirmationSequence

default ConfirmationSequence ensureConfirmationSequence(int initialCapacity)

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

Parameters:

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

Returns:

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

ensureConfirmationSequence

default ConfirmationSequence ensureConfirmationSequence()

Adds a new Confirmation Sequence (see ConfirmationSequence) with initial capacity 1 (see ensureConfirmationSequence(int)) if it does not already exist.

Returns:

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

containsConfirmationSequence

default boolean containsConfirmationSequence()

Returns:

whether it contains the Confirmation Sequence (see ConfirmationSequence)

removeConfirmationSequence

default void removeConfirmationSequence()

Removes the Confirmation Sequence (see ConfirmationSequence