Package org.dcm4che.typeddicom.dataelements

Interface ContourImageSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Implementing Classes:

ContourImageSequence.SimpleHolder, ContourSequence.Item, RTReferencedSeriesSequence.Item

Enclosing class:

ContourImageSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Contour Image Sequence" (see ContourImageSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ContourImageSequence.Holder.Builder	builder()
static ContourImageSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsContourImageSequence()
default ContourImageSequence	ensureContourImageSequence()	Adds a new Contour Image Sequence (see ContourImageSequence) with initial capacity 1 (see ensureContourImageSequence(int)) if it does not already exist.
default ContourImageSequence	ensureContourImageSequence(int initialCapacity)	Adds a new Contour Image Sequence (see ContourImageSequence) if it does not already exist.
default ContourImageSequence	getContourImageSequence()
default ContourImageSequence	newContourImageSequence(int initialCapacity)	Adds a new Contour Image Sequence.
default void	removeContourImageSequence()	Removes the Contour Image Sequence (see ContourImageSequence
static ContourImageSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Contour Image Sequence (see ContourImageSequence)

Returns:

a wrapper object implementing the ContourImageSequence.Holder interface.

builder

static ContourImageSequence.Holder.Builder builder()

Returns:

a ContourImageSequence.Holder.Builder to create Contour Image Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getContourImageSequence

default ContourImageSequence getContourImageSequence()

Returns:

the Contour Image Sequence (see ContourImageSequence)

newContourImageSequence

default ContourImageSequence newContourImageSequence(int initialCapacity)

Adds a new Contour Image Sequence. (see ContourImageSequence)

Parameters:

initialCapacity - the initial capacity for the new Contour Image Sequence

Returns:

the newly created ContourImageSequence.

ensureContourImageSequence

default ContourImageSequence ensureContourImageSequence(int initialCapacity)

Adds a new Contour Image Sequence (see ContourImageSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Contour Image Sequence (see ContourImageSequence) or a new one with capacity initialCapacity.

ensureContourImageSequence

default ContourImageSequence ensureContourImageSequence()

Adds a new Contour Image Sequence (see ContourImageSequence) with initial capacity 1 (see ensureContourImageSequence(int)) if it does not already exist.

Returns:

either the already existing Contour Image Sequence (see ContourImageSequence) or a new one with capacity 1.

containsContourImageSequence

default boolean containsContourImageSequence()

Returns:

whether it contains the Contour Image Sequence (see ContourImageSequence)

removeContourImageSequence

default void removeContourImageSequence()

Removes the Contour Image Sequence (see ContourImageSequence