Package org.dcm4che.typeddicom.dataelements

Interface ProtocolContextSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Implementing Classes:

PerformedProtocolCodeSequence.Item, ScheduledProtocolCodeSequence.Item

Enclosing class:

ProtocolContextSequence

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

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ProtocolContextSequence.Holder.Builder	builder()
static ProtocolContextSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsProtocolContextSequence()
default ProtocolContextSequence	ensureProtocolContextSequence()	Adds a new Protocol Context Sequence (see ProtocolContextSequence) with initial capacity 1 (see ensureProtocolContextSequence(int)) if it does not already exist.
default ProtocolContextSequence	ensureProtocolContextSequence(int initialCapacity)	Adds a new Protocol Context Sequence (see ProtocolContextSequence) if it does not already exist.
default ProtocolContextSequence	getProtocolContextSequence()
default ProtocolContextSequence	newProtocolContextSequence(int initialCapacity)	Adds a new Protocol Context Sequence.
default void	removeProtocolContextSequence()	Removes the Protocol Context Sequence (see ProtocolContextSequence
static ProtocolContextSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Protocol Context Sequence (see ProtocolContextSequence)

Returns:

a wrapper object implementing the ProtocolContextSequence.Holder interface.

builder

static ProtocolContextSequence.Holder.Builder builder()

Returns:

a ProtocolContextSequence.Holder.Builder to create Protocol Context Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getProtocolContextSequence

default ProtocolContextSequence getProtocolContextSequence()

Returns:

the Protocol Context Sequence (see ProtocolContextSequence)

newProtocolContextSequence

default ProtocolContextSequence newProtocolContextSequence(int initialCapacity)

Adds a new Protocol Context Sequence. (see ProtocolContextSequence)

Parameters:

initialCapacity - the initial capacity for the new Protocol Context Sequence

Returns:

the newly created ProtocolContextSequence.

ensureProtocolContextSequence

default ProtocolContextSequence ensureProtocolContextSequence(int initialCapacity)

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

Parameters:

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

Returns:

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

ensureProtocolContextSequence

default ProtocolContextSequence ensureProtocolContextSequence()

Adds a new Protocol Context Sequence (see ProtocolContextSequence) with initial capacity 1 (see ensureProtocolContextSequence(int)) if it does not already exist.

Returns:

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

containsProtocolContextSequence

default boolean containsProtocolContextSequence()

Returns:

whether it contains the Protocol Context Sequence (see ProtocolContextSequence)

removeProtocolContextSequence

default void removeProtocolContextSequence()

Removes the Protocol Context Sequence (see ProtocolContextSequence