Package org.dcm4che.typeddicom.dataelements

Interface FrameDisplaySequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

XAXRFMultiFramePresentationModule

All Known Implementing Classes:

EnhancedXAImageIOD, EnhancedXRFImageIOD, FrameDisplaySequence.SimpleHolder, MultiFramePresentationSequence.Item

Enclosing class:

FrameDisplaySequence

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

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static FrameDisplaySequence.Holder.Builder	builder()
static FrameDisplaySequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsFrameDisplaySequence()
default FrameDisplaySequence	ensureFrameDisplaySequence()	Adds a new Frame Display Sequence (see FrameDisplaySequence) with initial capacity 1 (see ensureFrameDisplaySequence(int)) if it does not already exist.
default FrameDisplaySequence	ensureFrameDisplaySequence(int initialCapacity)	Adds a new Frame Display Sequence (see FrameDisplaySequence) if it does not already exist.
default FrameDisplaySequence	getFrameDisplaySequence()
default FrameDisplaySequence	newFrameDisplaySequence(int initialCapacity)	Adds a new Frame Display Sequence.
default void	removeFrameDisplaySequence()	Removes the Frame Display Sequence (see FrameDisplaySequence
static FrameDisplaySequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Frame Display Sequence (see FrameDisplaySequence)

Returns:

a wrapper object implementing the FrameDisplaySequence.Holder interface.

builder

static FrameDisplaySequence.Holder.Builder builder()

Returns:

a FrameDisplaySequence.Holder.Builder to create Frame Display Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getFrameDisplaySequence

default FrameDisplaySequence getFrameDisplaySequence()

Returns:

the Frame Display Sequence (see FrameDisplaySequence)

newFrameDisplaySequence

default FrameDisplaySequence newFrameDisplaySequence(int initialCapacity)

Adds a new Frame Display Sequence. (see FrameDisplaySequence)

Parameters:

initialCapacity - the initial capacity for the new Frame Display Sequence

Returns:

the newly created FrameDisplaySequence.

ensureFrameDisplaySequence

default FrameDisplaySequence ensureFrameDisplaySequence(int initialCapacity)

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

Parameters:

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

Returns:

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

ensureFrameDisplaySequence

default FrameDisplaySequence ensureFrameDisplaySequence()

Adds a new Frame Display Sequence (see FrameDisplaySequence) with initial capacity 1 (see ensureFrameDisplaySequence(int)) if it does not already exist.

Returns:

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

containsFrameDisplaySequence

default boolean containsFrameDisplaySequence()

Returns:

whether it contains the Frame Display Sequence (see FrameDisplaySequence)

removeFrameDisplaySequence

default void removeFrameDisplaySequence()

Removes the Frame Display Sequence (see FrameDisplaySequence