Package org.dcm4che.typeddicom.dataelements

Interface FrameAcquisitionSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

Enclosing class:

FrameAcquisitionSequence

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

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static FrameAcquisitionSequence.Holder.Builder	builder()
static FrameAcquisitionSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsFrameAcquisitionSequence()
default FrameAcquisitionSequence	ensureFrameAcquisitionSequence()	Adds a new Frame Acquisition Sequence (see FrameAcquisitionSequence) with initial capacity 1 (see ensureFrameAcquisitionSequence(int)) if it does not already exist.
default FrameAcquisitionSequence	ensureFrameAcquisitionSequence(int initialCapacity)	Adds a new Frame Acquisition Sequence (see FrameAcquisitionSequence) if it does not already exist.
default FrameAcquisitionSequence	getFrameAcquisitionSequence()
default FrameAcquisitionSequence	newFrameAcquisitionSequence(int initialCapacity)	Adds a new Frame Acquisition Sequence.
default void	removeFrameAcquisitionSequence()	Removes the Frame Acquisition Sequence (see FrameAcquisitionSequence
static FrameAcquisitionSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Frame Acquisition Sequence (see FrameAcquisitionSequence)

Returns:

a wrapper object implementing the FrameAcquisitionSequence.Holder interface.

builder

static FrameAcquisitionSequence.Holder.Builder builder()

Returns:

a FrameAcquisitionSequence.Holder.Builder to create Frame Acquisition Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getFrameAcquisitionSequence

default FrameAcquisitionSequence getFrameAcquisitionSequence()

Returns:

the Frame Acquisition Sequence (see FrameAcquisitionSequence)

newFrameAcquisitionSequence

default FrameAcquisitionSequence newFrameAcquisitionSequence(int initialCapacity)

Adds a new Frame Acquisition Sequence. (see FrameAcquisitionSequence)

Parameters:

initialCapacity - the initial capacity for the new Frame Acquisition Sequence

Returns:

the newly created FrameAcquisitionSequence.

ensureFrameAcquisitionSequence

default FrameAcquisitionSequence ensureFrameAcquisitionSequence(int initialCapacity)

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

Parameters:

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

Returns:

either the already existing Frame Acquisition Sequence (see FrameAcquisitionSequence) or a new one with capacity initialCapacity.

ensureFrameAcquisitionSequence

default FrameAcquisitionSequence ensureFrameAcquisitionSequence()

Adds a new Frame Acquisition Sequence (see FrameAcquisitionSequence) with initial capacity 1 (see ensureFrameAcquisitionSequence(int)) if it does not already exist.

Returns:

either the already existing Frame Acquisition Sequence (see FrameAcquisitionSequence) or a new one with capacity 1.

containsFrameAcquisitionSequence

default boolean containsFrameAcquisitionSequence()

Returns:

whether it contains the Frame Acquisition Sequence (see FrameAcquisitionSequence)

removeFrameAcquisitionSequence

default void removeFrameAcquisitionSequence()

Removes the Frame Acquisition Sequence (see FrameAcquisitionSequence