Package org.dcm4che.typeddicom.dataelements

Interface PotentialScheduledProtocolCodeSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

ProtocolContextModule

All Known Implementing Classes:

CTDefinedProcedureProtocolIOD, CTPerformedProcedureProtocolIOD, ProtocolContextModule.SimpleWrapper, XADefinedProcedureProtocolIOD, XAPerformedProcedureProtocolIOD

Enclosing class:

PotentialScheduledProtocolCodeSequence

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

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static PotentialScheduledProtocolCodeSequence.Holder.Builder	builder()
static PotentialScheduledProtocolCodeSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsPotentialScheduledProtocolCodeSequence()
default PotentialScheduledProtocolCodeSequence	ensurePotentialScheduledProtocolCodeSequence()	Adds a new Potential Scheduled Protocol Code Sequence (see PotentialScheduledProtocolCodeSequence) with initial capacity 1 (see ensurePotentialScheduledProtocolCodeSequence(int)) if it does not already exist.
default PotentialScheduledProtocolCodeSequence	ensurePotentialScheduledProtocolCodeSequence(int initialCapacity)	Adds a new Potential Scheduled Protocol Code Sequence (see PotentialScheduledProtocolCodeSequence) if it does not already exist.
default PotentialScheduledProtocolCodeSequence	getPotentialScheduledProtocolCodeSequence()
default PotentialScheduledProtocolCodeSequence	newPotentialScheduledProtocolCodeSequence(int initialCapacity)	Adds a new Potential Scheduled Protocol Code Sequence.
default void	removePotentialScheduledProtocolCodeSequence()	Removes the Potential Scheduled Protocol Code Sequence (see PotentialScheduledProtocolCodeSequence
static PotentialScheduledProtocolCodeSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

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

Returns:

a wrapper object implementing the PotentialScheduledProtocolCodeSequence.Holder interface.

builder

static PotentialScheduledProtocolCodeSequence.Holder.Builder builder()

Returns:

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

builder

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

Parameters:

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

Returns:

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

getPotentialScheduledProtocolCodeSequence

default PotentialScheduledProtocolCodeSequence getPotentialScheduledProtocolCodeSequence()

Returns:

the Potential Scheduled Protocol Code Sequence (see PotentialScheduledProtocolCodeSequence)

newPotentialScheduledProtocolCodeSequence

default PotentialScheduledProtocolCodeSequence newPotentialScheduledProtocolCodeSequence(int initialCapacity)

Adds a new Potential Scheduled Protocol Code Sequence. (see PotentialScheduledProtocolCodeSequence)

Parameters:

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

Returns:

the newly created PotentialScheduledProtocolCodeSequence.

ensurePotentialScheduledProtocolCodeSequence

default PotentialScheduledProtocolCodeSequence ensurePotentialScheduledProtocolCodeSequence(int initialCapacity)

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

Parameters:

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

Returns:

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

ensurePotentialScheduledProtocolCodeSequence

default PotentialScheduledProtocolCodeSequence ensurePotentialScheduledProtocolCodeSequence()

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

Returns:

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

containsPotentialScheduledProtocolCodeSequence

default boolean containsPotentialScheduledProtocolCodeSequence()

Returns:

whether it contains the Potential Scheduled Protocol Code Sequence (see PotentialScheduledProtocolCodeSequence)

removePotentialScheduledProtocolCodeSequence

default void removePotentialScheduledProtocolCodeSequence()

Removes the Potential Scheduled Protocol Code Sequence (see PotentialScheduledProtocolCodeSequence