Package org.dcm4che.typeddicom.dataelements

Interface TextObjectSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Implementing Classes:

GraphicAnnotationSequence.Item, TextObjectSequence.SimpleHolder, VolumetricAnnotationSequence.Item, VolumetricPresentationInputAnnotationSequence.Item

Enclosing class:

TextObjectSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Text Object Sequence" (see TextObjectSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static TextObjectSequence.Holder.Builder	builder()
static TextObjectSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsTextObjectSequence()
default TextObjectSequence	ensureTextObjectSequence()	Adds a new Text Object Sequence (see TextObjectSequence) with initial capacity 1 (see ensureTextObjectSequence(int)) if it does not already exist.
default TextObjectSequence	ensureTextObjectSequence(int initialCapacity)	Adds a new Text Object Sequence (see TextObjectSequence) if it does not already exist.
default TextObjectSequence	getTextObjectSequence()
default TextObjectSequence	newTextObjectSequence(int initialCapacity)	Adds a new Text Object Sequence.
default void	removeTextObjectSequence()	Removes the Text Object Sequence (see TextObjectSequence
static TextObjectSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Text Object Sequence (see TextObjectSequence)

Returns:

a wrapper object implementing the TextObjectSequence.Holder interface.

builder

static TextObjectSequence.Holder.Builder builder()

Returns:

a TextObjectSequence.Holder.Builder to create Text Object Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a TextObjectSequence.Holder.Builder to create Text Object Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getTextObjectSequence

default TextObjectSequence getTextObjectSequence()

Returns:

the Text Object Sequence (see TextObjectSequence)

newTextObjectSequence

default TextObjectSequence newTextObjectSequence(int initialCapacity)

Adds a new Text Object Sequence. (see TextObjectSequence)

Parameters:

initialCapacity - the initial capacity for the new Text Object Sequence

Returns:

the newly created TextObjectSequence.

ensureTextObjectSequence

default TextObjectSequence ensureTextObjectSequence(int initialCapacity)

Adds a new Text Object Sequence (see TextObjectSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Text Object Sequence (see TextObjectSequence) or a new one with capacity initialCapacity.

ensureTextObjectSequence

default TextObjectSequence ensureTextObjectSequence()

Adds a new Text Object Sequence (see TextObjectSequence) with initial capacity 1 (see ensureTextObjectSequence(int)) if it does not already exist.

Returns:

either the already existing Text Object Sequence (see TextObjectSequence) or a new one with capacity 1.

containsTextObjectSequence

default boolean containsTextObjectSequence()

Returns:

whether it contains the Text Object Sequence (see TextObjectSequence)

removeTextObjectSequence

default void removeTextObjectSequence()

Removes the Text Object Sequence (see TextObjectSequence