Package org.dcm4che.typeddicom.dataelements

Interface RelevantOPTAttributesSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

OphthalmicThicknessMapModule

All Known Implementing Classes:

OphthalmicThicknessMapIOD, OphthalmicThicknessMapModule.SimpleWrapper

Enclosing class:

RelevantOPTAttributesSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Relevant OPT Attributes Sequence" (see RelevantOPTAttributesSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static RelevantOPTAttributesSequence.Holder.Builder	builder()
static RelevantOPTAttributesSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsRelevantOPTAttributesSequence()
default RelevantOPTAttributesSequence	ensureRelevantOPTAttributesSequence()	Adds a new Relevant OPT Attributes Sequence (see RelevantOPTAttributesSequence) with initial capacity 1 (see ensureRelevantOPTAttributesSequence(int)) if it does not already exist.
default RelevantOPTAttributesSequence	ensureRelevantOPTAttributesSequence(int initialCapacity)	Adds a new Relevant OPT Attributes Sequence (see RelevantOPTAttributesSequence) if it does not already exist.
default RelevantOPTAttributesSequence	getRelevantOPTAttributesSequence()
default RelevantOPTAttributesSequence	newRelevantOPTAttributesSequence(int initialCapacity)	Adds a new Relevant OPT Attributes Sequence.
default void	removeRelevantOPTAttributesSequence()	Removes the Relevant OPT Attributes Sequence (see RelevantOPTAttributesSequence
static RelevantOPTAttributesSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Relevant OPT Attributes Sequence (see RelevantOPTAttributesSequence)

Returns:

a wrapper object implementing the RelevantOPTAttributesSequence.Holder interface.

builder

static RelevantOPTAttributesSequence.Holder.Builder builder()

Returns:

a RelevantOPTAttributesSequence.Holder.Builder to create Relevant OPT Attributes Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a RelevantOPTAttributesSequence.Holder.Builder to create Relevant OPT Attributes Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getRelevantOPTAttributesSequence

default RelevantOPTAttributesSequence getRelevantOPTAttributesSequence()

Returns:

the Relevant OPT Attributes Sequence (see RelevantOPTAttributesSequence)

newRelevantOPTAttributesSequence

default RelevantOPTAttributesSequence newRelevantOPTAttributesSequence(int initialCapacity)

Adds a new Relevant OPT Attributes Sequence. (see RelevantOPTAttributesSequence)

Parameters:

initialCapacity - the initial capacity for the new Relevant OPT Attributes Sequence

Returns:

the newly created RelevantOPTAttributesSequence.

ensureRelevantOPTAttributesSequence

default RelevantOPTAttributesSequence ensureRelevantOPTAttributesSequence(int initialCapacity)

Adds a new Relevant OPT Attributes Sequence (see RelevantOPTAttributesSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

initialCapacity - the initial capacity (see ArrayList(int)) if a new Relevant OPT Attributes Sequence is created.

Returns:

either the already existing Relevant OPT Attributes Sequence (see RelevantOPTAttributesSequence) or a new one with capacity initialCapacity.

ensureRelevantOPTAttributesSequence

default RelevantOPTAttributesSequence ensureRelevantOPTAttributesSequence()

Adds a new Relevant OPT Attributes Sequence (see RelevantOPTAttributesSequence) with initial capacity 1 (see ensureRelevantOPTAttributesSequence(int)) if it does not already exist.

Returns:

either the already existing Relevant OPT Attributes Sequence (see RelevantOPTAttributesSequence) or a new one with capacity 1.

containsRelevantOPTAttributesSequence

default boolean containsRelevantOPTAttributesSequence()

Returns:

whether it contains the Relevant OPT Attributes Sequence (see RelevantOPTAttributesSequence)

removeRelevantOPTAttributesSequence

default void removeRelevantOPTAttributesSequence()

Removes the Relevant OPT Attributes Sequence (see RelevantOPTAttributesSequence