Package org.dcm4che.typeddicom.dataelements

Interface RTImageScopeSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

Enclosing class:

RTImageScopeSequence

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

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static RTImageScopeSequence.Holder.Builder	builder()
static RTImageScopeSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsRTImageScopeSequence()
default RTImageScopeSequence	ensureRTImageScopeSequence()	Adds a new RT Image Scope Sequence (see RTImageScopeSequence) with initial capacity 1 (see ensureRTImageScopeSequence(int)) if it does not already exist.
default RTImageScopeSequence	ensureRTImageScopeSequence(int initialCapacity)	Adds a new RT Image Scope Sequence (see RTImageScopeSequence) if it does not already exist.
default RTImageScopeSequence	getRTImageScopeSequence()
default RTImageScopeSequence	newRTImageScopeSequence(int initialCapacity)	Adds a new RT Image Scope Sequence.
default void	removeRTImageScopeSequence()	Removes the RT Image Scope Sequence (see RTImageScopeSequence
static RTImageScopeSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the RT Image Scope Sequence (see RTImageScopeSequence)

Returns:

a wrapper object implementing the RTImageScopeSequence.Holder interface.

builder

static RTImageScopeSequence.Holder.Builder builder()

Returns:

a RTImageScopeSequence.Holder.Builder to create RT Image Scope Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getRTImageScopeSequence

default RTImageScopeSequence getRTImageScopeSequence()

Returns:

the RT Image Scope Sequence (see RTImageScopeSequence)

newRTImageScopeSequence

default RTImageScopeSequence newRTImageScopeSequence(int initialCapacity)

Adds a new RT Image Scope Sequence. (see RTImageScopeSequence)

Parameters:

initialCapacity - the initial capacity for the new RT Image Scope Sequence

Returns:

the newly created RTImageScopeSequence.

ensureRTImageScopeSequence

default RTImageScopeSequence ensureRTImageScopeSequence(int initialCapacity)

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

Parameters:

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

Returns:

either the already existing RT Image Scope Sequence (see RTImageScopeSequence) or a new one with capacity initialCapacity.

ensureRTImageScopeSequence

default RTImageScopeSequence ensureRTImageScopeSequence()

Adds a new RT Image Scope Sequence (see RTImageScopeSequence) with initial capacity 1 (see ensureRTImageScopeSequence(int)) if it does not already exist.

Returns:

either the already existing RT Image Scope Sequence (see RTImageScopeSequence) or a new one with capacity 1.

containsRTImageScopeSequence

default boolean containsRTImageScopeSequence()

Returns:

whether it contains the RT Image Scope Sequence (see RTImageScopeSequence)

removeRTImageScopeSequence

default void removeRTImageScopeSequence()

Removes the RT Image Scope Sequence (see RTImageScopeSequence