Package org.dcm4che.typeddicom.dataelements

Interface PlanningInputInformationSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Implementing Classes:

PlanningInputInformationSequence.SimpleHolder, RTPrescriptionSequence.Item

Enclosing class:

PlanningInputInformationSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Planning Input Information Sequence" (see PlanningInputInformationSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static PlanningInputInformationSequence.Holder.Builder	builder()
static PlanningInputInformationSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsPlanningInputInformationSequence()
default PlanningInputInformationSequence	ensurePlanningInputInformationSequence()	Adds a new Planning Input Information Sequence (see PlanningInputInformationSequence) with initial capacity 1 (see ensurePlanningInputInformationSequence(int)) if it does not already exist.
default PlanningInputInformationSequence	ensurePlanningInputInformationSequence(int initialCapacity)	Adds a new Planning Input Information Sequence (see PlanningInputInformationSequence) if it does not already exist.
default PlanningInputInformationSequence	getPlanningInputInformationSequence()
default PlanningInputInformationSequence	newPlanningInputInformationSequence(int initialCapacity)	Adds a new Planning Input Information Sequence.
default void	removePlanningInputInformationSequence()	Removes the Planning Input Information Sequence (see PlanningInputInformationSequence
static PlanningInputInformationSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Planning Input Information Sequence (see PlanningInputInformationSequence)

Returns:

a wrapper object implementing the PlanningInputInformationSequence.Holder interface.

builder

static PlanningInputInformationSequence.Holder.Builder builder()

Returns:

a PlanningInputInformationSequence.Holder.Builder to create Planning Input Information Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a PlanningInputInformationSequence.Holder.Builder to create Planning Input Information Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getPlanningInputInformationSequence

default PlanningInputInformationSequence getPlanningInputInformationSequence()

Returns:

the Planning Input Information Sequence (see PlanningInputInformationSequence)

newPlanningInputInformationSequence

default PlanningInputInformationSequence newPlanningInputInformationSequence(int initialCapacity)

Adds a new Planning Input Information Sequence. (see PlanningInputInformationSequence)

Parameters:

initialCapacity - the initial capacity for the new Planning Input Information Sequence

Returns:

the newly created PlanningInputInformationSequence.

ensurePlanningInputInformationSequence

default PlanningInputInformationSequence ensurePlanningInputInformationSequence(int initialCapacity)

Adds a new Planning Input Information Sequence (see PlanningInputInformationSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

initialCapacity - the initial capacity (see ArrayList(int)) if a new Planning Input Information Sequence is created.

Returns:

either the already existing Planning Input Information Sequence (see PlanningInputInformationSequence) or a new one with capacity initialCapacity.

ensurePlanningInputInformationSequence

default PlanningInputInformationSequence ensurePlanningInputInformationSequence()

Adds a new Planning Input Information Sequence (see PlanningInputInformationSequence) with initial capacity 1 (see ensurePlanningInputInformationSequence(int)) if it does not already exist.

Returns:

either the already existing Planning Input Information Sequence (see PlanningInputInformationSequence) or a new one with capacity 1.

containsPlanningInputInformationSequence

default boolean containsPlanningInputInformationSequence()

Returns:

whether it contains the Planning Input Information Sequence (see PlanningInputInformationSequence)

removePlanningInputInformationSequence

default void removePlanningInputInformationSequence()

Removes the Planning Input Information Sequence (see PlanningInputInformationSequence