Package org.dcm4che.typeddicom.dataelements

Interface ReferencedImageOverlayBoxSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Implementing Classes:

ReferencedImageOverlayBoxSequence.SimpleHolder

Enclosing class:

ReferencedImageOverlayBoxSequence

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

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ReferencedImageOverlayBoxSequence.Holder.Builder	builder()
static ReferencedImageOverlayBoxSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsReferencedImageOverlayBoxSequence()
default ReferencedImageOverlayBoxSequence	ensureReferencedImageOverlayBoxSequence()	Adds a new Referenced Image Overlay Box Sequence (see ReferencedImageOverlayBoxSequence) with initial capacity 1 (see ensureReferencedImageOverlayBoxSequence(int)) if it does not already exist.
default ReferencedImageOverlayBoxSequence	ensureReferencedImageOverlayBoxSequence(int initialCapacity)	Adds a new Referenced Image Overlay Box Sequence (see ReferencedImageOverlayBoxSequence) if it does not already exist.
default ReferencedImageOverlayBoxSequence	getReferencedImageOverlayBoxSequence()
default ReferencedImageOverlayBoxSequence	newReferencedImageOverlayBoxSequence(int initialCapacity)	Adds a new Referenced Image Overlay Box Sequence.
default void	removeReferencedImageOverlayBoxSequence()	Removes the Referenced Image Overlay Box Sequence (see ReferencedImageOverlayBoxSequence
static ReferencedImageOverlayBoxSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

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

Returns:

a wrapper object implementing the ReferencedImageOverlayBoxSequence.Holder interface.

builder

static ReferencedImageOverlayBoxSequence.Holder.Builder builder()

Returns:

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

builder

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

Parameters:

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

Returns:

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

getReferencedImageOverlayBoxSequence

default ReferencedImageOverlayBoxSequence getReferencedImageOverlayBoxSequence()

Returns:

the Referenced Image Overlay Box Sequence (see ReferencedImageOverlayBoxSequence)

newReferencedImageOverlayBoxSequence

default ReferencedImageOverlayBoxSequence newReferencedImageOverlayBoxSequence(int initialCapacity)

Adds a new Referenced Image Overlay Box Sequence. (see ReferencedImageOverlayBoxSequence)

Parameters:

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

Returns:

the newly created ReferencedImageOverlayBoxSequence.

ensureReferencedImageOverlayBoxSequence

default ReferencedImageOverlayBoxSequence ensureReferencedImageOverlayBoxSequence(int initialCapacity)

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

Parameters:

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

Returns:

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

ensureReferencedImageOverlayBoxSequence

default ReferencedImageOverlayBoxSequence ensureReferencedImageOverlayBoxSequence()

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

Returns:

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

containsReferencedImageOverlayBoxSequence

default boolean containsReferencedImageOverlayBoxSequence()

Returns:

whether it contains the Referenced Image Overlay Box Sequence (see ReferencedImageOverlayBoxSequence)

removeReferencedImageOverlayBoxSequence

default void removeReferencedImageOverlayBoxSequence()

Removes the Referenced Image Overlay Box Sequence (see ReferencedImageOverlayBoxSequence