Package org.dcm4che.typeddicom.dataelements

Interface OmittedBeamTaskSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

RTBeamsDeliveryInstructionModule

All Known Implementing Classes:

RTBeamsDeliveryInstructionIOD, RTBeamsDeliveryInstructionModule.SimpleWrapper

Enclosing class:

OmittedBeamTaskSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Omitted Beam Task Sequence" (see OmittedBeamTaskSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static OmittedBeamTaskSequence.Holder.Builder	builder()
static OmittedBeamTaskSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsOmittedBeamTaskSequence()
default OmittedBeamTaskSequence	ensureOmittedBeamTaskSequence()	Adds a new Omitted Beam Task Sequence (see OmittedBeamTaskSequence) with initial capacity 1 (see ensureOmittedBeamTaskSequence(int)) if it does not already exist.
default OmittedBeamTaskSequence	ensureOmittedBeamTaskSequence(int initialCapacity)	Adds a new Omitted Beam Task Sequence (see OmittedBeamTaskSequence) if it does not already exist.
default OmittedBeamTaskSequence	getOmittedBeamTaskSequence()
default OmittedBeamTaskSequence	newOmittedBeamTaskSequence(int initialCapacity)	Adds a new Omitted Beam Task Sequence.
default void	removeOmittedBeamTaskSequence()	Removes the Omitted Beam Task Sequence (see OmittedBeamTaskSequence
static OmittedBeamTaskSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Omitted Beam Task Sequence (see OmittedBeamTaskSequence)

Returns:

a wrapper object implementing the OmittedBeamTaskSequence.Holder interface.

builder

static OmittedBeamTaskSequence.Holder.Builder builder()

Returns:

a OmittedBeamTaskSequence.Holder.Builder to create Omitted Beam Task Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a OmittedBeamTaskSequence.Holder.Builder to create Omitted Beam Task Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getOmittedBeamTaskSequence

default OmittedBeamTaskSequence getOmittedBeamTaskSequence()

Returns:

the Omitted Beam Task Sequence (see OmittedBeamTaskSequence)

newOmittedBeamTaskSequence

default OmittedBeamTaskSequence newOmittedBeamTaskSequence(int initialCapacity)

Adds a new Omitted Beam Task Sequence. (see OmittedBeamTaskSequence)

Parameters:

initialCapacity - the initial capacity for the new Omitted Beam Task Sequence

Returns:

the newly created OmittedBeamTaskSequence.

ensureOmittedBeamTaskSequence

default OmittedBeamTaskSequence ensureOmittedBeamTaskSequence(int initialCapacity)

Adds a new Omitted Beam Task Sequence (see OmittedBeamTaskSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Omitted Beam Task Sequence (see OmittedBeamTaskSequence) or a new one with capacity initialCapacity.

ensureOmittedBeamTaskSequence

default OmittedBeamTaskSequence ensureOmittedBeamTaskSequence()

Adds a new Omitted Beam Task Sequence (see OmittedBeamTaskSequence) with initial capacity 1 (see ensureOmittedBeamTaskSequence(int)) if it does not already exist.

Returns:

either the already existing Omitted Beam Task Sequence (see OmittedBeamTaskSequence) or a new one with capacity 1.

containsOmittedBeamTaskSequence

default boolean containsOmittedBeamTaskSequence()

Returns:

whether it contains the Omitted Beam Task Sequence (see OmittedBeamTaskSequence)

removeOmittedBeamTaskSequence

default void removeOmittedBeamTaskSequence()

Removes the Omitted Beam Task Sequence (see OmittedBeamTaskSequence