Package org.dcm4che.typeddicom.dataelements

Interface InterlockSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

RTRadiationRecordCommonModule

All Known Implementing Classes:

CArmPhotonElectronRadiationRecordIOD, InterlockSequence.SimpleHolder, RoboticArmRadiationRecordIOD, RTRadiationSalvageRecordIOD, TomotherapeuticRadiationRecordIOD, TreatmentSessionBeamSequence.Item

Enclosing class:

InterlockSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Interlock Sequence" (see InterlockSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static InterlockSequence.Holder.Builder	builder()
static InterlockSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsInterlockSequence()
default InterlockSequence	ensureInterlockSequence()	Adds a new Interlock Sequence (see InterlockSequence) with initial capacity 1 (see ensureInterlockSequence(int)) if it does not already exist.
default InterlockSequence	ensureInterlockSequence(int initialCapacity)	Adds a new Interlock Sequence (see InterlockSequence) if it does not already exist.
default InterlockSequence	getInterlockSequence()
default InterlockSequence	newInterlockSequence(int initialCapacity)	Adds a new Interlock Sequence.
default void	removeInterlockSequence()	Removes the Interlock Sequence (see InterlockSequence
static InterlockSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Interlock Sequence (see InterlockSequence)

Returns:

a wrapper object implementing the InterlockSequence.Holder interface.

builder

static InterlockSequence.Holder.Builder builder()

Returns:

a InterlockSequence.Holder.Builder to create Interlock Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getInterlockSequence

default InterlockSequence getInterlockSequence()

Returns:

the Interlock Sequence (see InterlockSequence)

newInterlockSequence

default InterlockSequence newInterlockSequence(int initialCapacity)

Adds a new Interlock Sequence. (see InterlockSequence)

Parameters:

initialCapacity - the initial capacity for the new Interlock Sequence

Returns:

the newly created InterlockSequence.

ensureInterlockSequence

default InterlockSequence ensureInterlockSequence(int initialCapacity)

Adds a new Interlock Sequence (see InterlockSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Interlock Sequence (see InterlockSequence) or a new one with capacity initialCapacity.

ensureInterlockSequence

default InterlockSequence ensureInterlockSequence()

Adds a new Interlock Sequence (see InterlockSequence) with initial capacity 1 (see ensureInterlockSequence(int)) if it does not already exist.

Returns:

either the already existing Interlock Sequence (see InterlockSequence) or a new one with capacity 1.

containsInterlockSequence

default boolean containsInterlockSequence()

Returns:

whether it contains the Interlock Sequence (see InterlockSequence)

removeInterlockSequence

default void removeInterlockSequence()

Removes the Interlock Sequence (see InterlockSequence