Package org.dcm4che.typeddicom.dataelements

Interface FrameDisplayShutterSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

XAXRFPresentationStateShutterModule

All Known Implementing Classes:

CurrentFrameFunctionalGroupsSequence.Item, PerFrameFunctionalGroupsSequence.Item, SharedFunctionalGroupsSequence.Item, XAXRFGrayscaleSoftcopyPresentationStateIOD, XAXRFPresentationStateShutterModule.SimpleWrapper

Enclosing class:

FrameDisplayShutterSequence

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

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static FrameDisplayShutterSequence.Holder.Builder	builder()
static FrameDisplayShutterSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsFrameDisplayShutterSequence()
default FrameDisplayShutterSequence	ensureFrameDisplayShutterSequence()	Adds a new Frame Display Shutter Sequence (see FrameDisplayShutterSequence) with initial capacity 1 (see ensureFrameDisplayShutterSequence(int)) if it does not already exist.
default FrameDisplayShutterSequence	ensureFrameDisplayShutterSequence(int initialCapacity)	Adds a new Frame Display Shutter Sequence (see FrameDisplayShutterSequence) if it does not already exist.
default FrameDisplayShutterSequence	getFrameDisplayShutterSequence()
default FrameDisplayShutterSequence	newFrameDisplayShutterSequence(int initialCapacity)	Adds a new Frame Display Shutter Sequence.
default void	removeFrameDisplayShutterSequence()	Removes the Frame Display Shutter Sequence (see FrameDisplayShutterSequence
static FrameDisplayShutterSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

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

Returns:

a wrapper object implementing the FrameDisplayShutterSequence.Holder interface.

builder

static FrameDisplayShutterSequence.Holder.Builder builder()

Returns:

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

builder

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

Parameters:

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

Returns:

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

getFrameDisplayShutterSequence

default FrameDisplayShutterSequence getFrameDisplayShutterSequence()

Returns:

the Frame Display Shutter Sequence (see FrameDisplayShutterSequence)

newFrameDisplayShutterSequence

default FrameDisplayShutterSequence newFrameDisplayShutterSequence(int initialCapacity)

Adds a new Frame Display Shutter Sequence. (see FrameDisplayShutterSequence)

Parameters:

initialCapacity - the initial capacity for the new Frame Display Shutter Sequence

Returns:

the newly created FrameDisplayShutterSequence.

ensureFrameDisplayShutterSequence

default FrameDisplayShutterSequence ensureFrameDisplayShutterSequence(int initialCapacity)

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

Parameters:

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

Returns:

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

ensureFrameDisplayShutterSequence

default FrameDisplayShutterSequence ensureFrameDisplayShutterSequence()

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

Returns:

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

containsFrameDisplayShutterSequence

default boolean containsFrameDisplayShutterSequence()

Returns:

whether it contains the Frame Display Shutter Sequence (see FrameDisplayShutterSequence)

removeFrameDisplayShutterSequence

default void removeFrameDisplayShutterSequence()

Removes the Frame Display Shutter Sequence (see FrameDisplayShutterSequence