Package org.dcm4che.typeddicom.dataelements

Interface UsedRTStructureSetROISequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Implementing Classes:

RegistrationSequence.Item, UsedRTStructureSetROISequence.SimpleHolder

Enclosing class:

UsedRTStructureSetROISequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Used RT Structure Set ROI Sequence" (see UsedRTStructureSetROISequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static UsedRTStructureSetROISequence.Holder.Builder	builder()
static UsedRTStructureSetROISequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsUsedRTStructureSetROISequence()
default UsedRTStructureSetROISequence	ensureUsedRTStructureSetROISequence()	Adds a new Used RT Structure Set ROI Sequence (see UsedRTStructureSetROISequence) with initial capacity 1 (see ensureUsedRTStructureSetROISequence(int)) if it does not already exist.
default UsedRTStructureSetROISequence	ensureUsedRTStructureSetROISequence(int initialCapacity)	Adds a new Used RT Structure Set ROI Sequence (see UsedRTStructureSetROISequence) if it does not already exist.
default UsedRTStructureSetROISequence	getUsedRTStructureSetROISequence()
default UsedRTStructureSetROISequence	newUsedRTStructureSetROISequence(int initialCapacity)	Adds a new Used RT Structure Set ROI Sequence.
default void	removeUsedRTStructureSetROISequence()	Removes the Used RT Structure Set ROI Sequence (see UsedRTStructureSetROISequence
static UsedRTStructureSetROISequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Used RT Structure Set ROI Sequence (see UsedRTStructureSetROISequence)

Returns:

a wrapper object implementing the UsedRTStructureSetROISequence.Holder interface.

builder

static UsedRTStructureSetROISequence.Holder.Builder builder()

Returns:

a UsedRTStructureSetROISequence.Holder.Builder to create Used RT Structure Set ROI Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a UsedRTStructureSetROISequence.Holder.Builder to create Used RT Structure Set ROI Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getUsedRTStructureSetROISequence

default UsedRTStructureSetROISequence getUsedRTStructureSetROISequence()

Returns:

the Used RT Structure Set ROI Sequence (see UsedRTStructureSetROISequence)

newUsedRTStructureSetROISequence

default UsedRTStructureSetROISequence newUsedRTStructureSetROISequence(int initialCapacity)

Adds a new Used RT Structure Set ROI Sequence. (see UsedRTStructureSetROISequence)

Parameters:

initialCapacity - the initial capacity for the new Used RT Structure Set ROI Sequence

Returns:

the newly created UsedRTStructureSetROISequence.

ensureUsedRTStructureSetROISequence

default UsedRTStructureSetROISequence ensureUsedRTStructureSetROISequence(int initialCapacity)

Adds a new Used RT Structure Set ROI Sequence (see UsedRTStructureSetROISequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

initialCapacity - the initial capacity (see ArrayList(int)) if a new Used RT Structure Set ROI Sequence is created.

Returns:

either the already existing Used RT Structure Set ROI Sequence (see UsedRTStructureSetROISequence) or a new one with capacity initialCapacity.

ensureUsedRTStructureSetROISequence

default UsedRTStructureSetROISequence ensureUsedRTStructureSetROISequence()

Adds a new Used RT Structure Set ROI Sequence (see UsedRTStructureSetROISequence) with initial capacity 1 (see ensureUsedRTStructureSetROISequence(int)) if it does not already exist.

Returns:

either the already existing Used RT Structure Set ROI Sequence (see UsedRTStructureSetROISequence) or a new one with capacity 1.

containsUsedRTStructureSetROISequence

default boolean containsUsedRTStructureSetROISequence()

Returns:

whether it contains the Used RT Structure Set ROI Sequence (see UsedRTStructureSetROISequence)

removeUsedRTStructureSetROISequence

default void removeUsedRTStructureSetROISequence()

Removes the Used RT Structure Set ROI Sequence (see UsedRTStructureSetROISequence