Package org.dcm4che.typeddicom.dataelements

Interface RTImageFrameContextSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

Enclosing class:

RTImageFrameContextSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "RT Image Frame Context Sequence" (see RTImageFrameContextSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static RTImageFrameContextSequence.Holder.Builder	builder()
static RTImageFrameContextSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsRTImageFrameContextSequence()
default RTImageFrameContextSequence	ensureRTImageFrameContextSequence()	Adds a new RT Image Frame Context Sequence (see RTImageFrameContextSequence) with initial capacity 1 (see ensureRTImageFrameContextSequence(int)) if it does not already exist.
default RTImageFrameContextSequence	ensureRTImageFrameContextSequence(int initialCapacity)	Adds a new RT Image Frame Context Sequence (see RTImageFrameContextSequence) if it does not already exist.
default RTImageFrameContextSequence	getRTImageFrameContextSequence()
default RTImageFrameContextSequence	newRTImageFrameContextSequence(int initialCapacity)	Adds a new RT Image Frame Context Sequence.
default void	removeRTImageFrameContextSequence()	Removes the RT Image Frame Context Sequence (see RTImageFrameContextSequence
static RTImageFrameContextSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the RT Image Frame Context Sequence (see RTImageFrameContextSequence)

Returns:

a wrapper object implementing the RTImageFrameContextSequence.Holder interface.

builder

static RTImageFrameContextSequence.Holder.Builder builder()

Returns:

a RTImageFrameContextSequence.Holder.Builder to create RT Image Frame Context Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a RTImageFrameContextSequence.Holder.Builder to create RT Image Frame Context Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getRTImageFrameContextSequence

default RTImageFrameContextSequence getRTImageFrameContextSequence()

Returns:

the RT Image Frame Context Sequence (see RTImageFrameContextSequence)

newRTImageFrameContextSequence

default RTImageFrameContextSequence newRTImageFrameContextSequence(int initialCapacity)

Adds a new RT Image Frame Context Sequence. (see RTImageFrameContextSequence)

Parameters:

initialCapacity - the initial capacity for the new RT Image Frame Context Sequence

Returns:

the newly created RTImageFrameContextSequence.

ensureRTImageFrameContextSequence

default RTImageFrameContextSequence ensureRTImageFrameContextSequence(int initialCapacity)

Adds a new RT Image Frame Context Sequence (see RTImageFrameContextSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing RT Image Frame Context Sequence (see RTImageFrameContextSequence) or a new one with capacity initialCapacity.

ensureRTImageFrameContextSequence

default RTImageFrameContextSequence ensureRTImageFrameContextSequence()

Adds a new RT Image Frame Context Sequence (see RTImageFrameContextSequence) with initial capacity 1 (see ensureRTImageFrameContextSequence(int)) if it does not already exist.

Returns:

either the already existing RT Image Frame Context Sequence (see RTImageFrameContextSequence) or a new one with capacity 1.

containsRTImageFrameContextSequence

default boolean containsRTImageFrameContextSequence()

Returns:

whether it contains the RT Image Frame Context Sequence (see RTImageFrameContextSequence)

removeRTImageFrameContextSequence

default void removeRTImageFrameContextSequence()

Removes the RT Image Frame Context Sequence (see RTImageFrameContextSequence