Package org.dcm4che.typeddicom.dataelements

Interface SourceSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

RTBrachyApplicationSetupsModule

All Known Implementing Classes:

RTPlanIOD, SourceSequence.SimpleHolder

Enclosing class:

SourceSequence

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

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static SourceSequence.Holder.Builder	builder()
static SourceSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsSourceSequence()
default SourceSequence	ensureSourceSequence()	Adds a new Source Sequence (see SourceSequence) with initial capacity 1 (see ensureSourceSequence(int)) if it does not already exist.
default SourceSequence	ensureSourceSequence(int initialCapacity)	Adds a new Source Sequence (see SourceSequence) if it does not already exist.
default SourceSequence	getSourceSequence()
default SourceSequence	newSourceSequence(int initialCapacity)	Adds a new Source Sequence.
default void	removeSourceSequence()	Removes the Source Sequence (see SourceSequence
static SourceSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Source Sequence (see SourceSequence)

Returns:

a wrapper object implementing the SourceSequence.Holder interface.

builder

static SourceSequence.Holder.Builder builder()

Returns:

a SourceSequence.Holder.Builder to create Source Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getSourceSequence

default SourceSequence getSourceSequence()

Returns:

the Source Sequence (see SourceSequence)

newSourceSequence

default SourceSequence newSourceSequence(int initialCapacity)

Adds a new Source Sequence. (see SourceSequence)

Parameters:

initialCapacity - the initial capacity for the new Source Sequence

Returns:

the newly created SourceSequence.

ensureSourceSequence

default SourceSequence ensureSourceSequence(int initialCapacity)

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

Parameters:

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

Returns:

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

ensureSourceSequence

default SourceSequence ensureSourceSequence()

Adds a new Source Sequence (see SourceSequence) with initial capacity 1 (see ensureSourceSequence(int)) if it does not already exist.

Returns:

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

containsSourceSequence

default boolean containsSourceSequence()

Returns:

whether it contains the Source Sequence (see SourceSequence)

removeSourceSequence

default void removeSourceSequence()

Removes the Source Sequence (see SourceSequence