Package org.dcm4che.typeddicom.dataelements

Interface RadiobiologicalDoseEffectSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Implementing Classes:

DosimetricObjectiveParameterSequence.Item, RadiobiologicalDoseEffectSequence.SimpleHolder

Enclosing class:

RadiobiologicalDoseEffectSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Radiobiological Dose Effect Sequence" (see RadiobiologicalDoseEffectSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static RadiobiologicalDoseEffectSequence.Holder.Builder	builder()
static RadiobiologicalDoseEffectSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsRadiobiologicalDoseEffectSequence()
default RadiobiologicalDoseEffectSequence	ensureRadiobiologicalDoseEffectSequence()	Adds a new Radiobiological Dose Effect Sequence (see RadiobiologicalDoseEffectSequence) with initial capacity 1 (see ensureRadiobiologicalDoseEffectSequence(int)) if it does not already exist.
default RadiobiologicalDoseEffectSequence	ensureRadiobiologicalDoseEffectSequence(int initialCapacity)	Adds a new Radiobiological Dose Effect Sequence (see RadiobiologicalDoseEffectSequence) if it does not already exist.
default RadiobiologicalDoseEffectSequence	getRadiobiologicalDoseEffectSequence()
default RadiobiologicalDoseEffectSequence	newRadiobiologicalDoseEffectSequence(int initialCapacity)	Adds a new Radiobiological Dose Effect Sequence.
default void	removeRadiobiologicalDoseEffectSequence()	Removes the Radiobiological Dose Effect Sequence (see RadiobiologicalDoseEffectSequence
static RadiobiologicalDoseEffectSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Radiobiological Dose Effect Sequence (see RadiobiologicalDoseEffectSequence)

Returns:

a wrapper object implementing the RadiobiologicalDoseEffectSequence.Holder interface.

builder

static RadiobiologicalDoseEffectSequence.Holder.Builder builder()

Returns:

a RadiobiologicalDoseEffectSequence.Holder.Builder to create Radiobiological Dose Effect Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a RadiobiologicalDoseEffectSequence.Holder.Builder to create Radiobiological Dose Effect Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getRadiobiologicalDoseEffectSequence

default RadiobiologicalDoseEffectSequence getRadiobiologicalDoseEffectSequence()

Returns:

the Radiobiological Dose Effect Sequence (see RadiobiologicalDoseEffectSequence)

newRadiobiologicalDoseEffectSequence

default RadiobiologicalDoseEffectSequence newRadiobiologicalDoseEffectSequence(int initialCapacity)

Adds a new Radiobiological Dose Effect Sequence. (see RadiobiologicalDoseEffectSequence)

Parameters:

initialCapacity - the initial capacity for the new Radiobiological Dose Effect Sequence

Returns:

the newly created RadiobiologicalDoseEffectSequence.

ensureRadiobiologicalDoseEffectSequence

default RadiobiologicalDoseEffectSequence ensureRadiobiologicalDoseEffectSequence(int initialCapacity)

Adds a new Radiobiological Dose Effect Sequence (see RadiobiologicalDoseEffectSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Radiobiological Dose Effect Sequence (see RadiobiologicalDoseEffectSequence) or a new one with capacity initialCapacity.

ensureRadiobiologicalDoseEffectSequence

default RadiobiologicalDoseEffectSequence ensureRadiobiologicalDoseEffectSequence()

Adds a new Radiobiological Dose Effect Sequence (see RadiobiologicalDoseEffectSequence) with initial capacity 1 (see ensureRadiobiologicalDoseEffectSequence(int)) if it does not already exist.

Returns:

either the already existing Radiobiological Dose Effect Sequence (see RadiobiologicalDoseEffectSequence) or a new one with capacity 1.

containsRadiobiologicalDoseEffectSequence

default boolean containsRadiobiologicalDoseEffectSequence()

Returns:

whether it contains the Radiobiological Dose Effect Sequence (see RadiobiologicalDoseEffectSequence)

removeRadiobiologicalDoseEffectSequence

default void removeRadiobiologicalDoseEffectSequence()

Removes the Radiobiological Dose Effect Sequence (see RadiobiologicalDoseEffectSequence