Package org.dcm4che.typeddicom.dataelements

Interface ReferencedBeamSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Implementing Classes:

FractionGroupSequence.Item, ReferencedFractionGroupSequence.Item, ReferencedTreatmentRecordSequence.Item

Enclosing class:

ReferencedBeamSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Referenced Beam Sequence" (see ReferencedBeamSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ReferencedBeamSequence.Holder.Builder	builder()
static ReferencedBeamSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsReferencedBeamSequence()
default ReferencedBeamSequence	ensureReferencedBeamSequence()	Adds a new Referenced Beam Sequence (see ReferencedBeamSequence) with initial capacity 1 (see ensureReferencedBeamSequence(int)) if it does not already exist.
default ReferencedBeamSequence	ensureReferencedBeamSequence(int initialCapacity)	Adds a new Referenced Beam Sequence (see ReferencedBeamSequence) if it does not already exist.
default ReferencedBeamSequence	getReferencedBeamSequence()
default ReferencedBeamSequence	newReferencedBeamSequence(int initialCapacity)	Adds a new Referenced Beam Sequence.
default void	removeReferencedBeamSequence()	Removes the Referenced Beam Sequence (see ReferencedBeamSequence
static ReferencedBeamSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Referenced Beam Sequence (see ReferencedBeamSequence)

Returns:

a wrapper object implementing the ReferencedBeamSequence.Holder interface.

builder

static ReferencedBeamSequence.Holder.Builder builder()

Returns:

a ReferencedBeamSequence.Holder.Builder to create Referenced Beam Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getReferencedBeamSequence

default ReferencedBeamSequence getReferencedBeamSequence()

Returns:

the Referenced Beam Sequence (see ReferencedBeamSequence)

newReferencedBeamSequence

default ReferencedBeamSequence newReferencedBeamSequence(int initialCapacity)

Adds a new Referenced Beam Sequence. (see ReferencedBeamSequence)

Parameters:

initialCapacity - the initial capacity for the new Referenced Beam Sequence

Returns:

the newly created ReferencedBeamSequence.

ensureReferencedBeamSequence

default ReferencedBeamSequence ensureReferencedBeamSequence(int initialCapacity)

Adds a new Referenced Beam Sequence (see ReferencedBeamSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Referenced Beam Sequence (see ReferencedBeamSequence) or a new one with capacity initialCapacity.

ensureReferencedBeamSequence

default ReferencedBeamSequence ensureReferencedBeamSequence()

Adds a new Referenced Beam Sequence (see ReferencedBeamSequence) with initial capacity 1 (see ensureReferencedBeamSequence(int)) if it does not already exist.

Returns:

either the already existing Referenced Beam Sequence (see ReferencedBeamSequence) or a new one with capacity 1.

containsReferencedBeamSequence

default boolean containsReferencedBeamSequence()

Returns:

whether it contains the Referenced Beam Sequence (see ReferencedBeamSequence)

removeReferencedBeamSequence

default void removeReferencedBeamSequence()

Removes the Referenced Beam Sequence (see ReferencedBeamSequence