Package org.dcm4che.typeddicom.dataelements

Interface ReferencedRTTreatmentPhaseSequence.Holder

All Superinterfaces:

AttributesWrapper

All Known Implementing Classes:

ReferencedRTTreatmentPhaseSequence.SimpleHolder, RTPrescriptionSequence.Item

Enclosing class:

ReferencedRTTreatmentPhaseSequence

public static interface ReferencedRTTreatmentPhaseSequence.Holder
extends AttributesWrapper

A class implementing this interface can hold attributes which contain the DICOM tag "Referenced RT Treatment Phase Sequence" (see ReferencedRTTreatmentPhaseSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ReferencedRTTreatmentPhaseSequence.Holder.Builder	builder()
static ReferencedRTTreatmentPhaseSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsReferencedRTTreatmentPhaseSequence()
default ReferencedRTTreatmentPhaseSequence	ensureReferencedRTTreatmentPhaseSequence()	Adds a new Referenced RT Treatment Phase Sequence (see ReferencedRTTreatmentPhaseSequence) with initial capacity 1 (see ensureReferencedRTTreatmentPhaseSequence(int)) if it does not already exist.
default ReferencedRTTreatmentPhaseSequence	ensureReferencedRTTreatmentPhaseSequence(int initialCapacity)	Adds a new Referenced RT Treatment Phase Sequence (see ReferencedRTTreatmentPhaseSequence) if it does not already exist.
default ReferencedRTTreatmentPhaseSequence	getReferencedRTTreatmentPhaseSequence()
default ReferencedRTTreatmentPhaseSequence	newReferencedRTTreatmentPhaseSequence(int initialCapacity)	Adds a new Referenced RT Treatment Phase Sequence.
default void	removeReferencedRTTreatmentPhaseSequence()	Removes the Referenced RT Treatment Phase Sequence (see ReferencedRTTreatmentPhaseSequence
static ReferencedRTTreatmentPhaseSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Details

wrap

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

Parameters:

attributes - An attributes object containing the Referenced RT Treatment Phase Sequence (see ReferencedRTTreatmentPhaseSequence)

Returns:

A wrapper object implementing the ReferencedRTTreatmentPhaseSequence.Holder interface.

builder

static ReferencedRTTreatmentPhaseSequence.Holder.Builder builder()

Returns:

a ReferencedRTTreatmentPhaseSequence.Holder.Builder to create Referenced RT Treatment Phase Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a ReferencedRTTreatmentPhaseSequence.Holder.Builder to create Referenced RT Treatment Phase Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getReferencedRTTreatmentPhaseSequence

default ReferencedRTTreatmentPhaseSequence getReferencedRTTreatmentPhaseSequence()

Returns:

the Referenced RT Treatment Phase Sequence (see ReferencedRTTreatmentPhaseSequence)

newReferencedRTTreatmentPhaseSequence

default ReferencedRTTreatmentPhaseSequence newReferencedRTTreatmentPhaseSequence(int initialCapacity)

Adds a new Referenced RT Treatment Phase Sequence. (see ReferencedRTTreatmentPhaseSequence)

Parameters:

initialCapacity - the initial capacity for the new Referenced RT Treatment Phase Sequence

ensureReferencedRTTreatmentPhaseSequence

default ReferencedRTTreatmentPhaseSequence ensureReferencedRTTreatmentPhaseSequence(int initialCapacity)

Adds a new Referenced RT Treatment Phase Sequence (see ReferencedRTTreatmentPhaseSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

initialCapacity - The initial capacity (see ArrayList(int)) if a new Referenced RT Treatment Phase Sequence is created.

Returns:

Either the already existing Referenced RT Treatment Phase Sequence (see ReferencedRTTreatmentPhaseSequence) or a new one with capacity initialCapacity.

ensureReferencedRTTreatmentPhaseSequence

default ReferencedRTTreatmentPhaseSequence ensureReferencedRTTreatmentPhaseSequence()

Adds a new Referenced RT Treatment Phase Sequence (see ReferencedRTTreatmentPhaseSequence) with initial capacity 1 (see ensureReferencedRTTreatmentPhaseSequence(int)) if it does not already exist.

Returns:

Either the already existing Referenced RT Treatment Phase Sequence (see ReferencedRTTreatmentPhaseSequence) or a new one with capacity 1.

containsReferencedRTTreatmentPhaseSequence

default boolean containsReferencedRTTreatmentPhaseSequence()

Returns:

Whether it contains the Referenced RT Treatment Phase Sequence (see ReferencedRTTreatmentPhaseSequence)

removeReferencedRTTreatmentPhaseSequence

default void removeReferencedRTTreatmentPhaseSequence()

Removes the Referenced RT Treatment Phase Sequence (see ReferencedRTTreatmentPhaseSequence