Package org.dcm4che.typeddicom.dataelements

Interface FrameContentSequence.Holder

All Superinterfaces:

AttributesWrapper

All Known Implementing Classes:

FrameContentSequence.SimpleHolder

Enclosing class:

FrameContentSequence

public static interface FrameContentSequence.Holder
extends AttributesWrapper

A class implementing this interface can hold attributes which contain the DICOM tag "Frame Content Sequence" (see FrameContentSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static FrameContentSequence.Holder.Builder	builder()
static FrameContentSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsFrameContentSequence()
default FrameContentSequence	ensureFrameContentSequence()	Adds a new Frame Content Sequence (see FrameContentSequence) with initial capacity 1 (see ensureFrameContentSequence(int)) if it does not already exist.
default FrameContentSequence	ensureFrameContentSequence(int initialCapacity)	Adds a new Frame Content Sequence (see FrameContentSequence) if it does not already exist.
default FrameContentSequence	getFrameContentSequence()
default FrameContentSequence	newFrameContentSequence(int initialCapacity)	Adds a new Frame Content Sequence.
default void	removeFrameContentSequence()	Removes the Frame Content Sequence (see FrameContentSequence
static FrameContentSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Details

wrap

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

Parameters:

attributes - An attributes object containing the Frame Content Sequence (see FrameContentSequence)

Returns:

A wrapper object implementing the FrameContentSequence.Holder interface.

builder

static FrameContentSequence.Holder.Builder builder()

Returns:

a FrameContentSequence.Holder.Builder to create Frame Content Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a FrameContentSequence.Holder.Builder to create Frame Content Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getFrameContentSequence

default FrameContentSequence getFrameContentSequence()

Returns:

the Frame Content Sequence (see FrameContentSequence)

newFrameContentSequence

default FrameContentSequence newFrameContentSequence(int initialCapacity)

Adds a new Frame Content Sequence. (see FrameContentSequence)

Parameters:

initialCapacity - the initial capacity for the new Frame Content Sequence

ensureFrameContentSequence

default FrameContentSequence ensureFrameContentSequence(int initialCapacity)

Adds a new Frame Content Sequence (see FrameContentSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

initialCapacity - The initial capacity (see ArrayList(int)) if a new Frame Content Sequence is created.

Returns:

Either the already existing Frame Content Sequence (see FrameContentSequence) or a new one with capacity initialCapacity.

ensureFrameContentSequence

default FrameContentSequence ensureFrameContentSequence()

Adds a new Frame Content Sequence (see FrameContentSequence) with initial capacity 1 (see ensureFrameContentSequence(int)) if it does not already exist.

Returns:

Either the already existing Frame Content Sequence (see FrameContentSequence) or a new one with capacity 1.

containsFrameContentSequence

default boolean containsFrameContentSequence()

Returns:

Whether it contains the Frame Content Sequence (see FrameContentSequence)

removeFrameContentSequence

default void removeFrameContentSequence()

Removes the Frame Content Sequence (see FrameContentSequence