Package org.dcm4che.typeddicom.dataelements

Interface MaterialsCodeSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

GenericImplantTemplateDescriptionModule

All Known Implementing Classes:

GenericImplantTemplateDescriptionModule.SimpleWrapper, GenericImplantTemplateIOD

Enclosing class:

MaterialsCodeSequence

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

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static MaterialsCodeSequence.Holder.Builder	builder()
static MaterialsCodeSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsMaterialsCodeSequence()
default MaterialsCodeSequence	ensureMaterialsCodeSequence()	Adds a new Materials Code Sequence (see MaterialsCodeSequence) with initial capacity 1 (see ensureMaterialsCodeSequence(int)) if it does not already exist.
default MaterialsCodeSequence	ensureMaterialsCodeSequence(int initialCapacity)	Adds a new Materials Code Sequence (see MaterialsCodeSequence) if it does not already exist.
default MaterialsCodeSequence	getMaterialsCodeSequence()
default MaterialsCodeSequence	newMaterialsCodeSequence(int initialCapacity)	Adds a new Materials Code Sequence.
default void	removeMaterialsCodeSequence()	Removes the Materials Code Sequence (see MaterialsCodeSequence
static MaterialsCodeSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Materials Code Sequence (see MaterialsCodeSequence)

Returns:

a wrapper object implementing the MaterialsCodeSequence.Holder interface.

builder

static MaterialsCodeSequence.Holder.Builder builder()

Returns:

a MaterialsCodeSequence.Holder.Builder to create Materials Code Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getMaterialsCodeSequence

default MaterialsCodeSequence getMaterialsCodeSequence()

Returns:

the Materials Code Sequence (see MaterialsCodeSequence)

newMaterialsCodeSequence

default MaterialsCodeSequence newMaterialsCodeSequence(int initialCapacity)

Adds a new Materials Code Sequence. (see MaterialsCodeSequence)

Parameters:

initialCapacity - the initial capacity for the new Materials Code Sequence

Returns:

the newly created MaterialsCodeSequence.

ensureMaterialsCodeSequence

default MaterialsCodeSequence ensureMaterialsCodeSequence(int initialCapacity)

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

Parameters:

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

Returns:

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

ensureMaterialsCodeSequence

default MaterialsCodeSequence ensureMaterialsCodeSequence()

Adds a new Materials Code Sequence (see MaterialsCodeSequence) with initial capacity 1 (see ensureMaterialsCodeSequence(int)) if it does not already exist.

Returns:

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

containsMaterialsCodeSequence

default boolean containsMaterialsCodeSequence()

Returns:

whether it contains the Materials Code Sequence (see MaterialsCodeSequence)

removeMaterialsCodeSequence

default void removeMaterialsCodeSequence()

Removes the Materials Code Sequence (see MaterialsCodeSequence