Package org.dcm4che.typeddicom.dataelements

Interface RecordedCompensatorSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Implementing Classes:

GeneralMachineVerificationSequence.Item, TreatmentSessionBeamSequence.Item, TreatmentSessionIonBeamSequence.Item

Enclosing class:

RecordedCompensatorSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Recorded Compensator Sequence" (see RecordedCompensatorSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static RecordedCompensatorSequence.Holder.Builder	builder()
static RecordedCompensatorSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsRecordedCompensatorSequence()
default RecordedCompensatorSequence	ensureRecordedCompensatorSequence()	Adds a new Recorded Compensator Sequence (see RecordedCompensatorSequence) with initial capacity 1 (see ensureRecordedCompensatorSequence(int)) if it does not already exist.
default RecordedCompensatorSequence	ensureRecordedCompensatorSequence(int initialCapacity)	Adds a new Recorded Compensator Sequence (see RecordedCompensatorSequence) if it does not already exist.
default RecordedCompensatorSequence	getRecordedCompensatorSequence()
default RecordedCompensatorSequence	newRecordedCompensatorSequence(int initialCapacity)	Adds a new Recorded Compensator Sequence.
default void	removeRecordedCompensatorSequence()	Removes the Recorded Compensator Sequence (see RecordedCompensatorSequence
static RecordedCompensatorSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Recorded Compensator Sequence (see RecordedCompensatorSequence)

Returns:

a wrapper object implementing the RecordedCompensatorSequence.Holder interface.

builder

static RecordedCompensatorSequence.Holder.Builder builder()

Returns:

a RecordedCompensatorSequence.Holder.Builder to create Recorded Compensator Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getRecordedCompensatorSequence

default RecordedCompensatorSequence getRecordedCompensatorSequence()

Returns:

the Recorded Compensator Sequence (see RecordedCompensatorSequence)

newRecordedCompensatorSequence

default RecordedCompensatorSequence newRecordedCompensatorSequence(int initialCapacity)

Adds a new Recorded Compensator Sequence. (see RecordedCompensatorSequence)

Parameters:

initialCapacity - the initial capacity for the new Recorded Compensator Sequence

Returns:

the newly created RecordedCompensatorSequence.

ensureRecordedCompensatorSequence

default RecordedCompensatorSequence ensureRecordedCompensatorSequence(int initialCapacity)

Adds a new Recorded Compensator Sequence (see RecordedCompensatorSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Recorded Compensator Sequence (see RecordedCompensatorSequence) or a new one with capacity initialCapacity.

ensureRecordedCompensatorSequence

default RecordedCompensatorSequence ensureRecordedCompensatorSequence()

Adds a new Recorded Compensator Sequence (see RecordedCompensatorSequence) with initial capacity 1 (see ensureRecordedCompensatorSequence(int)) if it does not already exist.

Returns:

either the already existing Recorded Compensator Sequence (see RecordedCompensatorSequence) or a new one with capacity 1.

containsRecordedCompensatorSequence

default boolean containsRecordedCompensatorSequence()

Returns:

whether it contains the Recorded Compensator Sequence (see RecordedCompensatorSequence)

removeRecordedCompensatorSequence

default void removeRecordedCompensatorSequence()

Removes the Recorded Compensator Sequence (see RecordedCompensatorSequence