Package org.dcm4che.typeddicom.dataelements

Interface MaterialCodeSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Implementing Classes:

DecompositionMaterialSequence.Item

Enclosing class:

MaterialCodeSequence

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

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static MaterialCodeSequence.Holder.Builder	builder()
static MaterialCodeSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsMaterialCodeSequence()
default MaterialCodeSequence	ensureMaterialCodeSequence()	Adds a new Material Code Sequence (see MaterialCodeSequence) with initial capacity 1 (see ensureMaterialCodeSequence(int)) if it does not already exist.
default MaterialCodeSequence	ensureMaterialCodeSequence(int initialCapacity)	Adds a new Material Code Sequence (see MaterialCodeSequence) if it does not already exist.
default MaterialCodeSequence	getMaterialCodeSequence()
default MaterialCodeSequence	newMaterialCodeSequence(int initialCapacity)	Adds a new Material Code Sequence.
default void	removeMaterialCodeSequence()	Removes the Material Code Sequence (see MaterialCodeSequence
static MaterialCodeSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Material Code Sequence (see MaterialCodeSequence)

Returns:

a wrapper object implementing the MaterialCodeSequence.Holder interface.

builder

static MaterialCodeSequence.Holder.Builder builder()

Returns:

a MaterialCodeSequence.Holder.Builder to create Material Code Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getMaterialCodeSequence

default MaterialCodeSequence getMaterialCodeSequence()

Returns:

the Material Code Sequence (see MaterialCodeSequence)

newMaterialCodeSequence

default MaterialCodeSequence newMaterialCodeSequence(int initialCapacity)

Adds a new Material Code Sequence. (see MaterialCodeSequence)

Parameters:

initialCapacity - the initial capacity for the new Material Code Sequence

Returns:

the newly created MaterialCodeSequence.

ensureMaterialCodeSequence

default MaterialCodeSequence ensureMaterialCodeSequence(int initialCapacity)

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

Parameters:

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

Returns:

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

ensureMaterialCodeSequence

default MaterialCodeSequence ensureMaterialCodeSequence()

Adds a new Material Code Sequence (see MaterialCodeSequence) with initial capacity 1 (see ensureMaterialCodeSequence(int)) if it does not already exist.

Returns:

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

containsMaterialCodeSequence

default boolean containsMaterialCodeSequence()

Returns:

whether it contains the Material Code Sequence (see MaterialCodeSequence)

removeMaterialCodeSequence

default void removeMaterialCodeSequence()

Removes the Material Code Sequence (see MaterialCodeSequence