Package org.dcm4che.typeddicom.dataelements

Interface StimulusColorCodeSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

VisualFieldStaticPerimetryTestParametersModule

All Known Implementing Classes:

OphthalmicVisualFieldStaticPerimetryMeasurementsIOD, VisualFieldStaticPerimetryTestParametersModule.SimpleWrapper

Enclosing class:

StimulusColorCodeSequence

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

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static StimulusColorCodeSequence.Holder.Builder	builder()
static StimulusColorCodeSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsStimulusColorCodeSequence()
default StimulusColorCodeSequence	ensureStimulusColorCodeSequence()	Adds a new Stimulus Color Code Sequence (see StimulusColorCodeSequence) with initial capacity 1 (see ensureStimulusColorCodeSequence(int)) if it does not already exist.
default StimulusColorCodeSequence	ensureStimulusColorCodeSequence(int initialCapacity)	Adds a new Stimulus Color Code Sequence (see StimulusColorCodeSequence) if it does not already exist.
default StimulusColorCodeSequence	getStimulusColorCodeSequence()
default StimulusColorCodeSequence	newStimulusColorCodeSequence(int initialCapacity)	Adds a new Stimulus Color Code Sequence.
default void	removeStimulusColorCodeSequence()	Removes the Stimulus Color Code Sequence (see StimulusColorCodeSequence
static StimulusColorCodeSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Stimulus Color Code Sequence (see StimulusColorCodeSequence)

Returns:

a wrapper object implementing the StimulusColorCodeSequence.Holder interface.

builder

static StimulusColorCodeSequence.Holder.Builder builder()

Returns:

a StimulusColorCodeSequence.Holder.Builder to create Stimulus Color Code Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getStimulusColorCodeSequence

default StimulusColorCodeSequence getStimulusColorCodeSequence()

Returns:

the Stimulus Color Code Sequence (see StimulusColorCodeSequence)

newStimulusColorCodeSequence

default StimulusColorCodeSequence newStimulusColorCodeSequence(int initialCapacity)

Adds a new Stimulus Color Code Sequence. (see StimulusColorCodeSequence)

Parameters:

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

Returns:

the newly created StimulusColorCodeSequence.

ensureStimulusColorCodeSequence

default StimulusColorCodeSequence ensureStimulusColorCodeSequence(int initialCapacity)

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

Parameters:

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

Returns:

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

ensureStimulusColorCodeSequence

default StimulusColorCodeSequence ensureStimulusColorCodeSequence()

Adds a new Stimulus Color Code Sequence (see StimulusColorCodeSequence) with initial capacity 1 (see ensureStimulusColorCodeSequence(int)) if it does not already exist.

Returns:

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

containsStimulusColorCodeSequence

default boolean containsStimulusColorCodeSequence()

Returns:

whether it contains the Stimulus Color Code Sequence (see StimulusColorCodeSequence)

removeStimulusColorCodeSequence

default void removeStimulusColorCodeSequence()

Removes the Stimulus Color Code Sequence (see StimulusColorCodeSequence