Package org.dcm4che.typeddicom.dataelements

Interface RecordedRangeModulatorSequence.Holder

All Superinterfaces:

AttributesWrapper

All Known Implementing Classes:

IonMachineVerificationSequence.Item, RecordedRangeModulatorSequence.SimpleHolder, TreatmentSessionIonBeamSequence.Item

Enclosing class:

RecordedRangeModulatorSequence

public static interface RecordedRangeModulatorSequence.Holder
extends AttributesWrapper

A class implementing this interface can hold attributes which contain the DICOM tag "Recorded Range Modulator Sequence" (see RecordedRangeModulatorSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static RecordedRangeModulatorSequence.Holder.Builder	builder()
static RecordedRangeModulatorSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsRecordedRangeModulatorSequence()
default RecordedRangeModulatorSequence	ensureRecordedRangeModulatorSequence()	Adds a new Recorded Range Modulator Sequence (see RecordedRangeModulatorSequence) with initial capacity 1 (see ensureRecordedRangeModulatorSequence(int)) if it does not already exist.
default RecordedRangeModulatorSequence	ensureRecordedRangeModulatorSequence(int initialCapacity)	Adds a new Recorded Range Modulator Sequence (see RecordedRangeModulatorSequence) if it does not already exist.
default RecordedRangeModulatorSequence	getRecordedRangeModulatorSequence()
default RecordedRangeModulatorSequence	newRecordedRangeModulatorSequence(int initialCapacity)	Adds a new Recorded Range Modulator Sequence.
default void	removeRecordedRangeModulatorSequence()	Removes the Recorded Range Modulator Sequence (see RecordedRangeModulatorSequence
static RecordedRangeModulatorSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Details

wrap

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

Parameters:

attributes - An attributes object containing the Recorded Range Modulator Sequence (see RecordedRangeModulatorSequence)

Returns:

A wrapper object implementing the RecordedRangeModulatorSequence.Holder interface.

builder

static RecordedRangeModulatorSequence.Holder.Builder builder()

Returns:

a RecordedRangeModulatorSequence.Holder.Builder to create Recorded Range Modulator Sequence Items with a fluent API.

builder

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

Parameters:

attributes - The Attributes to be wrapped by the RecordedRangeModulatorSequence.Holder.Builder.

Returns:

a RecordedRangeModulatorSequence.Holder.Builder to create Recorded Range Modulator Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getRecordedRangeModulatorSequence

default RecordedRangeModulatorSequence getRecordedRangeModulatorSequence()

Returns:

the Recorded Range Modulator Sequence (see RecordedRangeModulatorSequence)

newRecordedRangeModulatorSequence

default RecordedRangeModulatorSequence newRecordedRangeModulatorSequence(int initialCapacity)

Adds a new Recorded Range Modulator Sequence. (see RecordedRangeModulatorSequence)

Parameters:

initialCapacity - the initial capacity for the new Recorded Range Modulator Sequence

ensureRecordedRangeModulatorSequence

default RecordedRangeModulatorSequence ensureRecordedRangeModulatorSequence(int initialCapacity)

Adds a new Recorded Range Modulator Sequence (see RecordedRangeModulatorSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

initialCapacity - The initial capacity (see ArrayList(int)) if a new Recorded Range Modulator Sequence is created.

Returns:

Either the already existing Recorded Range Modulator Sequence (see RecordedRangeModulatorSequence) or a new one with capacity initialCapacity.

ensureRecordedRangeModulatorSequence

default RecordedRangeModulatorSequence ensureRecordedRangeModulatorSequence()

Adds a new Recorded Range Modulator Sequence (see RecordedRangeModulatorSequence) with initial capacity 1 (see ensureRecordedRangeModulatorSequence(int)) if it does not already exist.

Returns:

Either the already existing Recorded Range Modulator Sequence (see RecordedRangeModulatorSequence) or a new one with capacity 1.

containsRecordedRangeModulatorSequence

default boolean containsRecordedRangeModulatorSequence()

Returns:

Whether it contains the Recorded Range Modulator Sequence (see RecordedRangeModulatorSequence)

removeRecordedRangeModulatorSequence

default void removeRecordedRangeModulatorSequence()

Removes the Recorded Range Modulator Sequence (see RecordedRangeModulatorSequence