Package org.dcm4che.typeddicom.dataelements

Interface ControlPointSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Implementing Classes:

BeamSequence.Item, ControlPointSequence.SimpleHolder

Enclosing class:

ControlPointSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Control Point Sequence" (see ControlPointSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ControlPointSequence.Holder.Builder	builder()
static ControlPointSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsControlPointSequence()
default ControlPointSequence	ensureControlPointSequence()	Adds a new Control Point Sequence (see ControlPointSequence) with initial capacity 1 (see ensureControlPointSequence(int)) if it does not already exist.
default ControlPointSequence	ensureControlPointSequence(int initialCapacity)	Adds a new Control Point Sequence (see ControlPointSequence) if it does not already exist.
default ControlPointSequence	getControlPointSequence()
default ControlPointSequence	newControlPointSequence(int initialCapacity)	Adds a new Control Point Sequence.
default void	removeControlPointSequence()	Removes the Control Point Sequence (see ControlPointSequence
static ControlPointSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Control Point Sequence (see ControlPointSequence)

Returns:

a wrapper object implementing the ControlPointSequence.Holder interface.

builder

static ControlPointSequence.Holder.Builder builder()

Returns:

a ControlPointSequence.Holder.Builder to create Control Point Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getControlPointSequence

default ControlPointSequence getControlPointSequence()

Returns:

the Control Point Sequence (see ControlPointSequence)

newControlPointSequence

default ControlPointSequence newControlPointSequence(int initialCapacity)

Adds a new Control Point Sequence. (see ControlPointSequence)

Parameters:

initialCapacity - the initial capacity for the new Control Point Sequence

Returns:

the newly created ControlPointSequence.

ensureControlPointSequence

default ControlPointSequence ensureControlPointSequence(int initialCapacity)

Adds a new Control Point Sequence (see ControlPointSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Control Point Sequence (see ControlPointSequence) or a new one with capacity initialCapacity.

ensureControlPointSequence

default ControlPointSequence ensureControlPointSequence()

Adds a new Control Point Sequence (see ControlPointSequence) with initial capacity 1 (see ensureControlPointSequence(int)) if it does not already exist.

Returns:

either the already existing Control Point Sequence (see ControlPointSequence) or a new one with capacity 1.

containsControlPointSequence

default boolean containsControlPointSequence()

Returns:

whether it contains the Control Point Sequence (see ControlPointSequence)

removeControlPointSequence

default void removeControlPointSequence()

Removes the Control Point Sequence (see ControlPointSequence