Package org.dcm4che.typeddicom.dataelements

Interface BeamAreaLimitSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Implementing Classes:

BeamAreaLimitSequence.SimpleHolder, CArmPhotonElectronControlPointSequence.Item, RoboticPathControlPointSequence.Item, TomotherapeuticControlPointSequence.Item

Enclosing class:

BeamAreaLimitSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Beam Area Limit Sequence" (see BeamAreaLimitSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static BeamAreaLimitSequence.Holder.Builder	builder()
static BeamAreaLimitSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsBeamAreaLimitSequence()
default BeamAreaLimitSequence	ensureBeamAreaLimitSequence()	Adds a new Beam Area Limit Sequence (see BeamAreaLimitSequence) with initial capacity 1 (see ensureBeamAreaLimitSequence(int)) if it does not already exist.
default BeamAreaLimitSequence	ensureBeamAreaLimitSequence(int initialCapacity)	Adds a new Beam Area Limit Sequence (see BeamAreaLimitSequence) if it does not already exist.
default BeamAreaLimitSequence	getBeamAreaLimitSequence()
default BeamAreaLimitSequence	newBeamAreaLimitSequence(int initialCapacity)	Adds a new Beam Area Limit Sequence.
default void	removeBeamAreaLimitSequence()	Removes the Beam Area Limit Sequence (see BeamAreaLimitSequence
static BeamAreaLimitSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Beam Area Limit Sequence (see BeamAreaLimitSequence)

Returns:

a wrapper object implementing the BeamAreaLimitSequence.Holder interface.

builder

static BeamAreaLimitSequence.Holder.Builder builder()

Returns:

a BeamAreaLimitSequence.Holder.Builder to create Beam Area Limit Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a BeamAreaLimitSequence.Holder.Builder to create Beam Area Limit Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getBeamAreaLimitSequence

default BeamAreaLimitSequence getBeamAreaLimitSequence()

Returns:

the Beam Area Limit Sequence (see BeamAreaLimitSequence)

newBeamAreaLimitSequence

default BeamAreaLimitSequence newBeamAreaLimitSequence(int initialCapacity)

Adds a new Beam Area Limit Sequence. (see BeamAreaLimitSequence)

Parameters:

initialCapacity - the initial capacity for the new Beam Area Limit Sequence

Returns:

the newly created BeamAreaLimitSequence.

ensureBeamAreaLimitSequence

default BeamAreaLimitSequence ensureBeamAreaLimitSequence(int initialCapacity)

Adds a new Beam Area Limit Sequence (see BeamAreaLimitSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Beam Area Limit Sequence (see BeamAreaLimitSequence) or a new one with capacity initialCapacity.

ensureBeamAreaLimitSequence

default BeamAreaLimitSequence ensureBeamAreaLimitSequence()

Adds a new Beam Area Limit Sequence (see BeamAreaLimitSequence) with initial capacity 1 (see ensureBeamAreaLimitSequence(int)) if it does not already exist.

Returns:

either the already existing Beam Area Limit Sequence (see BeamAreaLimitSequence) or a new one with capacity 1.

containsBeamAreaLimitSequence

default boolean containsBeamAreaLimitSequence()

Returns:

whether it contains the Beam Area Limit Sequence (see BeamAreaLimitSequence)

removeBeamAreaLimitSequence

default void removeBeamAreaLimitSequence()

Removes the Beam Area Limit Sequence (see BeamAreaLimitSequence