Package org.dcm4che.typeddicom.dataelements

Interface ThreatROIVoxelSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Implementing Classes:

ThreatROIVoxelSequence.SimpleHolder

Enclosing class:

ThreatROIVoxelSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Threat ROI Voxel Sequence" (see ThreatROIVoxelSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ThreatROIVoxelSequence.Holder.Builder	builder()
static ThreatROIVoxelSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsThreatROIVoxelSequence()
default ThreatROIVoxelSequence	ensureThreatROIVoxelSequence()	Adds a new Threat ROI Voxel Sequence (see ThreatROIVoxelSequence) with initial capacity 1 (see ensureThreatROIVoxelSequence(int)) if it does not already exist.
default ThreatROIVoxelSequence	ensureThreatROIVoxelSequence(int initialCapacity)	Adds a new Threat ROI Voxel Sequence (see ThreatROIVoxelSequence) if it does not already exist.
default ThreatROIVoxelSequence	getThreatROIVoxelSequence()
default ThreatROIVoxelSequence	newThreatROIVoxelSequence(int initialCapacity)	Adds a new Threat ROI Voxel Sequence.
default void	removeThreatROIVoxelSequence()	Removes the Threat ROI Voxel Sequence (see ThreatROIVoxelSequence
static ThreatROIVoxelSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Threat ROI Voxel Sequence (see ThreatROIVoxelSequence)

Returns:

a wrapper object implementing the ThreatROIVoxelSequence.Holder interface.

builder

static ThreatROIVoxelSequence.Holder.Builder builder()

Returns:

a ThreatROIVoxelSequence.Holder.Builder to create Threat ROI Voxel Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a ThreatROIVoxelSequence.Holder.Builder to create Threat ROI Voxel Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getThreatROIVoxelSequence

default ThreatROIVoxelSequence getThreatROIVoxelSequence()

Returns:

the Threat ROI Voxel Sequence (see ThreatROIVoxelSequence)

newThreatROIVoxelSequence

default ThreatROIVoxelSequence newThreatROIVoxelSequence(int initialCapacity)

Adds a new Threat ROI Voxel Sequence. (see ThreatROIVoxelSequence)

Parameters:

initialCapacity - the initial capacity for the new Threat ROI Voxel Sequence

Returns:

the newly created ThreatROIVoxelSequence.

ensureThreatROIVoxelSequence

default ThreatROIVoxelSequence ensureThreatROIVoxelSequence(int initialCapacity)

Adds a new Threat ROI Voxel Sequence (see ThreatROIVoxelSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Threat ROI Voxel Sequence (see ThreatROIVoxelSequence) or a new one with capacity initialCapacity.

ensureThreatROIVoxelSequence

default ThreatROIVoxelSequence ensureThreatROIVoxelSequence()

Adds a new Threat ROI Voxel Sequence (see ThreatROIVoxelSequence) with initial capacity 1 (see ensureThreatROIVoxelSequence(int)) if it does not already exist.

Returns:

either the already existing Threat ROI Voxel Sequence (see ThreatROIVoxelSequence) or a new one with capacity 1.

containsThreatROIVoxelSequence

default boolean containsThreatROIVoxelSequence()

Returns:

whether it contains the Threat ROI Voxel Sequence (see ThreatROIVoxelSequence)

removeThreatROIVoxelSequence

default void removeThreatROIVoxelSequence()

Removes the Threat ROI Voxel Sequence (see ThreatROIVoxelSequence