Package org.dcm4che.typeddicom.dataelements

Interface DICOMStorageSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Implementing Classes:

DICOMStorageSequence.SimpleHolder, OutputDestinationSequence.Item, OutputInformationSequence.Item

Enclosing class:

DICOMStorageSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "DICOM Storage Sequence" (see DICOMStorageSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static DICOMStorageSequence.Holder.Builder	builder()
static DICOMStorageSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsDICOMStorageSequence()
default DICOMStorageSequence	ensureDICOMStorageSequence()	Adds a new DICOM Storage Sequence (see DICOMStorageSequence) with initial capacity 1 (see ensureDICOMStorageSequence(int)) if it does not already exist.
default DICOMStorageSequence	ensureDICOMStorageSequence(int initialCapacity)	Adds a new DICOM Storage Sequence (see DICOMStorageSequence) if it does not already exist.
default DICOMStorageSequence	getDICOMStorageSequence()
default DICOMStorageSequence	newDICOMStorageSequence(int initialCapacity)	Adds a new DICOM Storage Sequence.
default void	removeDICOMStorageSequence()	Removes the DICOM Storage Sequence (see DICOMStorageSequence
static DICOMStorageSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the DICOM Storage Sequence (see DICOMStorageSequence)

Returns:

a wrapper object implementing the DICOMStorageSequence.Holder interface.

builder

static DICOMStorageSequence.Holder.Builder builder()

Returns:

a DICOMStorageSequence.Holder.Builder to create DICOM Storage Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a DICOMStorageSequence.Holder.Builder to create DICOM Storage Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getDICOMStorageSequence

default DICOMStorageSequence getDICOMStorageSequence()

Returns:

the DICOM Storage Sequence (see DICOMStorageSequence)

newDICOMStorageSequence

default DICOMStorageSequence newDICOMStorageSequence(int initialCapacity)

Adds a new DICOM Storage Sequence. (see DICOMStorageSequence)

Parameters:

initialCapacity - the initial capacity for the new DICOM Storage Sequence

Returns:

the newly created DICOMStorageSequence.

ensureDICOMStorageSequence

default DICOMStorageSequence ensureDICOMStorageSequence(int initialCapacity)

Adds a new DICOM Storage Sequence (see DICOMStorageSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing DICOM Storage Sequence (see DICOMStorageSequence) or a new one with capacity initialCapacity.

ensureDICOMStorageSequence

default DICOMStorageSequence ensureDICOMStorageSequence()

Adds a new DICOM Storage Sequence (see DICOMStorageSequence) with initial capacity 1 (see ensureDICOMStorageSequence(int)) if it does not already exist.

Returns:

either the already existing DICOM Storage Sequence (see DICOMStorageSequence) or a new one with capacity 1.

containsDICOMStorageSequence

default boolean containsDICOMStorageSequence()

Returns:

whether it contains the DICOM Storage Sequence (see DICOMStorageSequence)

removeDICOMStorageSequence

default void removeDICOMStorageSequence()

Removes the DICOM Storage Sequence (see DICOMStorageSequence