Package org.dcm4che.typeddicom.dataelements

Interface ImageOverlayBoxContentSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

Enclosing class:

ImageOverlayBoxContentSequence

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

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ImageOverlayBoxContentSequence.Holder.Builder	builder()
static ImageOverlayBoxContentSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsImageOverlayBoxContentSequence()
default ImageOverlayBoxContentSequence	ensureImageOverlayBoxContentSequence()	Adds a new Image Overlay Box Content Sequence (see ImageOverlayBoxContentSequence) with initial capacity 1 (see ensureImageOverlayBoxContentSequence(int)) if it does not already exist.
default ImageOverlayBoxContentSequence	ensureImageOverlayBoxContentSequence(int initialCapacity)	Adds a new Image Overlay Box Content Sequence (see ImageOverlayBoxContentSequence) if it does not already exist.
default ImageOverlayBoxContentSequence	getImageOverlayBoxContentSequence()
default ImageOverlayBoxContentSequence	newImageOverlayBoxContentSequence(int initialCapacity)	Adds a new Image Overlay Box Content Sequence.
default void	removeImageOverlayBoxContentSequence()	Removes the Image Overlay Box Content Sequence (see ImageOverlayBoxContentSequence
static ImageOverlayBoxContentSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Image Overlay Box Content Sequence (see ImageOverlayBoxContentSequence)

Returns:

a wrapper object implementing the ImageOverlayBoxContentSequence.Holder interface.

builder

static ImageOverlayBoxContentSequence.Holder.Builder builder()

Returns:

a ImageOverlayBoxContentSequence.Holder.Builder to create Image Overlay Box Content Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getImageOverlayBoxContentSequence

default ImageOverlayBoxContentSequence getImageOverlayBoxContentSequence()

Returns:

the Image Overlay Box Content Sequence (see ImageOverlayBoxContentSequence)

newImageOverlayBoxContentSequence

default ImageOverlayBoxContentSequence newImageOverlayBoxContentSequence(int initialCapacity)

Adds a new Image Overlay Box Content Sequence. (see ImageOverlayBoxContentSequence)

Parameters:

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

Returns:

the newly created ImageOverlayBoxContentSequence.

ensureImageOverlayBoxContentSequence

default ImageOverlayBoxContentSequence ensureImageOverlayBoxContentSequence(int initialCapacity)

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

Parameters:

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

Returns:

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

ensureImageOverlayBoxContentSequence

default ImageOverlayBoxContentSequence ensureImageOverlayBoxContentSequence()

Adds a new Image Overlay Box Content Sequence (see ImageOverlayBoxContentSequence) with initial capacity 1 (see ensureImageOverlayBoxContentSequence(int)) if it does not already exist.

Returns:

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

containsImageOverlayBoxContentSequence

default boolean containsImageOverlayBoxContentSequence()

Returns:

whether it contains the Image Overlay Box Content Sequence (see ImageOverlayBoxContentSequence)

removeImageOverlayBoxContentSequence

default void removeImageOverlayBoxContentSequence()

Removes the Image Overlay Box Content Sequence (see ImageOverlayBoxContentSequence