Package org.dcm4che.typeddicom.dataelements

Interface RelatedReferenceRTImageSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Implementing Classes:

DeliveryVerificationImageSequence.Item, RelatedReferenceRTImageSequence.SimpleHolder

Enclosing class:

RelatedReferenceRTImageSequence

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

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static RelatedReferenceRTImageSequence.Holder.Builder	builder()
static RelatedReferenceRTImageSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsRelatedReferenceRTImageSequence()
default RelatedReferenceRTImageSequence	ensureRelatedReferenceRTImageSequence()	Adds a new Related Reference RT Image Sequence (see RelatedReferenceRTImageSequence) with initial capacity 1 (see ensureRelatedReferenceRTImageSequence(int)) if it does not already exist.
default RelatedReferenceRTImageSequence	ensureRelatedReferenceRTImageSequence(int initialCapacity)	Adds a new Related Reference RT Image Sequence (see RelatedReferenceRTImageSequence) if it does not already exist.
default RelatedReferenceRTImageSequence	getRelatedReferenceRTImageSequence()
default RelatedReferenceRTImageSequence	newRelatedReferenceRTImageSequence(int initialCapacity)	Adds a new Related Reference RT Image Sequence.
default void	removeRelatedReferenceRTImageSequence()	Removes the Related Reference RT Image Sequence (see RelatedReferenceRTImageSequence
static RelatedReferenceRTImageSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Related Reference RT Image Sequence (see RelatedReferenceRTImageSequence)

Returns:

a wrapper object implementing the RelatedReferenceRTImageSequence.Holder interface.

builder

static RelatedReferenceRTImageSequence.Holder.Builder builder()

Returns:

a RelatedReferenceRTImageSequence.Holder.Builder to create Related Reference RT Image Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getRelatedReferenceRTImageSequence

default RelatedReferenceRTImageSequence getRelatedReferenceRTImageSequence()

Returns:

the Related Reference RT Image Sequence (see RelatedReferenceRTImageSequence)

newRelatedReferenceRTImageSequence

default RelatedReferenceRTImageSequence newRelatedReferenceRTImageSequence(int initialCapacity)

Adds a new Related Reference RT Image Sequence. (see RelatedReferenceRTImageSequence)

Parameters:

initialCapacity - the initial capacity for the new Related Reference RT Image Sequence

Returns:

the newly created RelatedReferenceRTImageSequence.

ensureRelatedReferenceRTImageSequence

default RelatedReferenceRTImageSequence ensureRelatedReferenceRTImageSequence(int initialCapacity)

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

Parameters:

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

Returns:

either the already existing Related Reference RT Image Sequence (see RelatedReferenceRTImageSequence) or a new one with capacity initialCapacity.

ensureRelatedReferenceRTImageSequence

default RelatedReferenceRTImageSequence ensureRelatedReferenceRTImageSequence()

Adds a new Related Reference RT Image Sequence (see RelatedReferenceRTImageSequence) with initial capacity 1 (see ensureRelatedReferenceRTImageSequence(int)) if it does not already exist.

Returns:

either the already existing Related Reference RT Image Sequence (see RelatedReferenceRTImageSequence) or a new one with capacity 1.

containsRelatedReferenceRTImageSequence

default boolean containsRelatedReferenceRTImageSequence()

Returns:

whether it contains the Related Reference RT Image Sequence (see RelatedReferenceRTImageSequence)

removeRelatedReferenceRTImageSequence

default void removeRelatedReferenceRTImageSequence()

Removes the Related Reference RT Image Sequence (see RelatedReferenceRTImageSequence