Package org.dcm4che.typeddicom.dataelements

Interface DoseValuesSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Implementing Classes:

RadiationDoseValuesParametersSequence.Item

Enclosing class:

DoseValuesSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Dose Values Sequence" (see DoseValuesSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static DoseValuesSequence.Holder.Builder	builder()
static DoseValuesSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsDoseValuesSequence()
default DoseValuesSequence	ensureDoseValuesSequence()	Adds a new Dose Values Sequence (see DoseValuesSequence) with initial capacity 1 (see ensureDoseValuesSequence(int)) if it does not already exist.
default DoseValuesSequence	ensureDoseValuesSequence(int initialCapacity)	Adds a new Dose Values Sequence (see DoseValuesSequence) if it does not already exist.
default DoseValuesSequence	getDoseValuesSequence()
default DoseValuesSequence	newDoseValuesSequence(int initialCapacity)	Adds a new Dose Values Sequence.
default void	removeDoseValuesSequence()	Removes the Dose Values Sequence (see DoseValuesSequence
static DoseValuesSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Dose Values Sequence (see DoseValuesSequence)

Returns:

a wrapper object implementing the DoseValuesSequence.Holder interface.

builder

static DoseValuesSequence.Holder.Builder builder()

Returns:

a DoseValuesSequence.Holder.Builder to create Dose Values Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getDoseValuesSequence

default DoseValuesSequence getDoseValuesSequence()

Returns:

the Dose Values Sequence (see DoseValuesSequence)

newDoseValuesSequence

default DoseValuesSequence newDoseValuesSequence(int initialCapacity)

Adds a new Dose Values Sequence. (see DoseValuesSequence)

Parameters:

initialCapacity - the initial capacity for the new Dose Values Sequence

Returns:

the newly created DoseValuesSequence.

ensureDoseValuesSequence

default DoseValuesSequence ensureDoseValuesSequence(int initialCapacity)

Adds a new Dose Values Sequence (see DoseValuesSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Dose Values Sequence (see DoseValuesSequence) or a new one with capacity initialCapacity.

ensureDoseValuesSequence

default DoseValuesSequence ensureDoseValuesSequence()

Adds a new Dose Values Sequence (see DoseValuesSequence) with initial capacity 1 (see ensureDoseValuesSequence(int)) if it does not already exist.

Returns:

either the already existing Dose Values Sequence (see DoseValuesSequence) or a new one with capacity 1.

containsDoseValuesSequence

default boolean containsDoseValuesSequence()

Returns:

whether it contains the Dose Values Sequence (see DoseValuesSequence)

removeDoseValuesSequence

default void removeDoseValuesSequence()

Removes the Dose Values Sequence (see DoseValuesSequence