Package org.dcm4che.typeddicom.dataelements

Interface ImageBoxesSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Implementing Classes:

DisplaySetsSequence.Item

Enclosing class:

ImageBoxesSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Image Boxes Sequence" (see ImageBoxesSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ImageBoxesSequence.Holder.Builder	builder()
static ImageBoxesSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsImageBoxesSequence()
default ImageBoxesSequence	ensureImageBoxesSequence()	Adds a new Image Boxes Sequence (see ImageBoxesSequence) with initial capacity 1 (see ensureImageBoxesSequence(int)) if it does not already exist.
default ImageBoxesSequence	ensureImageBoxesSequence(int initialCapacity)	Adds a new Image Boxes Sequence (see ImageBoxesSequence) if it does not already exist.
default ImageBoxesSequence	getImageBoxesSequence()
default ImageBoxesSequence	newImageBoxesSequence(int initialCapacity)	Adds a new Image Boxes Sequence.
default void	removeImageBoxesSequence()	Removes the Image Boxes Sequence (see ImageBoxesSequence
static ImageBoxesSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Image Boxes Sequence (see ImageBoxesSequence)

Returns:

a wrapper object implementing the ImageBoxesSequence.Holder interface.

builder

static ImageBoxesSequence.Holder.Builder builder()

Returns:

a ImageBoxesSequence.Holder.Builder to create Image Boxes Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getImageBoxesSequence

default ImageBoxesSequence getImageBoxesSequence()

Returns:

the Image Boxes Sequence (see ImageBoxesSequence)

newImageBoxesSequence

default ImageBoxesSequence newImageBoxesSequence(int initialCapacity)

Adds a new Image Boxes Sequence. (see ImageBoxesSequence)

Parameters:

initialCapacity - the initial capacity for the new Image Boxes Sequence

Returns:

the newly created ImageBoxesSequence.

ensureImageBoxesSequence

default ImageBoxesSequence ensureImageBoxesSequence(int initialCapacity)

Adds a new Image Boxes Sequence (see ImageBoxesSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Image Boxes Sequence (see ImageBoxesSequence) or a new one with capacity initialCapacity.

ensureImageBoxesSequence

default ImageBoxesSequence ensureImageBoxesSequence()

Adds a new Image Boxes Sequence (see ImageBoxesSequence) with initial capacity 1 (see ensureImageBoxesSequence(int)) if it does not already exist.

Returns:

either the already existing Image Boxes Sequence (see ImageBoxesSequence) or a new one with capacity 1.

containsImageBoxesSequence

default boolean containsImageBoxesSequence()

Returns:

whether it contains the Image Boxes Sequence (see ImageBoxesSequence)

removeImageBoxesSequence

default void removeImageBoxesSequence()

Removes the Image Boxes Sequence (see ImageBoxesSequence