Package org.dcm4che.typeddicom.dataelements

Interface StructuredDisplayImageBoxSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

StructuredDisplayImageBoxModule

All Known Implementing Classes:

BasicStructuredDisplayIOD, StructuredDisplayImageBoxModule.SimpleWrapper

Enclosing class:

StructuredDisplayImageBoxSequence

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

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static StructuredDisplayImageBoxSequence.Holder.Builder	builder()
static StructuredDisplayImageBoxSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsStructuredDisplayImageBoxSequence()
default StructuredDisplayImageBoxSequence	ensureStructuredDisplayImageBoxSequence()	Adds a new Structured Display Image Box Sequence (see StructuredDisplayImageBoxSequence) with initial capacity 1 (see ensureStructuredDisplayImageBoxSequence(int)) if it does not already exist.
default StructuredDisplayImageBoxSequence	ensureStructuredDisplayImageBoxSequence(int initialCapacity)	Adds a new Structured Display Image Box Sequence (see StructuredDisplayImageBoxSequence) if it does not already exist.
default StructuredDisplayImageBoxSequence	getStructuredDisplayImageBoxSequence()
default StructuredDisplayImageBoxSequence	newStructuredDisplayImageBoxSequence(int initialCapacity)	Adds a new Structured Display Image Box Sequence.
default void	removeStructuredDisplayImageBoxSequence()	Removes the Structured Display Image Box Sequence (see StructuredDisplayImageBoxSequence
static StructuredDisplayImageBoxSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Structured Display Image Box Sequence (see StructuredDisplayImageBoxSequence)

Returns:

a wrapper object implementing the StructuredDisplayImageBoxSequence.Holder interface.

builder

static StructuredDisplayImageBoxSequence.Holder.Builder builder()

Returns:

a StructuredDisplayImageBoxSequence.Holder.Builder to create Structured Display Image Box Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getStructuredDisplayImageBoxSequence

default StructuredDisplayImageBoxSequence getStructuredDisplayImageBoxSequence()

Returns:

the Structured Display Image Box Sequence (see StructuredDisplayImageBoxSequence)

newStructuredDisplayImageBoxSequence

default StructuredDisplayImageBoxSequence newStructuredDisplayImageBoxSequence(int initialCapacity)

Adds a new Structured Display Image Box Sequence. (see StructuredDisplayImageBoxSequence)

Parameters:

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

Returns:

the newly created StructuredDisplayImageBoxSequence.

ensureStructuredDisplayImageBoxSequence

default StructuredDisplayImageBoxSequence ensureStructuredDisplayImageBoxSequence(int initialCapacity)

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

Parameters:

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

Returns:

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

ensureStructuredDisplayImageBoxSequence

default StructuredDisplayImageBoxSequence ensureStructuredDisplayImageBoxSequence()

Adds a new Structured Display Image Box Sequence (see StructuredDisplayImageBoxSequence) with initial capacity 1 (see ensureStructuredDisplayImageBoxSequence(int)) if it does not already exist.

Returns:

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

containsStructuredDisplayImageBoxSequence

default boolean containsStructuredDisplayImageBoxSequence()

Returns:

whether it contains the Structured Display Image Box Sequence (see StructuredDisplayImageBoxSequence)

removeStructuredDisplayImageBoxSequence

default void removeStructuredDisplayImageBoxSequence()

Removes the Structured Display Image Box Sequence (see StructuredDisplayImageBoxSequence