Package org.dcm4che.typeddicom.dataelements

Interface SetupDeviceSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Implementing Classes:

PatientSetupSequence.Item

Enclosing class:

SetupDeviceSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Setup Device Sequence" (see SetupDeviceSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static SetupDeviceSequence.Holder.Builder	builder()
static SetupDeviceSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsSetupDeviceSequence()
default SetupDeviceSequence	ensureSetupDeviceSequence()	Adds a new Setup Device Sequence (see SetupDeviceSequence) with initial capacity 1 (see ensureSetupDeviceSequence(int)) if it does not already exist.
default SetupDeviceSequence	ensureSetupDeviceSequence(int initialCapacity)	Adds a new Setup Device Sequence (see SetupDeviceSequence) if it does not already exist.
default SetupDeviceSequence	getSetupDeviceSequence()
default SetupDeviceSequence	newSetupDeviceSequence(int initialCapacity)	Adds a new Setup Device Sequence.
default void	removeSetupDeviceSequence()	Removes the Setup Device Sequence (see SetupDeviceSequence
static SetupDeviceSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Setup Device Sequence (see SetupDeviceSequence)

Returns:

a wrapper object implementing the SetupDeviceSequence.Holder interface.

builder

static SetupDeviceSequence.Holder.Builder builder()

Returns:

a SetupDeviceSequence.Holder.Builder to create Setup Device Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a SetupDeviceSequence.Holder.Builder to create Setup Device Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getSetupDeviceSequence

default SetupDeviceSequence getSetupDeviceSequence()

Returns:

the Setup Device Sequence (see SetupDeviceSequence)

newSetupDeviceSequence

default SetupDeviceSequence newSetupDeviceSequence(int initialCapacity)

Adds a new Setup Device Sequence. (see SetupDeviceSequence)

Parameters:

initialCapacity - the initial capacity for the new Setup Device Sequence

Returns:

the newly created SetupDeviceSequence.

ensureSetupDeviceSequence

default SetupDeviceSequence ensureSetupDeviceSequence(int initialCapacity)

Adds a new Setup Device Sequence (see SetupDeviceSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Setup Device Sequence (see SetupDeviceSequence) or a new one with capacity initialCapacity.

ensureSetupDeviceSequence

default SetupDeviceSequence ensureSetupDeviceSequence()

Adds a new Setup Device Sequence (see SetupDeviceSequence) with initial capacity 1 (see ensureSetupDeviceSequence(int)) if it does not already exist.

Returns:

either the already existing Setup Device Sequence (see SetupDeviceSequence) or a new one with capacity 1.

containsSetupDeviceSequence

default boolean containsSetupDeviceSequence()

Returns:

whether it contains the Setup Device Sequence (see SetupDeviceSequence)

removeSetupDeviceSequence

default void removeSetupDeviceSequence()

Removes the Setup Device Sequence (see SetupDeviceSequence