Package org.dcm4che.typeddicom.dataelements

Interface BrachyTaskSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

RTBrachyApplicationSetupDeliveryInstructionModule

All Known Implementing Classes:

RTBrachyApplicationSetupDeliveryInstructionIOD, RTBrachyApplicationSetupDeliveryInstructionModule.SimpleWrapper

Enclosing class:

BrachyTaskSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Brachy Task Sequence" (see BrachyTaskSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static BrachyTaskSequence.Holder.Builder	builder()
static BrachyTaskSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsBrachyTaskSequence()
default BrachyTaskSequence	ensureBrachyTaskSequence()	Adds a new Brachy Task Sequence (see BrachyTaskSequence) with initial capacity 1 (see ensureBrachyTaskSequence(int)) if it does not already exist.
default BrachyTaskSequence	ensureBrachyTaskSequence(int initialCapacity)	Adds a new Brachy Task Sequence (see BrachyTaskSequence) if it does not already exist.
default BrachyTaskSequence	getBrachyTaskSequence()
default BrachyTaskSequence	newBrachyTaskSequence(int initialCapacity)	Adds a new Brachy Task Sequence.
default void	removeBrachyTaskSequence()	Removes the Brachy Task Sequence (see BrachyTaskSequence
static BrachyTaskSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Brachy Task Sequence (see BrachyTaskSequence)

Returns:

a wrapper object implementing the BrachyTaskSequence.Holder interface.

builder

static BrachyTaskSequence.Holder.Builder builder()

Returns:

a BrachyTaskSequence.Holder.Builder to create Brachy Task Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getBrachyTaskSequence

default BrachyTaskSequence getBrachyTaskSequence()

Returns:

the Brachy Task Sequence (see BrachyTaskSequence)

newBrachyTaskSequence

default BrachyTaskSequence newBrachyTaskSequence(int initialCapacity)

Adds a new Brachy Task Sequence. (see BrachyTaskSequence)

Parameters:

initialCapacity - the initial capacity for the new Brachy Task Sequence

Returns:

the newly created BrachyTaskSequence.

ensureBrachyTaskSequence

default BrachyTaskSequence ensureBrachyTaskSequence(int initialCapacity)

Adds a new Brachy Task Sequence (see BrachyTaskSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Brachy Task Sequence (see BrachyTaskSequence) or a new one with capacity initialCapacity.

ensureBrachyTaskSequence

default BrachyTaskSequence ensureBrachyTaskSequence()

Adds a new Brachy Task Sequence (see BrachyTaskSequence) with initial capacity 1 (see ensureBrachyTaskSequence(int)) if it does not already exist.

Returns:

either the already existing Brachy Task Sequence (see BrachyTaskSequence) or a new one with capacity 1.

containsBrachyTaskSequence

default boolean containsBrachyTaskSequence()

Returns:

whether it contains the Brachy Task Sequence (see BrachyTaskSequence)

removeBrachyTaskSequence

default void removeBrachyTaskSequence()

Removes the Brachy Task Sequence (see BrachyTaskSequence