Package org.dcm4che.typeddicom.dataelements

Interface BasicGrayscaleImageSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

ImageBoxPixelPresentationModule

All Known Implementing Classes:

BasicImageBoxIOD, ImageBoxPixelPresentationModule.SimpleWrapper

Enclosing class:

BasicGrayscaleImageSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Basic Grayscale Image Sequence" (see BasicGrayscaleImageSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static BasicGrayscaleImageSequence.Holder.Builder	builder()
static BasicGrayscaleImageSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsBasicGrayscaleImageSequence()
default BasicGrayscaleImageSequence	ensureBasicGrayscaleImageSequence()	Adds a new Basic Grayscale Image Sequence (see BasicGrayscaleImageSequence) with initial capacity 1 (see ensureBasicGrayscaleImageSequence(int)) if it does not already exist.
default BasicGrayscaleImageSequence	ensureBasicGrayscaleImageSequence(int initialCapacity)	Adds a new Basic Grayscale Image Sequence (see BasicGrayscaleImageSequence) if it does not already exist.
default BasicGrayscaleImageSequence	getBasicGrayscaleImageSequence()
default BasicGrayscaleImageSequence	newBasicGrayscaleImageSequence(int initialCapacity)	Adds a new Basic Grayscale Image Sequence.
default void	removeBasicGrayscaleImageSequence()	Removes the Basic Grayscale Image Sequence (see BasicGrayscaleImageSequence
static BasicGrayscaleImageSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Basic Grayscale Image Sequence (see BasicGrayscaleImageSequence)

Returns:

a wrapper object implementing the BasicGrayscaleImageSequence.Holder interface.

builder

static BasicGrayscaleImageSequence.Holder.Builder builder()

Returns:

a BasicGrayscaleImageSequence.Holder.Builder to create Basic Grayscale Image Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getBasicGrayscaleImageSequence

default BasicGrayscaleImageSequence getBasicGrayscaleImageSequence()

Returns:

the Basic Grayscale Image Sequence (see BasicGrayscaleImageSequence)

newBasicGrayscaleImageSequence

default BasicGrayscaleImageSequence newBasicGrayscaleImageSequence(int initialCapacity)

Adds a new Basic Grayscale Image Sequence. (see BasicGrayscaleImageSequence)

Parameters:

initialCapacity - the initial capacity for the new Basic Grayscale Image Sequence

Returns:

the newly created BasicGrayscaleImageSequence.

ensureBasicGrayscaleImageSequence

default BasicGrayscaleImageSequence ensureBasicGrayscaleImageSequence(int initialCapacity)

Adds a new Basic Grayscale Image Sequence (see BasicGrayscaleImageSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Basic Grayscale Image Sequence (see BasicGrayscaleImageSequence) or a new one with capacity initialCapacity.

ensureBasicGrayscaleImageSequence

default BasicGrayscaleImageSequence ensureBasicGrayscaleImageSequence()

Adds a new Basic Grayscale Image Sequence (see BasicGrayscaleImageSequence) with initial capacity 1 (see ensureBasicGrayscaleImageSequence(int)) if it does not already exist.

Returns:

either the already existing Basic Grayscale Image Sequence (see BasicGrayscaleImageSequence) or a new one with capacity 1.

containsBasicGrayscaleImageSequence

default boolean containsBasicGrayscaleImageSequence()

Returns:

whether it contains the Basic Grayscale Image Sequence (see BasicGrayscaleImageSequence)

removeBasicGrayscaleImageSequence

default void removeBasicGrayscaleImageSequence()

Removes the Basic Grayscale Image Sequence (see BasicGrayscaleImageSequence