Package org.dcm4che.typeddicom.dataelements

Interface ContourSequence.Holder

All Superinterfaces:

AttributesWrapper

All Known Implementing Classes:

ContourSequence.SimpleHolder, ROIContourSequence.Item

Enclosing class:

ContourSequence

public static interface ContourSequence.Holder
extends AttributesWrapper

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ContourSequence.Holder.Builder	builder()
static ContourSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsContourSequence()
default ContourSequence	ensureContourSequence()	Adds a new Contour Sequence (see ContourSequence) with initial capacity 1 (see ensureContourSequence(int)) if it does not already exist.
default ContourSequence	ensureContourSequence(int initialCapacity)	Adds a new Contour Sequence (see ContourSequence) if it does not already exist.
default ContourSequence	getContourSequence()
default ContourSequence	newContourSequence(int initialCapacity)	Adds a new Contour Sequence.
default void	removeContourSequence()	Removes the Contour Sequence (see ContourSequence
static ContourSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Details

wrap

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

Parameters:

attributes - An attributes object containing the Contour Sequence (see ContourSequence)

Returns:

A wrapper object implementing the ContourSequence.Holder interface.

builder

static ContourSequence.Holder.Builder builder()

Returns:

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

builder

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

Parameters:

attributes - The Attributes to be wrapped by the ContourSequence.Holder.Builder.

Returns:

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

getContourSequence

default ContourSequence getContourSequence()

Returns:

the Contour Sequence (see ContourSequence)

newContourSequence

default ContourSequence newContourSequence(int initialCapacity)

Adds a new Contour Sequence. (see ContourSequence)

Parameters:

initialCapacity - the initial capacity for the new Contour Sequence

ensureContourSequence

default ContourSequence ensureContourSequence(int initialCapacity)

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

Parameters:

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

Returns:

Either the already existing Contour Sequence (see ContourSequence) or a new one with capacity initialCapacity.

ensureContourSequence

default ContourSequence ensureContourSequence()

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

Returns:

Either the already existing Contour Sequence (see ContourSequence) or a new one with capacity 1.

containsContourSequence

default boolean containsContourSequence()

Returns:

Whether it contains the Contour Sequence (see ContourSequence)

removeContourSequence

default void removeContourSequence()

Removes the Contour Sequence (see ContourSequence