Package org.dcm4che.typeddicom.dataelements

Interface OverrideSequence.Holder

All Superinterfaces:

AttributesWrapper

All Known Implementing Classes:

BrachyControlPointDeliveredSequence.Item, BrachyPulseControlPointDeliveredSequence.Item, ControlPointDeliverySequence.Item, IonControlPointDeliverySequence.Item, OverrideSequence.SimpleHolder, TreatmentToleranceViolationSequence.Item

Enclosing class:

OverrideSequence

public static interface OverrideSequence.Holder
extends AttributesWrapper

A class implementing this interface can hold attributes which contain the DICOM tag "Override Sequence" (see OverrideSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static OverrideSequence.Holder.Builder	builder()
static OverrideSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsOverrideSequence()
default OverrideSequence	ensureOverrideSequence()	Adds a new Override Sequence (see OverrideSequence) with initial capacity 1 (see ensureOverrideSequence(int)) if it does not already exist.
default OverrideSequence	ensureOverrideSequence(int initialCapacity)	Adds a new Override Sequence (see OverrideSequence) if it does not already exist.
default OverrideSequence	getOverrideSequence()
default OverrideSequence	newOverrideSequence(int initialCapacity)	Adds a new Override Sequence.
default void	removeOverrideSequence()	Removes the Override Sequence (see OverrideSequence
static OverrideSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Details

wrap

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

Parameters:

attributes - An attributes object containing the Override Sequence (see OverrideSequence)

Returns:

A wrapper object implementing the OverrideSequence.Holder interface.

builder

static OverrideSequence.Holder.Builder builder()

Returns:

a OverrideSequence.Holder.Builder to create Override Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getOverrideSequence

default OverrideSequence getOverrideSequence()

Returns:

the Override Sequence (see OverrideSequence)

newOverrideSequence

default OverrideSequence newOverrideSequence(int initialCapacity)

Adds a new Override Sequence. (see OverrideSequence)

Parameters:

initialCapacity - the initial capacity for the new Override Sequence

ensureOverrideSequence

default OverrideSequence ensureOverrideSequence(int initialCapacity)

Adds a new Override Sequence (see OverrideSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

Either the already existing Override Sequence (see OverrideSequence) or a new one with capacity initialCapacity.

ensureOverrideSequence

default OverrideSequence ensureOverrideSequence()

Adds a new Override Sequence (see OverrideSequence) with initial capacity 1 (see ensureOverrideSequence(int)) if it does not already exist.

Returns:

Either the already existing Override Sequence (see OverrideSequence) or a new one with capacity 1.

containsOverrideSequence

default boolean containsOverrideSequence()

Returns:

Whether it contains the Override Sequence (see OverrideSequence)

removeOverrideSequence

default void removeOverrideSequence()

Removes the Override Sequence (see OverrideSequence