Package org.dcm4che.typeddicom.dataelements

Interface BasisMaterialsCodeSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

Enclosing class:

BasisMaterialsCodeSequence

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

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static BasisMaterialsCodeSequence.Holder.Builder	builder()
static BasisMaterialsCodeSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsBasisMaterialsCodeSequence()
default BasisMaterialsCodeSequence	ensureBasisMaterialsCodeSequence()	Adds a new Basis Materials Code Sequence (see BasisMaterialsCodeSequence) with initial capacity 1 (see ensureBasisMaterialsCodeSequence(int)) if it does not already exist.
default BasisMaterialsCodeSequence	ensureBasisMaterialsCodeSequence(int initialCapacity)	Adds a new Basis Materials Code Sequence (see BasisMaterialsCodeSequence) if it does not already exist.
default BasisMaterialsCodeSequence	getBasisMaterialsCodeSequence()
default BasisMaterialsCodeSequence	newBasisMaterialsCodeSequence(int initialCapacity)	Adds a new Basis Materials Code Sequence.
default void	removeBasisMaterialsCodeSequence()	Removes the Basis Materials Code Sequence (see BasisMaterialsCodeSequence
static BasisMaterialsCodeSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

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

Returns:

a wrapper object implementing the BasisMaterialsCodeSequence.Holder interface.

builder

static BasisMaterialsCodeSequence.Holder.Builder builder()

Returns:

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

builder

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

Parameters:

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

Returns:

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

getBasisMaterialsCodeSequence

default BasisMaterialsCodeSequence getBasisMaterialsCodeSequence()

Returns:

the Basis Materials Code Sequence (see BasisMaterialsCodeSequence)

newBasisMaterialsCodeSequence

default BasisMaterialsCodeSequence newBasisMaterialsCodeSequence(int initialCapacity)

Adds a new Basis Materials Code Sequence. (see BasisMaterialsCodeSequence)

Parameters:

initialCapacity - the initial capacity for the new Basis Materials Code Sequence

Returns:

the newly created BasisMaterialsCodeSequence.

ensureBasisMaterialsCodeSequence

default BasisMaterialsCodeSequence ensureBasisMaterialsCodeSequence(int initialCapacity)

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

Parameters:

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

Returns:

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

ensureBasisMaterialsCodeSequence

default BasisMaterialsCodeSequence ensureBasisMaterialsCodeSequence()

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

Returns:

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

containsBasisMaterialsCodeSequence

default boolean containsBasisMaterialsCodeSequence()

Returns:

whether it contains the Basis Materials Code Sequence (see BasisMaterialsCodeSequence)

removeBasisMaterialsCodeSequence

default void removeBasisMaterialsCodeSequence()

Removes the Basis Materials Code Sequence (see BasisMaterialsCodeSequence