Package org.dcm4che.typeddicom.dataelements

Interface TargetMaterialSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Implementing Classes:

TargetMaterialSequence.SimpleHolder

Enclosing class:

TargetMaterialSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Target Material Sequence" (see TargetMaterialSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static TargetMaterialSequence.Holder.Builder	builder()
static TargetMaterialSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsTargetMaterialSequence()
default TargetMaterialSequence	ensureTargetMaterialSequence()	Adds a new Target Material Sequence (see TargetMaterialSequence) with initial capacity 1 (see ensureTargetMaterialSequence(int)) if it does not already exist.
default TargetMaterialSequence	ensureTargetMaterialSequence(int initialCapacity)	Adds a new Target Material Sequence (see TargetMaterialSequence) if it does not already exist.
default TargetMaterialSequence	getTargetMaterialSequence()
default TargetMaterialSequence	newTargetMaterialSequence(int initialCapacity)	Adds a new Target Material Sequence.
default void	removeTargetMaterialSequence()	Removes the Target Material Sequence (see TargetMaterialSequence
static TargetMaterialSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Target Material Sequence (see TargetMaterialSequence)

Returns:

a wrapper object implementing the TargetMaterialSequence.Holder interface.

builder

static TargetMaterialSequence.Holder.Builder builder()

Returns:

a TargetMaterialSequence.Holder.Builder to create Target Material Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getTargetMaterialSequence

default TargetMaterialSequence getTargetMaterialSequence()

Returns:

the Target Material Sequence (see TargetMaterialSequence)

newTargetMaterialSequence

default TargetMaterialSequence newTargetMaterialSequence(int initialCapacity)

Adds a new Target Material Sequence. (see TargetMaterialSequence)

Parameters:

initialCapacity - the initial capacity for the new Target Material Sequence

Returns:

the newly created TargetMaterialSequence.

ensureTargetMaterialSequence

default TargetMaterialSequence ensureTargetMaterialSequence(int initialCapacity)

Adds a new Target Material Sequence (see TargetMaterialSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Target Material Sequence (see TargetMaterialSequence) or a new one with capacity initialCapacity.

ensureTargetMaterialSequence

default TargetMaterialSequence ensureTargetMaterialSequence()

Adds a new Target Material Sequence (see TargetMaterialSequence) with initial capacity 1 (see ensureTargetMaterialSequence(int)) if it does not already exist.

Returns:

either the already existing Target Material Sequence (see TargetMaterialSequence) or a new one with capacity 1.

containsTargetMaterialSequence

default boolean containsTargetMaterialSequence()

Returns:

whether it contains the Target Material Sequence (see TargetMaterialSequence)

removeTargetMaterialSequence

default void removeTargetMaterialSequence()

Removes the Target Material Sequence (see TargetMaterialSequence