Package org.dcm4che.typeddicom.dataelements

Interface OverlayPixelDataSequence.Holder

All Superinterfaces:

AttributesWrapper

All Known Implementing Classes:

OverlayPixelDataSequence.SimpleHolder

Enclosing class:

OverlayPixelDataSequence

public static interface OverlayPixelDataSequence.Holder
extends AttributesWrapper

A class implementing this interface can hold attributes which contain the DICOM tag "Overlay Pixel Data Sequence" (see OverlayPixelDataSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static OverlayPixelDataSequence.Holder.Builder	builder()
static OverlayPixelDataSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsOverlayPixelDataSequence()
default OverlayPixelDataSequence	ensureOverlayPixelDataSequence()	Adds a new Overlay Pixel Data Sequence (see OverlayPixelDataSequence) with initial capacity 1 (see ensureOverlayPixelDataSequence(int)) if it does not already exist.
default OverlayPixelDataSequence	ensureOverlayPixelDataSequence(int initialCapacity)	Adds a new Overlay Pixel Data Sequence (see OverlayPixelDataSequence) if it does not already exist.
default OverlayPixelDataSequence	getOverlayPixelDataSequence()
default OverlayPixelDataSequence	newOverlayPixelDataSequence(int initialCapacity)	Adds a new Overlay Pixel Data Sequence.
default void	removeOverlayPixelDataSequence()	Removes the Overlay Pixel Data Sequence (see OverlayPixelDataSequence
static OverlayPixelDataSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Details

wrap

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

Parameters:

attributes - An attributes object containing the Overlay Pixel Data Sequence (see OverlayPixelDataSequence)

Returns:

A wrapper object implementing the OverlayPixelDataSequence.Holder interface.

builder

static OverlayPixelDataSequence.Holder.Builder builder()

Returns:

a OverlayPixelDataSequence.Holder.Builder to create Overlay Pixel Data Sequence Items with a fluent API.

builder

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

Parameters:

attributes - The Attributes to be wrapped by the OverlayPixelDataSequence.Holder.Builder.

Returns:

a OverlayPixelDataSequence.Holder.Builder to create Overlay Pixel Data Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getOverlayPixelDataSequence

default OverlayPixelDataSequence getOverlayPixelDataSequence()

Returns:

the Overlay Pixel Data Sequence (see OverlayPixelDataSequence)

newOverlayPixelDataSequence

default OverlayPixelDataSequence newOverlayPixelDataSequence(int initialCapacity)

Adds a new Overlay Pixel Data Sequence. (see OverlayPixelDataSequence)

Parameters:

initialCapacity - the initial capacity for the new Overlay Pixel Data Sequence

ensureOverlayPixelDataSequence

default OverlayPixelDataSequence ensureOverlayPixelDataSequence(int initialCapacity)

Adds a new Overlay Pixel Data Sequence (see OverlayPixelDataSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

initialCapacity - The initial capacity (see ArrayList(int)) if a new Overlay Pixel Data Sequence is created.

Returns:

Either the already existing Overlay Pixel Data Sequence (see OverlayPixelDataSequence) or a new one with capacity initialCapacity.

ensureOverlayPixelDataSequence

default OverlayPixelDataSequence ensureOverlayPixelDataSequence()

Adds a new Overlay Pixel Data Sequence (see OverlayPixelDataSequence) with initial capacity 1 (see ensureOverlayPixelDataSequence(int)) if it does not already exist.

Returns:

Either the already existing Overlay Pixel Data Sequence (see OverlayPixelDataSequence) or a new one with capacity 1.

containsOverlayPixelDataSequence

default boolean containsOverlayPixelDataSequence()

Returns:

Whether it contains the Overlay Pixel Data Sequence (see OverlayPixelDataSequence)

removeOverlayPixelDataSequence

default void removeOverlayPixelDataSequence()

Removes the Overlay Pixel Data Sequence (see OverlayPixelDataSequence