Package org.dcm4che.typeddicom.dataelements

Interface StructuredDisplayTextBoxSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

StructuredDisplayAnnotationModule

All Known Implementing Classes:

BasicStructuredDisplayIOD, StructuredDisplayAnnotationModule.SimpleWrapper

Enclosing class:

StructuredDisplayTextBoxSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Structured Display Text Box Sequence" (see StructuredDisplayTextBoxSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static StructuredDisplayTextBoxSequence.Holder.Builder	builder()
static StructuredDisplayTextBoxSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsStructuredDisplayTextBoxSequence()
default StructuredDisplayTextBoxSequence	ensureStructuredDisplayTextBoxSequence()	Adds a new Structured Display Text Box Sequence (see StructuredDisplayTextBoxSequence) with initial capacity 1 (see ensureStructuredDisplayTextBoxSequence(int)) if it does not already exist.
default StructuredDisplayTextBoxSequence	ensureStructuredDisplayTextBoxSequence(int initialCapacity)	Adds a new Structured Display Text Box Sequence (see StructuredDisplayTextBoxSequence) if it does not already exist.
default StructuredDisplayTextBoxSequence	getStructuredDisplayTextBoxSequence()
default StructuredDisplayTextBoxSequence	newStructuredDisplayTextBoxSequence(int initialCapacity)	Adds a new Structured Display Text Box Sequence.
default void	removeStructuredDisplayTextBoxSequence()	Removes the Structured Display Text Box Sequence (see StructuredDisplayTextBoxSequence
static StructuredDisplayTextBoxSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Structured Display Text Box Sequence (see StructuredDisplayTextBoxSequence)

Returns:

a wrapper object implementing the StructuredDisplayTextBoxSequence.Holder interface.

builder

static StructuredDisplayTextBoxSequence.Holder.Builder builder()

Returns:

a StructuredDisplayTextBoxSequence.Holder.Builder to create Structured Display Text Box Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a StructuredDisplayTextBoxSequence.Holder.Builder to create Structured Display Text Box Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getStructuredDisplayTextBoxSequence

default StructuredDisplayTextBoxSequence getStructuredDisplayTextBoxSequence()

Returns:

the Structured Display Text Box Sequence (see StructuredDisplayTextBoxSequence)

newStructuredDisplayTextBoxSequence

default StructuredDisplayTextBoxSequence newStructuredDisplayTextBoxSequence(int initialCapacity)

Adds a new Structured Display Text Box Sequence. (see StructuredDisplayTextBoxSequence)

Parameters:

initialCapacity - the initial capacity for the new Structured Display Text Box Sequence

Returns:

the newly created StructuredDisplayTextBoxSequence.

ensureStructuredDisplayTextBoxSequence

default StructuredDisplayTextBoxSequence ensureStructuredDisplayTextBoxSequence(int initialCapacity)

Adds a new Structured Display Text Box Sequence (see StructuredDisplayTextBoxSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Structured Display Text Box Sequence (see StructuredDisplayTextBoxSequence) or a new one with capacity initialCapacity.

ensureStructuredDisplayTextBoxSequence

default StructuredDisplayTextBoxSequence ensureStructuredDisplayTextBoxSequence()

Adds a new Structured Display Text Box Sequence (see StructuredDisplayTextBoxSequence) with initial capacity 1 (see ensureStructuredDisplayTextBoxSequence(int)) if it does not already exist.

Returns:

either the already existing Structured Display Text Box Sequence (see StructuredDisplayTextBoxSequence) or a new one with capacity 1.

containsStructuredDisplayTextBoxSequence

default boolean containsStructuredDisplayTextBoxSequence()

Returns:

whether it contains the Structured Display Text Box Sequence (see StructuredDisplayTextBoxSequence)

removeStructuredDisplayTextBoxSequence

default void removeStructuredDisplayTextBoxSequence()

Removes the Structured Display Text Box Sequence (see StructuredDisplayTextBoxSequence