Package org.dcm4che.typeddicom.dataelements

Interface GateSettingsSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

Enclosing class:

GateSettingsSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Gate Settings Sequence" (see GateSettingsSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static GateSettingsSequence.Holder.Builder	builder()
static GateSettingsSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsGateSettingsSequence()
default GateSettingsSequence	ensureGateSettingsSequence()	Adds a new Gate Settings Sequence (see GateSettingsSequence) with initial capacity 1 (see ensureGateSettingsSequence(int)) if it does not already exist.
default GateSettingsSequence	ensureGateSettingsSequence(int initialCapacity)	Adds a new Gate Settings Sequence (see GateSettingsSequence) if it does not already exist.
default GateSettingsSequence	getGateSettingsSequence()
default GateSettingsSequence	newGateSettingsSequence(int initialCapacity)	Adds a new Gate Settings Sequence.
default void	removeGateSettingsSequence()	Removes the Gate Settings Sequence (see GateSettingsSequence
static GateSettingsSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Gate Settings Sequence (see GateSettingsSequence)

Returns:

a wrapper object implementing the GateSettingsSequence.Holder interface.

builder

static GateSettingsSequence.Holder.Builder builder()

Returns:

a GateSettingsSequence.Holder.Builder to create Gate Settings Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a GateSettingsSequence.Holder.Builder to create Gate Settings Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getGateSettingsSequence

default GateSettingsSequence getGateSettingsSequence()

Returns:

the Gate Settings Sequence (see GateSettingsSequence)

newGateSettingsSequence

default GateSettingsSequence newGateSettingsSequence(int initialCapacity)

Adds a new Gate Settings Sequence. (see GateSettingsSequence)

Parameters:

initialCapacity - the initial capacity for the new Gate Settings Sequence

Returns:

the newly created GateSettingsSequence.

ensureGateSettingsSequence

default GateSettingsSequence ensureGateSettingsSequence(int initialCapacity)

Adds a new Gate Settings Sequence (see GateSettingsSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Gate Settings Sequence (see GateSettingsSequence) or a new one with capacity initialCapacity.

ensureGateSettingsSequence

default GateSettingsSequence ensureGateSettingsSequence()

Adds a new Gate Settings Sequence (see GateSettingsSequence) with initial capacity 1 (see ensureGateSettingsSequence(int)) if it does not already exist.

Returns:

either the already existing Gate Settings Sequence (see GateSettingsSequence) or a new one with capacity 1.

containsGateSettingsSequence

default boolean containsGateSettingsSequence()

Returns:

whether it contains the Gate Settings Sequence (see GateSettingsSequence)

removeGateSettingsSequence

default void removeGateSettingsSequence()

Removes the Gate Settings Sequence (see GateSettingsSequence