Package org.dcm4che.typeddicom.dataelements

Interface ImageOverlayBoxContentSequence.Holder

All Superinterfaces:

AttributesWrapper

Enclosing class:

ImageOverlayBoxContentSequence

public static interface ImageOverlayBoxContentSequence.Holder
extends AttributesWrapper

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

Method Summary

Modifier and Type	Method	Description
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 Details

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.

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

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