Package org.dcm4che.typeddicom.dataelements

Interface TreatmentToleranceViolationSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

RTRadiationRecordCommonModule

All Known Implementing Classes:

CArmPhotonElectronRadiationRecordIOD, RoboticArmRadiationRecordIOD, RTRadiationSalvageRecordIOD, TomotherapeuticRadiationRecordIOD, TreatmentToleranceViolationSequence.SimpleHolder

Enclosing class:

TreatmentToleranceViolationSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Treatment Tolerance Violation Sequence" (see TreatmentToleranceViolationSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static TreatmentToleranceViolationSequence.Holder.Builder	builder()
static TreatmentToleranceViolationSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsTreatmentToleranceViolationSequence()
default TreatmentToleranceViolationSequence	ensureTreatmentToleranceViolationSequence()	Adds a new Treatment Tolerance Violation Sequence (see TreatmentToleranceViolationSequence) with initial capacity 1 (see ensureTreatmentToleranceViolationSequence(int)) if it does not already exist.
default TreatmentToleranceViolationSequence	ensureTreatmentToleranceViolationSequence(int initialCapacity)	Adds a new Treatment Tolerance Violation Sequence (see TreatmentToleranceViolationSequence) if it does not already exist.
default TreatmentToleranceViolationSequence	getTreatmentToleranceViolationSequence()
default TreatmentToleranceViolationSequence	newTreatmentToleranceViolationSequence(int initialCapacity)	Adds a new Treatment Tolerance Violation Sequence.
default void	removeTreatmentToleranceViolationSequence()	Removes the Treatment Tolerance Violation Sequence (see TreatmentToleranceViolationSequence
static TreatmentToleranceViolationSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Treatment Tolerance Violation Sequence (see TreatmentToleranceViolationSequence)

Returns:

a wrapper object implementing the TreatmentToleranceViolationSequence.Holder interface.

builder

static TreatmentToleranceViolationSequence.Holder.Builder builder()

Returns:

a TreatmentToleranceViolationSequence.Holder.Builder to create Treatment Tolerance Violation Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a TreatmentToleranceViolationSequence.Holder.Builder to create Treatment Tolerance Violation Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getTreatmentToleranceViolationSequence

default TreatmentToleranceViolationSequence getTreatmentToleranceViolationSequence()

Returns:

the Treatment Tolerance Violation Sequence (see TreatmentToleranceViolationSequence)

newTreatmentToleranceViolationSequence

default TreatmentToleranceViolationSequence newTreatmentToleranceViolationSequence(int initialCapacity)

Adds a new Treatment Tolerance Violation Sequence. (see TreatmentToleranceViolationSequence)

Parameters:

initialCapacity - the initial capacity for the new Treatment Tolerance Violation Sequence

Returns:

the newly created TreatmentToleranceViolationSequence.

ensureTreatmentToleranceViolationSequence

default TreatmentToleranceViolationSequence ensureTreatmentToleranceViolationSequence(int initialCapacity)

Adds a new Treatment Tolerance Violation Sequence (see TreatmentToleranceViolationSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

initialCapacity - the initial capacity (see ArrayList(int)) if a new Treatment Tolerance Violation Sequence is created.

Returns:

either the already existing Treatment Tolerance Violation Sequence (see TreatmentToleranceViolationSequence) or a new one with capacity initialCapacity.

ensureTreatmentToleranceViolationSequence

default TreatmentToleranceViolationSequence ensureTreatmentToleranceViolationSequence()

Adds a new Treatment Tolerance Violation Sequence (see TreatmentToleranceViolationSequence) with initial capacity 1 (see ensureTreatmentToleranceViolationSequence(int)) if it does not already exist.

Returns:

either the already existing Treatment Tolerance Violation Sequence (see TreatmentToleranceViolationSequence) or a new one with capacity 1.

containsTreatmentToleranceViolationSequence

default boolean containsTreatmentToleranceViolationSequence()

Returns:

whether it contains the Treatment Tolerance Violation Sequence (see TreatmentToleranceViolationSequence)

removeTreatmentToleranceViolationSequence

default void removeTreatmentToleranceViolationSequence()

Removes the Treatment Tolerance Violation Sequence (see TreatmentToleranceViolationSequence