Package org.dcm4che.typeddicom.dataelements

Interface SourceHangingProtocolSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

HangingProtocolDefinitionModule

All Known Implementing Classes:

HangingProtocolDefinitionModule.SimpleWrapper, HangingProtocolIOD

Enclosing class:

SourceHangingProtocolSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Source Hanging Protocol Sequence" (see SourceHangingProtocolSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static SourceHangingProtocolSequence.Holder.Builder	builder()
static SourceHangingProtocolSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsSourceHangingProtocolSequence()
default SourceHangingProtocolSequence	ensureSourceHangingProtocolSequence()	Adds a new Source Hanging Protocol Sequence (see SourceHangingProtocolSequence) with initial capacity 1 (see ensureSourceHangingProtocolSequence(int)) if it does not already exist.
default SourceHangingProtocolSequence	ensureSourceHangingProtocolSequence(int initialCapacity)	Adds a new Source Hanging Protocol Sequence (see SourceHangingProtocolSequence) if it does not already exist.
default SourceHangingProtocolSequence	getSourceHangingProtocolSequence()
default SourceHangingProtocolSequence	newSourceHangingProtocolSequence(int initialCapacity)	Adds a new Source Hanging Protocol Sequence.
default void	removeSourceHangingProtocolSequence()	Removes the Source Hanging Protocol Sequence (see SourceHangingProtocolSequence
static SourceHangingProtocolSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Source Hanging Protocol Sequence (see SourceHangingProtocolSequence)

Returns:

a wrapper object implementing the SourceHangingProtocolSequence.Holder interface.

builder

static SourceHangingProtocolSequence.Holder.Builder builder()

Returns:

a SourceHangingProtocolSequence.Holder.Builder to create Source Hanging Protocol Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getSourceHangingProtocolSequence

default SourceHangingProtocolSequence getSourceHangingProtocolSequence()

Returns:

the Source Hanging Protocol Sequence (see SourceHangingProtocolSequence)

newSourceHangingProtocolSequence

default SourceHangingProtocolSequence newSourceHangingProtocolSequence(int initialCapacity)

Adds a new Source Hanging Protocol Sequence. (see SourceHangingProtocolSequence)

Parameters:

initialCapacity - the initial capacity for the new Source Hanging Protocol Sequence

Returns:

the newly created SourceHangingProtocolSequence.

ensureSourceHangingProtocolSequence

default SourceHangingProtocolSequence ensureSourceHangingProtocolSequence(int initialCapacity)

Adds a new Source Hanging Protocol Sequence (see SourceHangingProtocolSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Source Hanging Protocol Sequence (see SourceHangingProtocolSequence) or a new one with capacity initialCapacity.

ensureSourceHangingProtocolSequence

default SourceHangingProtocolSequence ensureSourceHangingProtocolSequence()

Adds a new Source Hanging Protocol Sequence (see SourceHangingProtocolSequence) with initial capacity 1 (see ensureSourceHangingProtocolSequence(int)) if it does not already exist.

Returns:

either the already existing Source Hanging Protocol Sequence (see SourceHangingProtocolSequence) or a new one with capacity 1.

containsSourceHangingProtocolSequence

default boolean containsSourceHangingProtocolSequence()

Returns:

whether it contains the Source Hanging Protocol Sequence (see SourceHangingProtocolSequence)

removeSourceHangingProtocolSequence

default void removeSourceHangingProtocolSequence()

Removes the Source Hanging Protocol Sequence (see SourceHangingProtocolSequence