Package org.dcm4che.typeddicom.dataelements

Interface FixationDeviceSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Implementing Classes:

PatientSetupSequence.Item

Enclosing class:

FixationDeviceSequence

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

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static FixationDeviceSequence.Holder.Builder	builder()
static FixationDeviceSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsFixationDeviceSequence()
default FixationDeviceSequence	ensureFixationDeviceSequence()	Adds a new Fixation Device Sequence (see FixationDeviceSequence) with initial capacity 1 (see ensureFixationDeviceSequence(int)) if it does not already exist.
default FixationDeviceSequence	ensureFixationDeviceSequence(int initialCapacity)	Adds a new Fixation Device Sequence (see FixationDeviceSequence) if it does not already exist.
default FixationDeviceSequence	getFixationDeviceSequence()
default FixationDeviceSequence	newFixationDeviceSequence(int initialCapacity)	Adds a new Fixation Device Sequence.
default void	removeFixationDeviceSequence()	Removes the Fixation Device Sequence (see FixationDeviceSequence
static FixationDeviceSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Fixation Device Sequence (see FixationDeviceSequence)

Returns:

a wrapper object implementing the FixationDeviceSequence.Holder interface.

builder

static FixationDeviceSequence.Holder.Builder builder()

Returns:

a FixationDeviceSequence.Holder.Builder to create Fixation Device Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getFixationDeviceSequence

default FixationDeviceSequence getFixationDeviceSequence()

Returns:

the Fixation Device Sequence (see FixationDeviceSequence)

newFixationDeviceSequence

default FixationDeviceSequence newFixationDeviceSequence(int initialCapacity)

Adds a new Fixation Device Sequence. (see FixationDeviceSequence)

Parameters:

initialCapacity - the initial capacity for the new Fixation Device Sequence

Returns:

the newly created FixationDeviceSequence.

ensureFixationDeviceSequence

default FixationDeviceSequence ensureFixationDeviceSequence(int initialCapacity)

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

Parameters:

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

Returns:

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

ensureFixationDeviceSequence

default FixationDeviceSequence ensureFixationDeviceSequence()

Adds a new Fixation Device Sequence (see FixationDeviceSequence) with initial capacity 1 (see ensureFixationDeviceSequence(int)) if it does not already exist.

Returns:

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

containsFixationDeviceSequence

default boolean containsFixationDeviceSequence()

Returns:

whether it contains the Fixation Device Sequence (see FixationDeviceSequence)

removeFixationDeviceSequence

default void removeFixationDeviceSequence()

Removes the Fixation Device Sequence (see FixationDeviceSequence