Package org.dcm4che.typeddicom.dataelements

Interface FiducialIdentifierCodeSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Implementing Classes:

FiducialIdentifierCodeSequence.SimpleHolder, FiducialSequence.Item

Enclosing class:

FiducialIdentifierCodeSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Fiducial Identifier Code Sequence" (see FiducialIdentifierCodeSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static FiducialIdentifierCodeSequence.Holder.Builder	builder()
static FiducialIdentifierCodeSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsFiducialIdentifierCodeSequence()
default FiducialIdentifierCodeSequence	ensureFiducialIdentifierCodeSequence()	Adds a new Fiducial Identifier Code Sequence (see FiducialIdentifierCodeSequence) with initial capacity 1 (see ensureFiducialIdentifierCodeSequence(int)) if it does not already exist.
default FiducialIdentifierCodeSequence	ensureFiducialIdentifierCodeSequence(int initialCapacity)	Adds a new Fiducial Identifier Code Sequence (see FiducialIdentifierCodeSequence) if it does not already exist.
default FiducialIdentifierCodeSequence	getFiducialIdentifierCodeSequence()
default FiducialIdentifierCodeSequence	newFiducialIdentifierCodeSequence(int initialCapacity)	Adds a new Fiducial Identifier Code Sequence.
default void	removeFiducialIdentifierCodeSequence()	Removes the Fiducial Identifier Code Sequence (see FiducialIdentifierCodeSequence
static FiducialIdentifierCodeSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Fiducial Identifier Code Sequence (see FiducialIdentifierCodeSequence)

Returns:

a wrapper object implementing the FiducialIdentifierCodeSequence.Holder interface.

builder

static FiducialIdentifierCodeSequence.Holder.Builder builder()

Returns:

a FiducialIdentifierCodeSequence.Holder.Builder to create Fiducial Identifier Code Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getFiducialIdentifierCodeSequence

default FiducialIdentifierCodeSequence getFiducialIdentifierCodeSequence()

Returns:

the Fiducial Identifier Code Sequence (see FiducialIdentifierCodeSequence)

newFiducialIdentifierCodeSequence

default FiducialIdentifierCodeSequence newFiducialIdentifierCodeSequence(int initialCapacity)

Adds a new Fiducial Identifier Code Sequence. (see FiducialIdentifierCodeSequence)

Parameters:

initialCapacity - the initial capacity for the new Fiducial Identifier Code Sequence

Returns:

the newly created FiducialIdentifierCodeSequence.

ensureFiducialIdentifierCodeSequence

default FiducialIdentifierCodeSequence ensureFiducialIdentifierCodeSequence(int initialCapacity)

Adds a new Fiducial Identifier Code Sequence (see FiducialIdentifierCodeSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Fiducial Identifier Code Sequence (see FiducialIdentifierCodeSequence) or a new one with capacity initialCapacity.

ensureFiducialIdentifierCodeSequence

default FiducialIdentifierCodeSequence ensureFiducialIdentifierCodeSequence()

Adds a new Fiducial Identifier Code Sequence (see FiducialIdentifierCodeSequence) with initial capacity 1 (see ensureFiducialIdentifierCodeSequence(int)) if it does not already exist.

Returns:

either the already existing Fiducial Identifier Code Sequence (see FiducialIdentifierCodeSequence) or a new one with capacity 1.

containsFiducialIdentifierCodeSequence

default boolean containsFiducialIdentifierCodeSequence()

Returns:

whether it contains the Fiducial Identifier Code Sequence (see FiducialIdentifierCodeSequence)

removeFiducialIdentifierCodeSequence

default void removeFiducialIdentifierCodeSequence()

Removes the Fiducial Identifier Code Sequence (see FiducialIdentifierCodeSequence