Package org.dcm4che.typeddicom.dataelements

Interface IlluminatorTypeCodeSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Implementing Classes:

OpticalPathSequence.Item

Enclosing class:

IlluminatorTypeCodeSequence

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

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static IlluminatorTypeCodeSequence.Holder.Builder	builder()
static IlluminatorTypeCodeSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsIlluminatorTypeCodeSequence()
default IlluminatorTypeCodeSequence	ensureIlluminatorTypeCodeSequence()	Adds a new Illuminator Type Code Sequence (see IlluminatorTypeCodeSequence) with initial capacity 1 (see ensureIlluminatorTypeCodeSequence(int)) if it does not already exist.
default IlluminatorTypeCodeSequence	ensureIlluminatorTypeCodeSequence(int initialCapacity)	Adds a new Illuminator Type Code Sequence (see IlluminatorTypeCodeSequence) if it does not already exist.
default IlluminatorTypeCodeSequence	getIlluminatorTypeCodeSequence()
default IlluminatorTypeCodeSequence	newIlluminatorTypeCodeSequence(int initialCapacity)	Adds a new Illuminator Type Code Sequence.
default void	removeIlluminatorTypeCodeSequence()	Removes the Illuminator Type Code Sequence (see IlluminatorTypeCodeSequence
static IlluminatorTypeCodeSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Illuminator Type Code Sequence (see IlluminatorTypeCodeSequence)

Returns:

a wrapper object implementing the IlluminatorTypeCodeSequence.Holder interface.

builder

static IlluminatorTypeCodeSequence.Holder.Builder builder()

Returns:

a IlluminatorTypeCodeSequence.Holder.Builder to create Illuminator Type Code Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getIlluminatorTypeCodeSequence

default IlluminatorTypeCodeSequence getIlluminatorTypeCodeSequence()

Returns:

the Illuminator Type Code Sequence (see IlluminatorTypeCodeSequence)

newIlluminatorTypeCodeSequence

default IlluminatorTypeCodeSequence newIlluminatorTypeCodeSequence(int initialCapacity)

Adds a new Illuminator Type Code Sequence. (see IlluminatorTypeCodeSequence)

Parameters:

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

Returns:

the newly created IlluminatorTypeCodeSequence.

ensureIlluminatorTypeCodeSequence

default IlluminatorTypeCodeSequence ensureIlluminatorTypeCodeSequence(int initialCapacity)

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

Parameters:

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

Returns:

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

ensureIlluminatorTypeCodeSequence

default IlluminatorTypeCodeSequence ensureIlluminatorTypeCodeSequence()

Adds a new Illuminator Type Code Sequence (see IlluminatorTypeCodeSequence) with initial capacity 1 (see ensureIlluminatorTypeCodeSequence(int)) if it does not already exist.

Returns:

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

containsIlluminatorTypeCodeSequence

default boolean containsIlluminatorTypeCodeSequence()

Returns:

whether it contains the Illuminator Type Code Sequence (see IlluminatorTypeCodeSequence)

removeIlluminatorTypeCodeSequence

default void removeIlluminatorTypeCodeSequence()

Removes the Illuminator Type Code Sequence (see IlluminatorTypeCodeSequence