Package org.dcm4che.typeddicom.dataelements

Interface TreatmentSiteModifierCodeSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Implementing Classes:

TreatmentSiteCodeSequence.Item, TreatmentSiteModifierCodeSequence.SimpleHolder

Enclosing class:

TreatmentSiteModifierCodeSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Treatment Site Modifier Code Sequence" (see TreatmentSiteModifierCodeSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static TreatmentSiteModifierCodeSequence.Holder.Builder	builder()
static TreatmentSiteModifierCodeSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsTreatmentSiteModifierCodeSequence()
default TreatmentSiteModifierCodeSequence	ensureTreatmentSiteModifierCodeSequence()	Adds a new Treatment Site Modifier Code Sequence (see TreatmentSiteModifierCodeSequence) with initial capacity 1 (see ensureTreatmentSiteModifierCodeSequence(int)) if it does not already exist.
default TreatmentSiteModifierCodeSequence	ensureTreatmentSiteModifierCodeSequence(int initialCapacity)	Adds a new Treatment Site Modifier Code Sequence (see TreatmentSiteModifierCodeSequence) if it does not already exist.
default TreatmentSiteModifierCodeSequence	getTreatmentSiteModifierCodeSequence()
default TreatmentSiteModifierCodeSequence	newTreatmentSiteModifierCodeSequence(int initialCapacity)	Adds a new Treatment Site Modifier Code Sequence.
default void	removeTreatmentSiteModifierCodeSequence()	Removes the Treatment Site Modifier Code Sequence (see TreatmentSiteModifierCodeSequence
static TreatmentSiteModifierCodeSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Treatment Site Modifier Code Sequence (see TreatmentSiteModifierCodeSequence)

Returns:

a wrapper object implementing the TreatmentSiteModifierCodeSequence.Holder interface.

builder

static TreatmentSiteModifierCodeSequence.Holder.Builder builder()

Returns:

a TreatmentSiteModifierCodeSequence.Holder.Builder to create Treatment Site Modifier Code Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a TreatmentSiteModifierCodeSequence.Holder.Builder to create Treatment Site Modifier Code Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getTreatmentSiteModifierCodeSequence

default TreatmentSiteModifierCodeSequence getTreatmentSiteModifierCodeSequence()

Returns:

the Treatment Site Modifier Code Sequence (see TreatmentSiteModifierCodeSequence)

newTreatmentSiteModifierCodeSequence

default TreatmentSiteModifierCodeSequence newTreatmentSiteModifierCodeSequence(int initialCapacity)

Adds a new Treatment Site Modifier Code Sequence. (see TreatmentSiteModifierCodeSequence)

Parameters:

initialCapacity - the initial capacity for the new Treatment Site Modifier Code Sequence

Returns:

the newly created TreatmentSiteModifierCodeSequence.

ensureTreatmentSiteModifierCodeSequence

default TreatmentSiteModifierCodeSequence ensureTreatmentSiteModifierCodeSequence(int initialCapacity)

Adds a new Treatment Site Modifier Code Sequence (see TreatmentSiteModifierCodeSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

initialCapacity - the initial capacity (see ArrayList(int)) if a new Treatment Site Modifier Code Sequence is created.

Returns:

either the already existing Treatment Site Modifier Code Sequence (see TreatmentSiteModifierCodeSequence) or a new one with capacity initialCapacity.

ensureTreatmentSiteModifierCodeSequence

default TreatmentSiteModifierCodeSequence ensureTreatmentSiteModifierCodeSequence()

Adds a new Treatment Site Modifier Code Sequence (see TreatmentSiteModifierCodeSequence) with initial capacity 1 (see ensureTreatmentSiteModifierCodeSequence(int)) if it does not already exist.

Returns:

either the already existing Treatment Site Modifier Code Sequence (see TreatmentSiteModifierCodeSequence) or a new one with capacity 1.

containsTreatmentSiteModifierCodeSequence

default boolean containsTreatmentSiteModifierCodeSequence()

Returns:

whether it contains the Treatment Site Modifier Code Sequence (see TreatmentSiteModifierCodeSequence)

removeTreatmentSiteModifierCodeSequence

default void removeTreatmentSiteModifierCodeSequence()

Removes the Treatment Site Modifier Code Sequence (see TreatmentSiteModifierCodeSequence