Package org.dcm4che.typeddicom.dataelements

Interface BeamLimitingDeviceSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Implementing Classes:

BeamSequence.Item, ExposureSequence.Item

Enclosing class:

BeamLimitingDeviceSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Beam Limiting Device Sequence" (see BeamLimitingDeviceSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static BeamLimitingDeviceSequence.Holder.Builder	builder()
static BeamLimitingDeviceSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsBeamLimitingDeviceSequence()
default BeamLimitingDeviceSequence	ensureBeamLimitingDeviceSequence()	Adds a new Beam Limiting Device Sequence (see BeamLimitingDeviceSequence) with initial capacity 1 (see ensureBeamLimitingDeviceSequence(int)) if it does not already exist.
default BeamLimitingDeviceSequence	ensureBeamLimitingDeviceSequence(int initialCapacity)	Adds a new Beam Limiting Device Sequence (see BeamLimitingDeviceSequence) if it does not already exist.
default BeamLimitingDeviceSequence	getBeamLimitingDeviceSequence()
default BeamLimitingDeviceSequence	newBeamLimitingDeviceSequence(int initialCapacity)	Adds a new Beam Limiting Device Sequence.
default void	removeBeamLimitingDeviceSequence()	Removes the Beam Limiting Device Sequence (see BeamLimitingDeviceSequence
static BeamLimitingDeviceSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Beam Limiting Device Sequence (see BeamLimitingDeviceSequence)

Returns:

a wrapper object implementing the BeamLimitingDeviceSequence.Holder interface.

builder

static BeamLimitingDeviceSequence.Holder.Builder builder()

Returns:

a BeamLimitingDeviceSequence.Holder.Builder to create Beam Limiting Device Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getBeamLimitingDeviceSequence

default BeamLimitingDeviceSequence getBeamLimitingDeviceSequence()

Returns:

the Beam Limiting Device Sequence (see BeamLimitingDeviceSequence)

newBeamLimitingDeviceSequence

default BeamLimitingDeviceSequence newBeamLimitingDeviceSequence(int initialCapacity)

Adds a new Beam Limiting Device Sequence. (see BeamLimitingDeviceSequence)

Parameters:

initialCapacity - the initial capacity for the new Beam Limiting Device Sequence

Returns:

the newly created BeamLimitingDeviceSequence.

ensureBeamLimitingDeviceSequence

default BeamLimitingDeviceSequence ensureBeamLimitingDeviceSequence(int initialCapacity)

Adds a new Beam Limiting Device Sequence (see BeamLimitingDeviceSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Beam Limiting Device Sequence (see BeamLimitingDeviceSequence) or a new one with capacity initialCapacity.

ensureBeamLimitingDeviceSequence

default BeamLimitingDeviceSequence ensureBeamLimitingDeviceSequence()

Adds a new Beam Limiting Device Sequence (see BeamLimitingDeviceSequence) with initial capacity 1 (see ensureBeamLimitingDeviceSequence(int)) if it does not already exist.

Returns:

either the already existing Beam Limiting Device Sequence (see BeamLimitingDeviceSequence) or a new one with capacity 1.

containsBeamLimitingDeviceSequence

default boolean containsBeamLimitingDeviceSequence()

Returns:

whether it contains the Beam Limiting Device Sequence (see BeamLimitingDeviceSequence)

removeBeamLimitingDeviceSequence

default void removeBeamLimitingDeviceSequence()

Removes the Beam Limiting Device Sequence (see BeamLimitingDeviceSequence