Package org.dcm4che.typeddicom.dataelements

Interface ImageBoxSynchronizationSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

StructuredDisplayImageBoxModule

All Known Implementing Classes:

BasicStructuredDisplayIOD, StructuredDisplayImageBoxModule.SimpleWrapper

Enclosing class:

ImageBoxSynchronizationSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Image Box Synchronization Sequence" (see ImageBoxSynchronizationSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ImageBoxSynchronizationSequence.Holder.Builder	builder()
static ImageBoxSynchronizationSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsImageBoxSynchronizationSequence()
default ImageBoxSynchronizationSequence	ensureImageBoxSynchronizationSequence()	Adds a new Image Box Synchronization Sequence (see ImageBoxSynchronizationSequence) with initial capacity 1 (see ensureImageBoxSynchronizationSequence(int)) if it does not already exist.
default ImageBoxSynchronizationSequence	ensureImageBoxSynchronizationSequence(int initialCapacity)	Adds a new Image Box Synchronization Sequence (see ImageBoxSynchronizationSequence) if it does not already exist.
default ImageBoxSynchronizationSequence	getImageBoxSynchronizationSequence()
default ImageBoxSynchronizationSequence	newImageBoxSynchronizationSequence(int initialCapacity)	Adds a new Image Box Synchronization Sequence.
default void	removeImageBoxSynchronizationSequence()	Removes the Image Box Synchronization Sequence (see ImageBoxSynchronizationSequence
static ImageBoxSynchronizationSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Image Box Synchronization Sequence (see ImageBoxSynchronizationSequence)

Returns:

a wrapper object implementing the ImageBoxSynchronizationSequence.Holder interface.

builder

static ImageBoxSynchronizationSequence.Holder.Builder builder()

Returns:

a ImageBoxSynchronizationSequence.Holder.Builder to create Image Box Synchronization Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a ImageBoxSynchronizationSequence.Holder.Builder to create Image Box Synchronization Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getImageBoxSynchronizationSequence

default ImageBoxSynchronizationSequence getImageBoxSynchronizationSequence()

Returns:

the Image Box Synchronization Sequence (see ImageBoxSynchronizationSequence)

newImageBoxSynchronizationSequence

default ImageBoxSynchronizationSequence newImageBoxSynchronizationSequence(int initialCapacity)

Adds a new Image Box Synchronization Sequence. (see ImageBoxSynchronizationSequence)

Parameters:

initialCapacity - the initial capacity for the new Image Box Synchronization Sequence

Returns:

the newly created ImageBoxSynchronizationSequence.

ensureImageBoxSynchronizationSequence

default ImageBoxSynchronizationSequence ensureImageBoxSynchronizationSequence(int initialCapacity)

Adds a new Image Box Synchronization Sequence (see ImageBoxSynchronizationSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

initialCapacity - the initial capacity (see ArrayList(int)) if a new Image Box Synchronization Sequence is created.

Returns:

either the already existing Image Box Synchronization Sequence (see ImageBoxSynchronizationSequence) or a new one with capacity initialCapacity.

ensureImageBoxSynchronizationSequence

default ImageBoxSynchronizationSequence ensureImageBoxSynchronizationSequence()

Adds a new Image Box Synchronization Sequence (see ImageBoxSynchronizationSequence) with initial capacity 1 (see ensureImageBoxSynchronizationSequence(int)) if it does not already exist.

Returns:

either the already existing Image Box Synchronization Sequence (see ImageBoxSynchronizationSequence) or a new one with capacity 1.

containsImageBoxSynchronizationSequence

default boolean containsImageBoxSynchronizationSequence()

Returns:

whether it contains the Image Box Synchronization Sequence (see ImageBoxSynchronizationSequence)

removeImageBoxSynchronizationSequence

default void removeImageBoxSynchronizationSequence()

Removes the Image Box Synchronization Sequence (see ImageBoxSynchronizationSequence