Package org.dcm4che.typeddicom.dataelements

Interface ScheduledProtocolCodeSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Implementing Classes:

RequestAttributesSequence.Item, ScheduledProcedureStepSequence.Item, ScheduledProtocolCodeSequence.SimpleHolder, ScheduledStepAttributesSequence.Item

Enclosing class:

ScheduledProtocolCodeSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Scheduled Protocol Code Sequence" (see ScheduledProtocolCodeSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ScheduledProtocolCodeSequence.Holder.Builder	builder()
static ScheduledProtocolCodeSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsScheduledProtocolCodeSequence()
default ScheduledProtocolCodeSequence	ensureScheduledProtocolCodeSequence()	Adds a new Scheduled Protocol Code Sequence (see ScheduledProtocolCodeSequence) with initial capacity 1 (see ensureScheduledProtocolCodeSequence(int)) if it does not already exist.
default ScheduledProtocolCodeSequence	ensureScheduledProtocolCodeSequence(int initialCapacity)	Adds a new Scheduled Protocol Code Sequence (see ScheduledProtocolCodeSequence) if it does not already exist.
default ScheduledProtocolCodeSequence	getScheduledProtocolCodeSequence()
default ScheduledProtocolCodeSequence	newScheduledProtocolCodeSequence(int initialCapacity)	Adds a new Scheduled Protocol Code Sequence.
default void	removeScheduledProtocolCodeSequence()	Removes the Scheduled Protocol Code Sequence (see ScheduledProtocolCodeSequence
static ScheduledProtocolCodeSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Scheduled Protocol Code Sequence (see ScheduledProtocolCodeSequence)

Returns:

a wrapper object implementing the ScheduledProtocolCodeSequence.Holder interface.

builder

static ScheduledProtocolCodeSequence.Holder.Builder builder()

Returns:

a ScheduledProtocolCodeSequence.Holder.Builder to create Scheduled Protocol Code Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a ScheduledProtocolCodeSequence.Holder.Builder to create Scheduled Protocol Code Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getScheduledProtocolCodeSequence

default ScheduledProtocolCodeSequence getScheduledProtocolCodeSequence()

Returns:

the Scheduled Protocol Code Sequence (see ScheduledProtocolCodeSequence)

newScheduledProtocolCodeSequence

default ScheduledProtocolCodeSequence newScheduledProtocolCodeSequence(int initialCapacity)

Adds a new Scheduled Protocol Code Sequence. (see ScheduledProtocolCodeSequence)

Parameters:

initialCapacity - the initial capacity for the new Scheduled Protocol Code Sequence

Returns:

the newly created ScheduledProtocolCodeSequence.

ensureScheduledProtocolCodeSequence

default ScheduledProtocolCodeSequence ensureScheduledProtocolCodeSequence(int initialCapacity)

Adds a new Scheduled Protocol Code Sequence (see ScheduledProtocolCodeSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

initialCapacity - the initial capacity (see ArrayList(int)) if a new Scheduled Protocol Code Sequence is created.

Returns:

either the already existing Scheduled Protocol Code Sequence (see ScheduledProtocolCodeSequence) or a new one with capacity initialCapacity.

ensureScheduledProtocolCodeSequence

default ScheduledProtocolCodeSequence ensureScheduledProtocolCodeSequence()

Adds a new Scheduled Protocol Code Sequence (see ScheduledProtocolCodeSequence) with initial capacity 1 (see ensureScheduledProtocolCodeSequence(int)) if it does not already exist.

Returns:

either the already existing Scheduled Protocol Code Sequence (see ScheduledProtocolCodeSequence) or a new one with capacity 1.

containsScheduledProtocolCodeSequence

default boolean containsScheduledProtocolCodeSequence()

Returns:

whether it contains the Scheduled Protocol Code Sequence (see ScheduledProtocolCodeSequence)

removeScheduledProtocolCodeSequence

default void removeScheduledProtocolCodeSequence()

Removes the Scheduled Protocol Code Sequence (see ScheduledProtocolCodeSequence