Package org.dcm4che.typeddicom.dataelements

Interface ScopeOfInventorySequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

InventoryCreationModule, InventoryModule

All Known Implementing Classes:

InventoryCreationIOD, InventoryIOD, ScopeOfInventorySequence.SimpleHolder

Enclosing class:

ScopeOfInventorySequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Scope of Inventory Sequence" (see ScopeOfInventorySequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ScopeOfInventorySequence.Holder.Builder	builder()
static ScopeOfInventorySequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsScopeOfInventorySequence()
default ScopeOfInventorySequence	ensureScopeOfInventorySequence()	Adds a new Scope of Inventory Sequence (see ScopeOfInventorySequence) with initial capacity 1 (see ensureScopeOfInventorySequence(int)) if it does not already exist.
default ScopeOfInventorySequence	ensureScopeOfInventorySequence(int initialCapacity)	Adds a new Scope of Inventory Sequence (see ScopeOfInventorySequence) if it does not already exist.
default ScopeOfInventorySequence	getScopeOfInventorySequence()
default ScopeOfInventorySequence	newScopeOfInventorySequence(int initialCapacity)	Adds a new Scope of Inventory Sequence.
default void	removeScopeOfInventorySequence()	Removes the Scope of Inventory Sequence (see ScopeOfInventorySequence
static ScopeOfInventorySequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Scope of Inventory Sequence (see ScopeOfInventorySequence)

Returns:

a wrapper object implementing the ScopeOfInventorySequence.Holder interface.

builder

static ScopeOfInventorySequence.Holder.Builder builder()

Returns:

a ScopeOfInventorySequence.Holder.Builder to create Scope of Inventory Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a ScopeOfInventorySequence.Holder.Builder to create Scope of Inventory Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getScopeOfInventorySequence

default ScopeOfInventorySequence getScopeOfInventorySequence()

Returns:

the Scope of Inventory Sequence (see ScopeOfInventorySequence)

newScopeOfInventorySequence

default ScopeOfInventorySequence newScopeOfInventorySequence(int initialCapacity)

Adds a new Scope of Inventory Sequence. (see ScopeOfInventorySequence)

Parameters:

initialCapacity - the initial capacity for the new Scope of Inventory Sequence

Returns:

the newly created ScopeOfInventorySequence.

ensureScopeOfInventorySequence

default ScopeOfInventorySequence ensureScopeOfInventorySequence(int initialCapacity)

Adds a new Scope of Inventory Sequence (see ScopeOfInventorySequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

initialCapacity - the initial capacity (see ArrayList(int)) if a new Scope of Inventory Sequence is created.

Returns:

either the already existing Scope of Inventory Sequence (see ScopeOfInventorySequence) or a new one with capacity initialCapacity.

ensureScopeOfInventorySequence

default ScopeOfInventorySequence ensureScopeOfInventorySequence()

Adds a new Scope of Inventory Sequence (see ScopeOfInventorySequence) with initial capacity 1 (see ensureScopeOfInventorySequence(int)) if it does not already exist.

Returns:

either the already existing Scope of Inventory Sequence (see ScopeOfInventorySequence) or a new one with capacity 1.

containsScopeOfInventorySequence

default boolean containsScopeOfInventorySequence()

Returns:

whether it contains the Scope of Inventory Sequence (see ScopeOfInventorySequence)

removeScopeOfInventorySequence

default void removeScopeOfInventorySequence()

Removes the Scope of Inventory Sequence (see ScopeOfInventorySequence