Package org.dcm4che.typeddicom.dataelements

Interface LensesCodeSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

OphthalmicPhotographicParametersModule

All Known Implementing Classes:

OphthalmicPhotographicParametersModule.SimpleWrapper, OphthalmicPhotography16BitImageIOD, OphthalmicPhotography8BitImageIOD, OpticalPathSequence.Item, WideFieldOphthalmicPhotography3DCoordinatesImageIOD, WideFieldOphthalmicPhotographyStereographicProjectionImageIOD

Enclosing class:

LensesCodeSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Lenses Code Sequence" (see LensesCodeSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static LensesCodeSequence.Holder.Builder	builder()
static LensesCodeSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsLensesCodeSequence()
default LensesCodeSequence	ensureLensesCodeSequence()	Adds a new Lenses Code Sequence (see LensesCodeSequence) with initial capacity 1 (see ensureLensesCodeSequence(int)) if it does not already exist.
default LensesCodeSequence	ensureLensesCodeSequence(int initialCapacity)	Adds a new Lenses Code Sequence (see LensesCodeSequence) if it does not already exist.
default LensesCodeSequence	getLensesCodeSequence()
default LensesCodeSequence	newLensesCodeSequence(int initialCapacity)	Adds a new Lenses Code Sequence.
default void	removeLensesCodeSequence()	Removes the Lenses Code Sequence (see LensesCodeSequence
static LensesCodeSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Lenses Code Sequence (see LensesCodeSequence)

Returns:

a wrapper object implementing the LensesCodeSequence.Holder interface.

builder

static LensesCodeSequence.Holder.Builder builder()

Returns:

a LensesCodeSequence.Holder.Builder to create Lenses Code Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getLensesCodeSequence

default LensesCodeSequence getLensesCodeSequence()

Returns:

the Lenses Code Sequence (see LensesCodeSequence)

newLensesCodeSequence

default LensesCodeSequence newLensesCodeSequence(int initialCapacity)

Adds a new Lenses Code Sequence. (see LensesCodeSequence)

Parameters:

initialCapacity - the initial capacity for the new Lenses Code Sequence

Returns:

the newly created LensesCodeSequence.

ensureLensesCodeSequence

default LensesCodeSequence ensureLensesCodeSequence(int initialCapacity)

Adds a new Lenses Code Sequence (see LensesCodeSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Lenses Code Sequence (see LensesCodeSequence) or a new one with capacity initialCapacity.

ensureLensesCodeSequence

default LensesCodeSequence ensureLensesCodeSequence()

Adds a new Lenses Code Sequence (see LensesCodeSequence) with initial capacity 1 (see ensureLensesCodeSequence(int)) if it does not already exist.

Returns:

either the already existing Lenses Code Sequence (see LensesCodeSequence) or a new one with capacity 1.

containsLensesCodeSequence

default boolean containsLensesCodeSequence()

Returns:

whether it contains the Lenses Code Sequence (see LensesCodeSequence)

removeLensesCodeSequence

default void removeLensesCodeSequence()

Removes the Lenses Code Sequence (see LensesCodeSequence