Package org.dcm4che.typeddicom.dataelements

Interface BlockSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Implementing Classes:

BeamSequence.Item, BlockSequence.SimpleHolder, ExposureSequence.Item

Enclosing class:

BlockSequence

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

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static BlockSequence.Holder.Builder	builder()
static BlockSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsBlockSequence()
default BlockSequence	ensureBlockSequence()	Adds a new Block Sequence (see BlockSequence) with initial capacity 1 (see ensureBlockSequence(int)) if it does not already exist.
default BlockSequence	ensureBlockSequence(int initialCapacity)	Adds a new Block Sequence (see BlockSequence) if it does not already exist.
default BlockSequence	getBlockSequence()
default BlockSequence	newBlockSequence(int initialCapacity)	Adds a new Block Sequence.
default void	removeBlockSequence()	Removes the Block Sequence (see BlockSequence
static BlockSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Block Sequence (see BlockSequence)

Returns:

a wrapper object implementing the BlockSequence.Holder interface.

builder

static BlockSequence.Holder.Builder builder()

Returns:

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

builder

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

Parameters:

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

Returns:

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

getBlockSequence

default BlockSequence getBlockSequence()

Returns:

the Block Sequence (see BlockSequence)

newBlockSequence

default BlockSequence newBlockSequence(int initialCapacity)

Adds a new Block Sequence. (see BlockSequence)

Parameters:

initialCapacity - the initial capacity for the new Block Sequence

Returns:

the newly created BlockSequence.

ensureBlockSequence

default BlockSequence ensureBlockSequence(int initialCapacity)

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

Parameters:

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

Returns:

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

ensureBlockSequence

default BlockSequence ensureBlockSequence()

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

Returns:

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

containsBlockSequence

default boolean containsBlockSequence()

Returns:

whether it contains the Block Sequence (see BlockSequence)

removeBlockSequence

default void removeBlockSequence()

Removes the Block Sequence (see BlockSequence