Package org.dcm4che.typeddicom.dataelements

Interface PredecessorProtocolSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

ProtocolContextModule

All Known Implementing Classes:

CTDefinedProcedureProtocolIOD, CTPerformedProcedureProtocolIOD, PredecessorProtocolSequence.SimpleHolder, XADefinedProcedureProtocolIOD, XAPerformedProcedureProtocolIOD

Enclosing class:

PredecessorProtocolSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Predecessor Protocol Sequence" (see PredecessorProtocolSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static PredecessorProtocolSequence.Holder.Builder	builder()
static PredecessorProtocolSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsPredecessorProtocolSequence()
default PredecessorProtocolSequence	ensurePredecessorProtocolSequence()	Adds a new Predecessor Protocol Sequence (see PredecessorProtocolSequence) with initial capacity 1 (see ensurePredecessorProtocolSequence(int)) if it does not already exist.
default PredecessorProtocolSequence	ensurePredecessorProtocolSequence(int initialCapacity)	Adds a new Predecessor Protocol Sequence (see PredecessorProtocolSequence) if it does not already exist.
default PredecessorProtocolSequence	getPredecessorProtocolSequence()
default PredecessorProtocolSequence	newPredecessorProtocolSequence(int initialCapacity)	Adds a new Predecessor Protocol Sequence.
default void	removePredecessorProtocolSequence()	Removes the Predecessor Protocol Sequence (see PredecessorProtocolSequence
static PredecessorProtocolSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Predecessor Protocol Sequence (see PredecessorProtocolSequence)

Returns:

a wrapper object implementing the PredecessorProtocolSequence.Holder interface.

builder

static PredecessorProtocolSequence.Holder.Builder builder()

Returns:

a PredecessorProtocolSequence.Holder.Builder to create Predecessor Protocol Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getPredecessorProtocolSequence

default PredecessorProtocolSequence getPredecessorProtocolSequence()

Returns:

the Predecessor Protocol Sequence (see PredecessorProtocolSequence)

newPredecessorProtocolSequence

default PredecessorProtocolSequence newPredecessorProtocolSequence(int initialCapacity)

Adds a new Predecessor Protocol Sequence. (see PredecessorProtocolSequence)

Parameters:

initialCapacity - the initial capacity for the new Predecessor Protocol Sequence

Returns:

the newly created PredecessorProtocolSequence.

ensurePredecessorProtocolSequence

default PredecessorProtocolSequence ensurePredecessorProtocolSequence(int initialCapacity)

Adds a new Predecessor Protocol Sequence (see PredecessorProtocolSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Predecessor Protocol Sequence (see PredecessorProtocolSequence) or a new one with capacity initialCapacity.

ensurePredecessorProtocolSequence

default PredecessorProtocolSequence ensurePredecessorProtocolSequence()

Adds a new Predecessor Protocol Sequence (see PredecessorProtocolSequence) with initial capacity 1 (see ensurePredecessorProtocolSequence(int)) if it does not already exist.

Returns:

either the already existing Predecessor Protocol Sequence (see PredecessorProtocolSequence) or a new one with capacity 1.

containsPredecessorProtocolSequence

default boolean containsPredecessorProtocolSequence()

Returns:

whether it contains the Predecessor Protocol Sequence (see PredecessorProtocolSequence)

removePredecessorProtocolSequence

default void removePredecessorProtocolSequence()

Removes the Predecessor Protocol Sequence (see PredecessorProtocolSequence