Package org.dcm4che.typeddicom.dataelements

Interface RecordedBlockSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Implementing Classes:

GeneralMachineVerificationSequence.Item, TreatmentSessionBeamSequence.Item, TreatmentSessionIonBeamSequence.Item

Enclosing class:

RecordedBlockSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Recorded Block Sequence" (see RecordedBlockSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static RecordedBlockSequence.Holder.Builder	builder()
static RecordedBlockSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsRecordedBlockSequence()
default RecordedBlockSequence	ensureRecordedBlockSequence()	Adds a new Recorded Block Sequence (see RecordedBlockSequence) with initial capacity 1 (see ensureRecordedBlockSequence(int)) if it does not already exist.
default RecordedBlockSequence	ensureRecordedBlockSequence(int initialCapacity)	Adds a new Recorded Block Sequence (see RecordedBlockSequence) if it does not already exist.
default RecordedBlockSequence	getRecordedBlockSequence()
default RecordedBlockSequence	newRecordedBlockSequence(int initialCapacity)	Adds a new Recorded Block Sequence.
default void	removeRecordedBlockSequence()	Removes the Recorded Block Sequence (see RecordedBlockSequence
static RecordedBlockSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Recorded Block Sequence (see RecordedBlockSequence)

Returns:

a wrapper object implementing the RecordedBlockSequence.Holder interface.

builder

static RecordedBlockSequence.Holder.Builder builder()

Returns:

a RecordedBlockSequence.Holder.Builder to create Recorded Block Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getRecordedBlockSequence

default RecordedBlockSequence getRecordedBlockSequence()

Returns:

the Recorded Block Sequence (see RecordedBlockSequence)

newRecordedBlockSequence

default RecordedBlockSequence newRecordedBlockSequence(int initialCapacity)

Adds a new Recorded Block Sequence. (see RecordedBlockSequence)

Parameters:

initialCapacity - the initial capacity for the new Recorded Block Sequence

Returns:

the newly created RecordedBlockSequence.

ensureRecordedBlockSequence

default RecordedBlockSequence ensureRecordedBlockSequence(int initialCapacity)

Adds a new Recorded Block Sequence (see RecordedBlockSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Recorded Block Sequence (see RecordedBlockSequence) or a new one with capacity initialCapacity.

ensureRecordedBlockSequence

default RecordedBlockSequence ensureRecordedBlockSequence()

Adds a new Recorded Block Sequence (see RecordedBlockSequence) with initial capacity 1 (see ensureRecordedBlockSequence(int)) if it does not already exist.

Returns:

either the already existing Recorded Block Sequence (see RecordedBlockSequence) or a new one with capacity 1.

containsRecordedBlockSequence

default boolean containsRecordedBlockSequence()

Returns:

whether it contains the Recorded Block Sequence (see RecordedBlockSequence)

removeRecordedBlockSequence

default void removeRecordedBlockSequence()

Removes the Recorded Block Sequence (see RecordedBlockSequence