Package org.dcm4che.typeddicom.dataelements

Interface ComponentSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Implementing Classes:

ComponentSequence.SimpleHolder, ComponentTypesSequence.Item

Enclosing class:

ComponentSequence

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

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ComponentSequence.Holder.Builder	builder()
static ComponentSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsComponentSequence()
default ComponentSequence	ensureComponentSequence()	Adds a new Component Sequence (see ComponentSequence) with initial capacity 1 (see ensureComponentSequence(int)) if it does not already exist.
default ComponentSequence	ensureComponentSequence(int initialCapacity)	Adds a new Component Sequence (see ComponentSequence) if it does not already exist.
default ComponentSequence	getComponentSequence()
default ComponentSequence	newComponentSequence(int initialCapacity)	Adds a new Component Sequence.
default void	removeComponentSequence()	Removes the Component Sequence (see ComponentSequence
static ComponentSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Component Sequence (see ComponentSequence)

Returns:

a wrapper object implementing the ComponentSequence.Holder interface.

builder

static ComponentSequence.Holder.Builder builder()

Returns:

a ComponentSequence.Holder.Builder to create Component Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getComponentSequence

default ComponentSequence getComponentSequence()

Returns:

the Component Sequence (see ComponentSequence)

newComponentSequence

default ComponentSequence newComponentSequence(int initialCapacity)

Adds a new Component Sequence. (see ComponentSequence)

Parameters:

initialCapacity - the initial capacity for the new Component Sequence

Returns:

the newly created ComponentSequence.

ensureComponentSequence

default ComponentSequence ensureComponentSequence(int initialCapacity)

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

Parameters:

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

Returns:

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

ensureComponentSequence

default ComponentSequence ensureComponentSequence()

Adds a new Component Sequence (see ComponentSequence) with initial capacity 1 (see ensureComponentSequence(int)) if it does not already exist.

Returns:

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

containsComponentSequence

default boolean containsComponentSequence()

Returns:

whether it contains the Component Sequence (see ComponentSequence)

removeComponentSequence

default void removeComponentSequence()

Removes the Component Sequence (see ComponentSequence