Package org.dcm4che.typeddicom.dataelements

Interface IlluminationColorCodeSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Implementing Classes:

IlluminationColorCodeSequence.SimpleHolder, OpticalPathSequence.Item

Enclosing class:

IlluminationColorCodeSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Illumination Color Code Sequence" (see IlluminationColorCodeSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static IlluminationColorCodeSequence.Holder.Builder	builder()
static IlluminationColorCodeSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsIlluminationColorCodeSequence()
default IlluminationColorCodeSequence	ensureIlluminationColorCodeSequence()	Adds a new Illumination Color Code Sequence (see IlluminationColorCodeSequence) with initial capacity 1 (see ensureIlluminationColorCodeSequence(int)) if it does not already exist.
default IlluminationColorCodeSequence	ensureIlluminationColorCodeSequence(int initialCapacity)	Adds a new Illumination Color Code Sequence (see IlluminationColorCodeSequence) if it does not already exist.
default IlluminationColorCodeSequence	getIlluminationColorCodeSequence()
default IlluminationColorCodeSequence	newIlluminationColorCodeSequence(int initialCapacity)	Adds a new Illumination Color Code Sequence.
default void	removeIlluminationColorCodeSequence()	Removes the Illumination Color Code Sequence (see IlluminationColorCodeSequence
static IlluminationColorCodeSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Illumination Color Code Sequence (see IlluminationColorCodeSequence)

Returns:

a wrapper object implementing the IlluminationColorCodeSequence.Holder interface.

builder

static IlluminationColorCodeSequence.Holder.Builder builder()

Returns:

a IlluminationColorCodeSequence.Holder.Builder to create Illumination Color Code Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a IlluminationColorCodeSequence.Holder.Builder to create Illumination Color Code Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getIlluminationColorCodeSequence

default IlluminationColorCodeSequence getIlluminationColorCodeSequence()

Returns:

the Illumination Color Code Sequence (see IlluminationColorCodeSequence)

newIlluminationColorCodeSequence

default IlluminationColorCodeSequence newIlluminationColorCodeSequence(int initialCapacity)

Adds a new Illumination Color Code Sequence. (see IlluminationColorCodeSequence)

Parameters:

initialCapacity - the initial capacity for the new Illumination Color Code Sequence

Returns:

the newly created IlluminationColorCodeSequence.

ensureIlluminationColorCodeSequence

default IlluminationColorCodeSequence ensureIlluminationColorCodeSequence(int initialCapacity)

Adds a new Illumination Color Code Sequence (see IlluminationColorCodeSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Illumination Color Code Sequence (see IlluminationColorCodeSequence) or a new one with capacity initialCapacity.

ensureIlluminationColorCodeSequence

default IlluminationColorCodeSequence ensureIlluminationColorCodeSequence()

Adds a new Illumination Color Code Sequence (see IlluminationColorCodeSequence) with initial capacity 1 (see ensureIlluminationColorCodeSequence(int)) if it does not already exist.

Returns:

either the already existing Illumination Color Code Sequence (see IlluminationColorCodeSequence) or a new one with capacity 1.

containsIlluminationColorCodeSequence

default boolean containsIlluminationColorCodeSequence()

Returns:

whether it contains the Illumination Color Code Sequence (see IlluminationColorCodeSequence)

removeIlluminationColorCodeSequence

default void removeIlluminationColorCodeSequence()

Removes the Illumination Color Code Sequence (see IlluminationColorCodeSequence