Package org.dcm4che.typeddicom.dataelements

Interface ApplicatorSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Implementing Classes:

BeamSequence.Item, ExposureSequence.Item, GeneralMachineVerificationSequence.Item, IonBeamSequence.Item, TreatmentSessionBeamSequence.Item, TreatmentSessionIonBeamSequence.Item

Enclosing class:

ApplicatorSequence

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

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ApplicatorSequence.Holder.Builder	builder()
static ApplicatorSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsApplicatorSequence()
default ApplicatorSequence	ensureApplicatorSequence()	Adds a new Applicator Sequence (see ApplicatorSequence) with initial capacity 1 (see ensureApplicatorSequence(int)) if it does not already exist.
default ApplicatorSequence	ensureApplicatorSequence(int initialCapacity)	Adds a new Applicator Sequence (see ApplicatorSequence) if it does not already exist.
default ApplicatorSequence	getApplicatorSequence()
default ApplicatorSequence	newApplicatorSequence(int initialCapacity)	Adds a new Applicator Sequence.
default void	removeApplicatorSequence()	Removes the Applicator Sequence (see ApplicatorSequence
static ApplicatorSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Applicator Sequence (see ApplicatorSequence)

Returns:

a wrapper object implementing the ApplicatorSequence.Holder interface.

builder

static ApplicatorSequence.Holder.Builder builder()

Returns:

a ApplicatorSequence.Holder.Builder to create Applicator Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getApplicatorSequence

default ApplicatorSequence getApplicatorSequence()

Returns:

the Applicator Sequence (see ApplicatorSequence)

newApplicatorSequence

default ApplicatorSequence newApplicatorSequence(int initialCapacity)

Adds a new Applicator Sequence. (see ApplicatorSequence)

Parameters:

initialCapacity - the initial capacity for the new Applicator Sequence

Returns:

the newly created ApplicatorSequence.

ensureApplicatorSequence

default ApplicatorSequence ensureApplicatorSequence(int initialCapacity)

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

Parameters:

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

Returns:

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

ensureApplicatorSequence

default ApplicatorSequence ensureApplicatorSequence()

Adds a new Applicator Sequence (see ApplicatorSequence) with initial capacity 1 (see ensureApplicatorSequence(int)) if it does not already exist.

Returns:

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

containsApplicatorSequence

default boolean containsApplicatorSequence()

Returns:

whether it contains the Applicator Sequence (see ApplicatorSequence)

removeApplicatorSequence

default void removeApplicatorSequence()

Removes the Applicator Sequence (see ApplicatorSequence