Package org.dcm4che.typeddicom.dataelements

Interface RangeModulatorSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Implementing Classes:

IonBeamSequence.Item, RangeModulatorSequence.SimpleHolder

Enclosing class:

RangeModulatorSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Range Modulator Sequence" (see RangeModulatorSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static RangeModulatorSequence.Holder.Builder	builder()
static RangeModulatorSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsRangeModulatorSequence()
default RangeModulatorSequence	ensureRangeModulatorSequence()	Adds a new Range Modulator Sequence (see RangeModulatorSequence) with initial capacity 1 (see ensureRangeModulatorSequence(int)) if it does not already exist.
default RangeModulatorSequence	ensureRangeModulatorSequence(int initialCapacity)	Adds a new Range Modulator Sequence (see RangeModulatorSequence) if it does not already exist.
default RangeModulatorSequence	getRangeModulatorSequence()
default RangeModulatorSequence	newRangeModulatorSequence(int initialCapacity)	Adds a new Range Modulator Sequence.
default void	removeRangeModulatorSequence()	Removes the Range Modulator Sequence (see RangeModulatorSequence
static RangeModulatorSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Range Modulator Sequence (see RangeModulatorSequence)

Returns:

a wrapper object implementing the RangeModulatorSequence.Holder interface.

builder

static RangeModulatorSequence.Holder.Builder builder()

Returns:

a RangeModulatorSequence.Holder.Builder to create Range Modulator Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a RangeModulatorSequence.Holder.Builder to create Range Modulator Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getRangeModulatorSequence

default RangeModulatorSequence getRangeModulatorSequence()

Returns:

the Range Modulator Sequence (see RangeModulatorSequence)

newRangeModulatorSequence

default RangeModulatorSequence newRangeModulatorSequence(int initialCapacity)

Adds a new Range Modulator Sequence. (see RangeModulatorSequence)

Parameters:

initialCapacity - the initial capacity for the new Range Modulator Sequence

Returns:

the newly created RangeModulatorSequence.

ensureRangeModulatorSequence

default RangeModulatorSequence ensureRangeModulatorSequence(int initialCapacity)

Adds a new Range Modulator Sequence (see RangeModulatorSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

initialCapacity - the initial capacity (see ArrayList(int)) if a new Range Modulator Sequence is created.

Returns:

either the already existing Range Modulator Sequence (see RangeModulatorSequence) or a new one with capacity initialCapacity.

ensureRangeModulatorSequence

default RangeModulatorSequence ensureRangeModulatorSequence()

Adds a new Range Modulator Sequence (see RangeModulatorSequence) with initial capacity 1 (see ensureRangeModulatorSequence(int)) if it does not already exist.

Returns:

either the already existing Range Modulator Sequence (see RangeModulatorSequence) or a new one with capacity 1.

containsRangeModulatorSequence

default boolean containsRangeModulatorSequence()

Returns:

whether it contains the Range Modulator Sequence (see RangeModulatorSequence)

removeRangeModulatorSequence

default void removeRangeModulatorSequence()

Removes the Range Modulator Sequence (see RangeModulatorSequence