Package org.dcm4che.typeddicom.dataelements

Interface CompensatorSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Implementing Classes:

BeamSequence.Item, CompensatorSequence.SimpleHolder

Enclosing class:

CompensatorSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Compensator Sequence" (see CompensatorSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CompensatorSequence.Holder.Builder	builder()
static CompensatorSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsCompensatorSequence()
default CompensatorSequence	ensureCompensatorSequence()	Adds a new Compensator Sequence (see CompensatorSequence) with initial capacity 1 (see ensureCompensatorSequence(int)) if it does not already exist.
default CompensatorSequence	ensureCompensatorSequence(int initialCapacity)	Adds a new Compensator Sequence (see CompensatorSequence) if it does not already exist.
default CompensatorSequence	getCompensatorSequence()
default CompensatorSequence	newCompensatorSequence(int initialCapacity)	Adds a new Compensator Sequence.
default void	removeCompensatorSequence()	Removes the Compensator Sequence (see CompensatorSequence
static CompensatorSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Compensator Sequence (see CompensatorSequence)

Returns:

a wrapper object implementing the CompensatorSequence.Holder interface.

builder

static CompensatorSequence.Holder.Builder builder()

Returns:

a CompensatorSequence.Holder.Builder to create Compensator Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getCompensatorSequence

default CompensatorSequence getCompensatorSequence()

Returns:

the Compensator Sequence (see CompensatorSequence)

newCompensatorSequence

default CompensatorSequence newCompensatorSequence(int initialCapacity)

Adds a new Compensator Sequence. (see CompensatorSequence)

Parameters:

initialCapacity - the initial capacity for the new Compensator Sequence

Returns:

the newly created CompensatorSequence.

ensureCompensatorSequence

default CompensatorSequence ensureCompensatorSequence(int initialCapacity)

Adds a new Compensator Sequence (see CompensatorSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Compensator Sequence (see CompensatorSequence) or a new one with capacity initialCapacity.

ensureCompensatorSequence

default CompensatorSequence ensureCompensatorSequence()

Adds a new Compensator Sequence (see CompensatorSequence) with initial capacity 1 (see ensureCompensatorSequence(int)) if it does not already exist.

Returns:

either the already existing Compensator Sequence (see CompensatorSequence) or a new one with capacity 1.

containsCompensatorSequence

default boolean containsCompensatorSequence()

Returns:

whether it contains the Compensator Sequence (see CompensatorSequence)

removeCompensatorSequence

default void removeCompensatorSequence()

Removes the Compensator Sequence (see CompensatorSequence