Package org.dcm4che.typeddicom.dataelements

Interface FractionPatternSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

RTRadiationSetModule

All Known Implementing Classes:

FractionPatternSequence.SimpleHolder, RTPrescriptionSequence.Item, RTRadiationSetIOD

Enclosing class:

FractionPatternSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Fraction Pattern Sequence" (see FractionPatternSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static FractionPatternSequence.Holder.Builder	builder()
static FractionPatternSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsFractionPatternSequence()
default FractionPatternSequence	ensureFractionPatternSequence()	Adds a new Fraction Pattern Sequence (see FractionPatternSequence) with initial capacity 1 (see ensureFractionPatternSequence(int)) if it does not already exist.
default FractionPatternSequence	ensureFractionPatternSequence(int initialCapacity)	Adds a new Fraction Pattern Sequence (see FractionPatternSequence) if it does not already exist.
default FractionPatternSequence	getFractionPatternSequence()
default FractionPatternSequence	newFractionPatternSequence(int initialCapacity)	Adds a new Fraction Pattern Sequence.
default void	removeFractionPatternSequence()	Removes the Fraction Pattern Sequence (see FractionPatternSequence
static FractionPatternSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Fraction Pattern Sequence (see FractionPatternSequence)

Returns:

a wrapper object implementing the FractionPatternSequence.Holder interface.

builder

static FractionPatternSequence.Holder.Builder builder()

Returns:

a FractionPatternSequence.Holder.Builder to create Fraction Pattern Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a FractionPatternSequence.Holder.Builder to create Fraction Pattern Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getFractionPatternSequence

default FractionPatternSequence getFractionPatternSequence()

Returns:

the Fraction Pattern Sequence (see FractionPatternSequence)

newFractionPatternSequence

default FractionPatternSequence newFractionPatternSequence(int initialCapacity)

Adds a new Fraction Pattern Sequence. (see FractionPatternSequence)

Parameters:

initialCapacity - the initial capacity for the new Fraction Pattern Sequence

Returns:

the newly created FractionPatternSequence.

ensureFractionPatternSequence

default FractionPatternSequence ensureFractionPatternSequence(int initialCapacity)

Adds a new Fraction Pattern Sequence (see FractionPatternSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Fraction Pattern Sequence (see FractionPatternSequence) or a new one with capacity initialCapacity.

ensureFractionPatternSequence

default FractionPatternSequence ensureFractionPatternSequence()

Adds a new Fraction Pattern Sequence (see FractionPatternSequence) with initial capacity 1 (see ensureFractionPatternSequence(int)) if it does not already exist.

Returns:

either the already existing Fraction Pattern Sequence (see FractionPatternSequence) or a new one with capacity 1.

containsFractionPatternSequence

default boolean containsFractionPatternSequence()

Returns:

whether it contains the Fraction Pattern Sequence (see FractionPatternSequence)

removeFractionPatternSequence

default void removeFractionPatternSequence()

Removes the Fraction Pattern Sequence (see FractionPatternSequence