Package org.dcm4che.typeddicom.dataelements

Interface IlluminationTypeCodeSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

OphthalmicPhotographicParametersModule

All Known Implementing Classes:

IlluminationTypeCodeSequence.SimpleHolder, OphthalmicPhotography16BitImageIOD, OphthalmicPhotography8BitImageIOD, OpticalPathSequence.Item, WideFieldOphthalmicPhotography3DCoordinatesImageIOD, WideFieldOphthalmicPhotographyStereographicProjectionImageIOD

Enclosing class:

IlluminationTypeCodeSequence

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

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static IlluminationTypeCodeSequence.Holder.Builder	builder()
static IlluminationTypeCodeSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsIlluminationTypeCodeSequence()
default IlluminationTypeCodeSequence	ensureIlluminationTypeCodeSequence()	Adds a new Illumination Type Code Sequence (see IlluminationTypeCodeSequence) with initial capacity 1 (see ensureIlluminationTypeCodeSequence(int)) if it does not already exist.
default IlluminationTypeCodeSequence	ensureIlluminationTypeCodeSequence(int initialCapacity)	Adds a new Illumination Type Code Sequence (see IlluminationTypeCodeSequence) if it does not already exist.
default IlluminationTypeCodeSequence	getIlluminationTypeCodeSequence()
default IlluminationTypeCodeSequence	newIlluminationTypeCodeSequence(int initialCapacity)	Adds a new Illumination Type Code Sequence.
default void	removeIlluminationTypeCodeSequence()	Removes the Illumination Type Code Sequence (see IlluminationTypeCodeSequence
static IlluminationTypeCodeSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Illumination Type Code Sequence (see IlluminationTypeCodeSequence)

Returns:

a wrapper object implementing the IlluminationTypeCodeSequence.Holder interface.

builder

static IlluminationTypeCodeSequence.Holder.Builder builder()

Returns:

a IlluminationTypeCodeSequence.Holder.Builder to create Illumination Type Code Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getIlluminationTypeCodeSequence

default IlluminationTypeCodeSequence getIlluminationTypeCodeSequence()

Returns:

the Illumination Type Code Sequence (see IlluminationTypeCodeSequence)

newIlluminationTypeCodeSequence

default IlluminationTypeCodeSequence newIlluminationTypeCodeSequence(int initialCapacity)

Adds a new Illumination Type Code Sequence. (see IlluminationTypeCodeSequence)

Parameters:

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

Returns:

the newly created IlluminationTypeCodeSequence.

ensureIlluminationTypeCodeSequence

default IlluminationTypeCodeSequence ensureIlluminationTypeCodeSequence(int initialCapacity)

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

Parameters:

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

Returns:

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

ensureIlluminationTypeCodeSequence

default IlluminationTypeCodeSequence ensureIlluminationTypeCodeSequence()

Adds a new Illumination Type Code Sequence (see IlluminationTypeCodeSequence) with initial capacity 1 (see ensureIlluminationTypeCodeSequence(int)) if it does not already exist.

Returns:

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

containsIlluminationTypeCodeSequence

default boolean containsIlluminationTypeCodeSequence()

Returns:

whether it contains the Illumination Type Code Sequence (see IlluminationTypeCodeSequence)

removeIlluminationTypeCodeSequence

default void removeIlluminationTypeCodeSequence()

Removes the Illumination Type Code Sequence (see IlluminationTypeCodeSequence