Package org.dcm4che.typeddicom.dataelements

Interface OmittedRadiationSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

RTRadiationSetDeliveryInstructionModule

All Known Implementing Classes:

OmittedRadiationSequence.SimpleHolder, RTRadiationSetDeliveryInstructionIOD

Enclosing class:

OmittedRadiationSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Omitted Radiation Sequence" (see OmittedRadiationSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static OmittedRadiationSequence.Holder.Builder	builder()
static OmittedRadiationSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsOmittedRadiationSequence()
default OmittedRadiationSequence	ensureOmittedRadiationSequence()	Adds a new Omitted Radiation Sequence (see OmittedRadiationSequence) with initial capacity 1 (see ensureOmittedRadiationSequence(int)) if it does not already exist.
default OmittedRadiationSequence	ensureOmittedRadiationSequence(int initialCapacity)	Adds a new Omitted Radiation Sequence (see OmittedRadiationSequence) if it does not already exist.
default OmittedRadiationSequence	getOmittedRadiationSequence()
default OmittedRadiationSequence	newOmittedRadiationSequence(int initialCapacity)	Adds a new Omitted Radiation Sequence.
default void	removeOmittedRadiationSequence()	Removes the Omitted Radiation Sequence (see OmittedRadiationSequence
static OmittedRadiationSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Omitted Radiation Sequence (see OmittedRadiationSequence)

Returns:

a wrapper object implementing the OmittedRadiationSequence.Holder interface.

builder

static OmittedRadiationSequence.Holder.Builder builder()

Returns:

a OmittedRadiationSequence.Holder.Builder to create Omitted Radiation Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getOmittedRadiationSequence

default OmittedRadiationSequence getOmittedRadiationSequence()

Returns:

the Omitted Radiation Sequence (see OmittedRadiationSequence)

newOmittedRadiationSequence

default OmittedRadiationSequence newOmittedRadiationSequence(int initialCapacity)

Adds a new Omitted Radiation Sequence. (see OmittedRadiationSequence)

Parameters:

initialCapacity - the initial capacity for the new Omitted Radiation Sequence

Returns:

the newly created OmittedRadiationSequence.

ensureOmittedRadiationSequence

default OmittedRadiationSequence ensureOmittedRadiationSequence(int initialCapacity)

Adds a new Omitted Radiation Sequence (see OmittedRadiationSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Omitted Radiation Sequence (see OmittedRadiationSequence) or a new one with capacity initialCapacity.

ensureOmittedRadiationSequence

default OmittedRadiationSequence ensureOmittedRadiationSequence()

Adds a new Omitted Radiation Sequence (see OmittedRadiationSequence) with initial capacity 1 (see ensureOmittedRadiationSequence(int)) if it does not already exist.

Returns:

either the already existing Omitted Radiation Sequence (see OmittedRadiationSequence) or a new one with capacity 1.

containsOmittedRadiationSequence

default boolean containsOmittedRadiationSequence()

Returns:

whether it contains the Omitted Radiation Sequence (see OmittedRadiationSequence)

removeOmittedRadiationSequence

default void removeOmittedRadiationSequence()

Removes the Omitted Radiation Sequence (see OmittedRadiationSequence