Package org.dcm4che.typeddicom.dataelements

Interface ReferencedFirstFrameSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Implementing Classes:

StructuredDisplayImageBoxSequence.Item

Enclosing class:

ReferencedFirstFrameSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Referenced First Frame Sequence" (see ReferencedFirstFrameSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ReferencedFirstFrameSequence.Holder.Builder	builder()
static ReferencedFirstFrameSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsReferencedFirstFrameSequence()
default ReferencedFirstFrameSequence	ensureReferencedFirstFrameSequence()	Adds a new Referenced First Frame Sequence (see ReferencedFirstFrameSequence) with initial capacity 1 (see ensureReferencedFirstFrameSequence(int)) if it does not already exist.
default ReferencedFirstFrameSequence	ensureReferencedFirstFrameSequence(int initialCapacity)	Adds a new Referenced First Frame Sequence (see ReferencedFirstFrameSequence) if it does not already exist.
default ReferencedFirstFrameSequence	getReferencedFirstFrameSequence()
default ReferencedFirstFrameSequence	newReferencedFirstFrameSequence(int initialCapacity)	Adds a new Referenced First Frame Sequence.
default void	removeReferencedFirstFrameSequence()	Removes the Referenced First Frame Sequence (see ReferencedFirstFrameSequence
static ReferencedFirstFrameSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Referenced First Frame Sequence (see ReferencedFirstFrameSequence)

Returns:

a wrapper object implementing the ReferencedFirstFrameSequence.Holder interface.

builder

static ReferencedFirstFrameSequence.Holder.Builder builder()

Returns:

a ReferencedFirstFrameSequence.Holder.Builder to create Referenced First Frame Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getReferencedFirstFrameSequence

default ReferencedFirstFrameSequence getReferencedFirstFrameSequence()

Returns:

the Referenced First Frame Sequence (see ReferencedFirstFrameSequence)

newReferencedFirstFrameSequence

default ReferencedFirstFrameSequence newReferencedFirstFrameSequence(int initialCapacity)

Adds a new Referenced First Frame Sequence. (see ReferencedFirstFrameSequence)

Parameters:

initialCapacity - the initial capacity for the new Referenced First Frame Sequence

Returns:

the newly created ReferencedFirstFrameSequence.

ensureReferencedFirstFrameSequence

default ReferencedFirstFrameSequence ensureReferencedFirstFrameSequence(int initialCapacity)

Adds a new Referenced First Frame Sequence (see ReferencedFirstFrameSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Referenced First Frame Sequence (see ReferencedFirstFrameSequence) or a new one with capacity initialCapacity.

ensureReferencedFirstFrameSequence

default ReferencedFirstFrameSequence ensureReferencedFirstFrameSequence()

Adds a new Referenced First Frame Sequence (see ReferencedFirstFrameSequence) with initial capacity 1 (see ensureReferencedFirstFrameSequence(int)) if it does not already exist.

Returns:

either the already existing Referenced First Frame Sequence (see ReferencedFirstFrameSequence) or a new one with capacity 1.

containsReferencedFirstFrameSequence

default boolean containsReferencedFirstFrameSequence()

Returns:

whether it contains the Referenced First Frame Sequence (see ReferencedFirstFrameSequence)

removeReferencedFirstFrameSequence

default void removeReferencedFirstFrameSequence()

Removes the Referenced First Frame Sequence (see ReferencedFirstFrameSequence