Package org.dcm4che.typeddicom.dataelements

Interface HangingProtocolDefinitionSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

HangingProtocolDefinitionModule

All Known Implementing Classes:

HangingProtocolDefinitionSequence.SimpleHolder, HangingProtocolIOD

Enclosing class:

HangingProtocolDefinitionSequence

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

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static HangingProtocolDefinitionSequence.Holder.Builder	builder()
static HangingProtocolDefinitionSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsHangingProtocolDefinitionSequence()
default HangingProtocolDefinitionSequence	ensureHangingProtocolDefinitionSequence()	Adds a new Hanging Protocol Definition Sequence (see HangingProtocolDefinitionSequence) with initial capacity 1 (see ensureHangingProtocolDefinitionSequence(int)) if it does not already exist.
default HangingProtocolDefinitionSequence	ensureHangingProtocolDefinitionSequence(int initialCapacity)	Adds a new Hanging Protocol Definition Sequence (see HangingProtocolDefinitionSequence) if it does not already exist.
default HangingProtocolDefinitionSequence	getHangingProtocolDefinitionSequence()
default HangingProtocolDefinitionSequence	newHangingProtocolDefinitionSequence(int initialCapacity)	Adds a new Hanging Protocol Definition Sequence.
default void	removeHangingProtocolDefinitionSequence()	Removes the Hanging Protocol Definition Sequence (see HangingProtocolDefinitionSequence
static HangingProtocolDefinitionSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Hanging Protocol Definition Sequence (see HangingProtocolDefinitionSequence)

Returns:

a wrapper object implementing the HangingProtocolDefinitionSequence.Holder interface.

builder

static HangingProtocolDefinitionSequence.Holder.Builder builder()

Returns:

a HangingProtocolDefinitionSequence.Holder.Builder to create Hanging Protocol Definition Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getHangingProtocolDefinitionSequence

default HangingProtocolDefinitionSequence getHangingProtocolDefinitionSequence()

Returns:

the Hanging Protocol Definition Sequence (see HangingProtocolDefinitionSequence)

newHangingProtocolDefinitionSequence

default HangingProtocolDefinitionSequence newHangingProtocolDefinitionSequence(int initialCapacity)

Adds a new Hanging Protocol Definition Sequence. (see HangingProtocolDefinitionSequence)

Parameters:

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

Returns:

the newly created HangingProtocolDefinitionSequence.

ensureHangingProtocolDefinitionSequence

default HangingProtocolDefinitionSequence ensureHangingProtocolDefinitionSequence(int initialCapacity)

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

Parameters:

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

Returns:

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

ensureHangingProtocolDefinitionSequence

default HangingProtocolDefinitionSequence ensureHangingProtocolDefinitionSequence()

Adds a new Hanging Protocol Definition Sequence (see HangingProtocolDefinitionSequence) with initial capacity 1 (see ensureHangingProtocolDefinitionSequence(int)) if it does not already exist.

Returns:

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

containsHangingProtocolDefinitionSequence

default boolean containsHangingProtocolDefinitionSequence()

Returns:

whether it contains the Hanging Protocol Definition Sequence (see HangingProtocolDefinitionSequence)

removeHangingProtocolDefinitionSequence

default void removeHangingProtocolDefinitionSequence()

Removes the Hanging Protocol Definition Sequence (see HangingProtocolDefinitionSequence