Package org.dcm4che.typeddicom.dataelements

Interface FailedSOPSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

MediaCreationManagementModule, StorageCommitmentModule

All Known Implementing Classes:

FailedSOPSequence.SimpleHolder, MediaCreationManagementIOD, StorageCommitmentIOD

Enclosing class:

FailedSOPSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Failed SOP Sequence" (see FailedSOPSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static FailedSOPSequence.Holder.Builder	builder()
static FailedSOPSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsFailedSOPSequence()
default FailedSOPSequence	ensureFailedSOPSequence()	Adds a new Failed SOP Sequence (see FailedSOPSequence) with initial capacity 1 (see ensureFailedSOPSequence(int)) if it does not already exist.
default FailedSOPSequence	ensureFailedSOPSequence(int initialCapacity)	Adds a new Failed SOP Sequence (see FailedSOPSequence) if it does not already exist.
default FailedSOPSequence	getFailedSOPSequence()
default FailedSOPSequence	newFailedSOPSequence(int initialCapacity)	Adds a new Failed SOP Sequence.
default void	removeFailedSOPSequence()	Removes the Failed SOP Sequence (see FailedSOPSequence
static FailedSOPSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Failed SOP Sequence (see FailedSOPSequence)

Returns:

a wrapper object implementing the FailedSOPSequence.Holder interface.

builder

static FailedSOPSequence.Holder.Builder builder()

Returns:

a FailedSOPSequence.Holder.Builder to create Failed SOP Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a FailedSOPSequence.Holder.Builder to create Failed SOP Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getFailedSOPSequence

default FailedSOPSequence getFailedSOPSequence()

Returns:

the Failed SOP Sequence (see FailedSOPSequence)

newFailedSOPSequence

default FailedSOPSequence newFailedSOPSequence(int initialCapacity)

Adds a new Failed SOP Sequence. (see FailedSOPSequence)

Parameters:

initialCapacity - the initial capacity for the new Failed SOP Sequence

Returns:

the newly created FailedSOPSequence.

ensureFailedSOPSequence

default FailedSOPSequence ensureFailedSOPSequence(int initialCapacity)

Adds a new Failed SOP Sequence (see FailedSOPSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Failed SOP Sequence (see FailedSOPSequence) or a new one with capacity initialCapacity.

ensureFailedSOPSequence

default FailedSOPSequence ensureFailedSOPSequence()

Adds a new Failed SOP Sequence (see FailedSOPSequence) with initial capacity 1 (see ensureFailedSOPSequence(int)) if it does not already exist.

Returns:

either the already existing Failed SOP Sequence (see FailedSOPSequence) or a new one with capacity 1.

containsFailedSOPSequence

default boolean containsFailedSOPSequence()

Returns:

whether it contains the Failed SOP Sequence (see FailedSOPSequence)

removeFailedSOPSequence

default void removeFailedSOPSequence()

Removes the Failed SOP Sequence (see FailedSOPSequence