Package org.dcm4che.typeddicom.dataelements

Interface ReferencedImageBoxSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

BasicFilmBoxRelationshipModule

All Known Implementing Classes:

BasicFilmBoxIOD, BasicFilmBoxRelationshipModule.SimpleWrapper

Enclosing class:

ReferencedImageBoxSequence

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

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ReferencedImageBoxSequence.Holder.Builder	builder()
static ReferencedImageBoxSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsReferencedImageBoxSequence()
default ReferencedImageBoxSequence	ensureReferencedImageBoxSequence()	Adds a new Referenced Image Box Sequence (see ReferencedImageBoxSequence) with initial capacity 1 (see ensureReferencedImageBoxSequence(int)) if it does not already exist.
default ReferencedImageBoxSequence	ensureReferencedImageBoxSequence(int initialCapacity)	Adds a new Referenced Image Box Sequence (see ReferencedImageBoxSequence) if it does not already exist.
default ReferencedImageBoxSequence	getReferencedImageBoxSequence()
default ReferencedImageBoxSequence	newReferencedImageBoxSequence(int initialCapacity)	Adds a new Referenced Image Box Sequence.
default void	removeReferencedImageBoxSequence()	Removes the Referenced Image Box Sequence (see ReferencedImageBoxSequence
static ReferencedImageBoxSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Referenced Image Box Sequence (see ReferencedImageBoxSequence)

Returns:

a wrapper object implementing the ReferencedImageBoxSequence.Holder interface.

builder

static ReferencedImageBoxSequence.Holder.Builder builder()

Returns:

a ReferencedImageBoxSequence.Holder.Builder to create Referenced Image Box Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getReferencedImageBoxSequence

default ReferencedImageBoxSequence getReferencedImageBoxSequence()

Returns:

the Referenced Image Box Sequence (see ReferencedImageBoxSequence)

newReferencedImageBoxSequence

default ReferencedImageBoxSequence newReferencedImageBoxSequence(int initialCapacity)

Adds a new Referenced Image Box Sequence. (see ReferencedImageBoxSequence)

Parameters:

initialCapacity - the initial capacity for the new Referenced Image Box Sequence

Returns:

the newly created ReferencedImageBoxSequence.

ensureReferencedImageBoxSequence

default ReferencedImageBoxSequence ensureReferencedImageBoxSequence(int initialCapacity)

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

Parameters:

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

Returns:

either the already existing Referenced Image Box Sequence (see ReferencedImageBoxSequence) or a new one with capacity initialCapacity.

ensureReferencedImageBoxSequence

default ReferencedImageBoxSequence ensureReferencedImageBoxSequence()

Adds a new Referenced Image Box Sequence (see ReferencedImageBoxSequence) with initial capacity 1 (see ensureReferencedImageBoxSequence(int)) if it does not already exist.

Returns:

either the already existing Referenced Image Box Sequence (see ReferencedImageBoxSequence) or a new one with capacity 1.

containsReferencedImageBoxSequence

default boolean containsReferencedImageBoxSequence()

Returns:

whether it contains the Referenced Image Box Sequence (see ReferencedImageBoxSequence)

removeReferencedImageBoxSequence

default void removeReferencedImageBoxSequence()

Removes the Referenced Image Box Sequence (see ReferencedImageBoxSequence