Package org.dcm4che.typeddicom.dataelements

Interface ChemicalShiftSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

Enclosing class:

ChemicalShiftSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Chemical Shift Sequence" (see ChemicalShiftSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ChemicalShiftSequence.Holder.Builder	builder()
static ChemicalShiftSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsChemicalShiftSequence()
default ChemicalShiftSequence	ensureChemicalShiftSequence()	Adds a new Chemical Shift Sequence (see ChemicalShiftSequence) with initial capacity 1 (see ensureChemicalShiftSequence(int)) if it does not already exist.
default ChemicalShiftSequence	ensureChemicalShiftSequence(int initialCapacity)	Adds a new Chemical Shift Sequence (see ChemicalShiftSequence) if it does not already exist.
default ChemicalShiftSequence	getChemicalShiftSequence()
default ChemicalShiftSequence	newChemicalShiftSequence(int initialCapacity)	Adds a new Chemical Shift Sequence.
default void	removeChemicalShiftSequence()	Removes the Chemical Shift Sequence (see ChemicalShiftSequence
static ChemicalShiftSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Chemical Shift Sequence (see ChemicalShiftSequence)

Returns:

a wrapper object implementing the ChemicalShiftSequence.Holder interface.

builder

static ChemicalShiftSequence.Holder.Builder builder()

Returns:

a ChemicalShiftSequence.Holder.Builder to create Chemical Shift Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a ChemicalShiftSequence.Holder.Builder to create Chemical Shift Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getChemicalShiftSequence

default ChemicalShiftSequence getChemicalShiftSequence()

Returns:

the Chemical Shift Sequence (see ChemicalShiftSequence)

newChemicalShiftSequence

default ChemicalShiftSequence newChemicalShiftSequence(int initialCapacity)

Adds a new Chemical Shift Sequence. (see ChemicalShiftSequence)

Parameters:

initialCapacity - the initial capacity for the new Chemical Shift Sequence

Returns:

the newly created ChemicalShiftSequence.

ensureChemicalShiftSequence

default ChemicalShiftSequence ensureChemicalShiftSequence(int initialCapacity)

Adds a new Chemical Shift Sequence (see ChemicalShiftSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Chemical Shift Sequence (see ChemicalShiftSequence) or a new one with capacity initialCapacity.

ensureChemicalShiftSequence

default ChemicalShiftSequence ensureChemicalShiftSequence()

Adds a new Chemical Shift Sequence (see ChemicalShiftSequence) with initial capacity 1 (see ensureChemicalShiftSequence(int)) if it does not already exist.

Returns:

either the already existing Chemical Shift Sequence (see ChemicalShiftSequence) or a new one with capacity 1.

containsChemicalShiftSequence

default boolean containsChemicalShiftSequence()

Returns:

whether it contains the Chemical Shift Sequence (see ChemicalShiftSequence)

removeChemicalShiftSequence

default void removeChemicalShiftSequence()

Removes the Chemical Shift Sequence (see ChemicalShiftSequence