Package org.dcm4che.typeddicom.dataelements

Interface RTProtocolCodeSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Implementing Classes:

RTPhysicianIntentSequence.Item

Enclosing class:

RTProtocolCodeSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "RT Protocol Code Sequence" (see RTProtocolCodeSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static RTProtocolCodeSequence.Holder.Builder	builder()
static RTProtocolCodeSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsRTProtocolCodeSequence()
default RTProtocolCodeSequence	ensureRTProtocolCodeSequence()	Adds a new RT Protocol Code Sequence (see RTProtocolCodeSequence) with initial capacity 1 (see ensureRTProtocolCodeSequence(int)) if it does not already exist.
default RTProtocolCodeSequence	ensureRTProtocolCodeSequence(int initialCapacity)	Adds a new RT Protocol Code Sequence (see RTProtocolCodeSequence) if it does not already exist.
default RTProtocolCodeSequence	getRTProtocolCodeSequence()
default RTProtocolCodeSequence	newRTProtocolCodeSequence(int initialCapacity)	Adds a new RT Protocol Code Sequence.
default void	removeRTProtocolCodeSequence()	Removes the RT Protocol Code Sequence (see RTProtocolCodeSequence
static RTProtocolCodeSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the RT Protocol Code Sequence (see RTProtocolCodeSequence)

Returns:

a wrapper object implementing the RTProtocolCodeSequence.Holder interface.

builder

static RTProtocolCodeSequence.Holder.Builder builder()

Returns:

a RTProtocolCodeSequence.Holder.Builder to create RT Protocol Code Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a RTProtocolCodeSequence.Holder.Builder to create RT Protocol Code Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getRTProtocolCodeSequence

default RTProtocolCodeSequence getRTProtocolCodeSequence()

Returns:

the RT Protocol Code Sequence (see RTProtocolCodeSequence)

newRTProtocolCodeSequence

default RTProtocolCodeSequence newRTProtocolCodeSequence(int initialCapacity)

Adds a new RT Protocol Code Sequence. (see RTProtocolCodeSequence)

Parameters:

initialCapacity - the initial capacity for the new RT Protocol Code Sequence

Returns:

the newly created RTProtocolCodeSequence.

ensureRTProtocolCodeSequence

default RTProtocolCodeSequence ensureRTProtocolCodeSequence(int initialCapacity)

Adds a new RT Protocol Code Sequence (see RTProtocolCodeSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

initialCapacity - the initial capacity (see ArrayList(int)) if a new RT Protocol Code Sequence is created.

Returns:

either the already existing RT Protocol Code Sequence (see RTProtocolCodeSequence) or a new one with capacity initialCapacity.

ensureRTProtocolCodeSequence

default RTProtocolCodeSequence ensureRTProtocolCodeSequence()

Adds a new RT Protocol Code Sequence (see RTProtocolCodeSequence) with initial capacity 1 (see ensureRTProtocolCodeSequence(int)) if it does not already exist.

Returns:

either the already existing RT Protocol Code Sequence (see RTProtocolCodeSequence) or a new one with capacity 1.

containsRTProtocolCodeSequence

default boolean containsRTProtocolCodeSequence()

Returns:

whether it contains the RT Protocol Code Sequence (see RTProtocolCodeSequence)

removeRTProtocolCodeSequence

default void removeRTProtocolCodeSequence()

Removes the RT Protocol Code Sequence (see RTProtocolCodeSequence