Package org.dcm4che.typeddicom.dataelements

Interface CompensatorDefinitionSequence.Holder

All Superinterfaces:

AttributesWrapper

All Known Subinterfaces:

CArmPhotonElectronDeliveryDeviceModule

All Known Implementing Classes:

CArmPhotonElectronRadiationIOD, CArmPhotonElectronRadiationRecordIOD, CompensatorDefinitionSequence.SimpleHolder

Enclosing class:

CompensatorDefinitionSequence

public static interface CompensatorDefinitionSequence.Holder
extends AttributesWrapper

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CompensatorDefinitionSequence.Holder.Builder	builder()
static CompensatorDefinitionSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsCompensatorDefinitionSequence()
default CompensatorDefinitionSequence	ensureCompensatorDefinitionSequence()	Adds a new Compensator Definition Sequence (see CompensatorDefinitionSequence) with initial capacity 1 (see ensureCompensatorDefinitionSequence(int)) if it does not already exist.
default CompensatorDefinitionSequence	ensureCompensatorDefinitionSequence(int initialCapacity)	Adds a new Compensator Definition Sequence (see CompensatorDefinitionSequence) if it does not already exist.
default CompensatorDefinitionSequence	getCompensatorDefinitionSequence()
default CompensatorDefinitionSequence	newCompensatorDefinitionSequence(int initialCapacity)	Adds a new Compensator Definition Sequence.
default void	removeCompensatorDefinitionSequence()	Removes the Compensator Definition Sequence (see CompensatorDefinitionSequence
static CompensatorDefinitionSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Details

wrap

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

Parameters:

attributes - An attributes object containing the Compensator Definition Sequence (see CompensatorDefinitionSequence)

Returns:

A wrapper object implementing the CompensatorDefinitionSequence.Holder interface.

builder

static CompensatorDefinitionSequence.Holder.Builder builder()

Returns:

a CompensatorDefinitionSequence.Holder.Builder to create Compensator Definition Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getCompensatorDefinitionSequence

default CompensatorDefinitionSequence getCompensatorDefinitionSequence()

Returns:

the Compensator Definition Sequence (see CompensatorDefinitionSequence)

newCompensatorDefinitionSequence

default CompensatorDefinitionSequence newCompensatorDefinitionSequence(int initialCapacity)

Adds a new Compensator Definition Sequence. (see CompensatorDefinitionSequence)

Parameters:

initialCapacity - the initial capacity for the new Compensator Definition Sequence

ensureCompensatorDefinitionSequence

default CompensatorDefinitionSequence ensureCompensatorDefinitionSequence(int initialCapacity)

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

Parameters:

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

Returns:

Either the already existing Compensator Definition Sequence (see CompensatorDefinitionSequence) or a new one with capacity initialCapacity.

ensureCompensatorDefinitionSequence

default CompensatorDefinitionSequence ensureCompensatorDefinitionSequence()

Adds a new Compensator Definition Sequence (see CompensatorDefinitionSequence) with initial capacity 1 (see ensureCompensatorDefinitionSequence(int)) if it does not already exist.

Returns:

Either the already existing Compensator Definition Sequence (see CompensatorDefinitionSequence) or a new one with capacity 1.

containsCompensatorDefinitionSequence

default boolean containsCompensatorDefinitionSequence()

Returns:

Whether it contains the Compensator Definition Sequence (see CompensatorDefinitionSequence)

removeCompensatorDefinitionSequence

default void removeCompensatorDefinitionSequence()

Removes the Compensator Definition Sequence (see CompensatorDefinitionSequence