Package org.dcm4che.typeddicom.dataelements

Interface BackgroundIlluminationColorCodeSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

VisualFieldStaticPerimetryTestParametersModule

All Known Implementing Classes:

OphthalmicVisualFieldStaticPerimetryMeasurementsIOD, VisualFieldStaticPerimetryTestParametersModule.SimpleWrapper

Enclosing class:

BackgroundIlluminationColorCodeSequence

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

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static BackgroundIlluminationColorCodeSequence.Holder.Builder	builder()
static BackgroundIlluminationColorCodeSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsBackgroundIlluminationColorCodeSequence()
default BackgroundIlluminationColorCodeSequence	ensureBackgroundIlluminationColorCodeSequence()	Adds a new Background Illumination Color Code Sequence (see BackgroundIlluminationColorCodeSequence) with initial capacity 1 (see ensureBackgroundIlluminationColorCodeSequence(int)) if it does not already exist.
default BackgroundIlluminationColorCodeSequence	ensureBackgroundIlluminationColorCodeSequence(int initialCapacity)	Adds a new Background Illumination Color Code Sequence (see BackgroundIlluminationColorCodeSequence) if it does not already exist.
default BackgroundIlluminationColorCodeSequence	getBackgroundIlluminationColorCodeSequence()
default BackgroundIlluminationColorCodeSequence	newBackgroundIlluminationColorCodeSequence(int initialCapacity)	Adds a new Background Illumination Color Code Sequence.
default void	removeBackgroundIlluminationColorCodeSequence()	Removes the Background Illumination Color Code Sequence (see BackgroundIlluminationColorCodeSequence
static BackgroundIlluminationColorCodeSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

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

Returns:

a wrapper object implementing the BackgroundIlluminationColorCodeSequence.Holder interface.

builder

static BackgroundIlluminationColorCodeSequence.Holder.Builder builder()

Returns:

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

builder

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

Parameters:

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

Returns:

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

getBackgroundIlluminationColorCodeSequence

default BackgroundIlluminationColorCodeSequence getBackgroundIlluminationColorCodeSequence()

Returns:

the Background Illumination Color Code Sequence (see BackgroundIlluminationColorCodeSequence)

newBackgroundIlluminationColorCodeSequence

default BackgroundIlluminationColorCodeSequence newBackgroundIlluminationColorCodeSequence(int initialCapacity)

Adds a new Background Illumination Color Code Sequence. (see BackgroundIlluminationColorCodeSequence)

Parameters:

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

Returns:

the newly created BackgroundIlluminationColorCodeSequence.

ensureBackgroundIlluminationColorCodeSequence

default BackgroundIlluminationColorCodeSequence ensureBackgroundIlluminationColorCodeSequence(int initialCapacity)

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

Parameters:

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

Returns:

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

ensureBackgroundIlluminationColorCodeSequence

default BackgroundIlluminationColorCodeSequence ensureBackgroundIlluminationColorCodeSequence()

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

Returns:

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

containsBackgroundIlluminationColorCodeSequence

default boolean containsBackgroundIlluminationColorCodeSequence()

Returns:

whether it contains the Background Illumination Color Code Sequence (see BackgroundIlluminationColorCodeSequence)

removeBackgroundIlluminationColorCodeSequence

default void removeBackgroundIlluminationColorCodeSequence()

Removes the Background Illumination Color Code Sequence (see BackgroundIlluminationColorCodeSequence