Package org.dcm4che.typeddicom.dataelements

Interface BasicColorImageSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

ImageBoxPixelPresentationModule

All Known Implementing Classes:

BasicImageBoxIOD, ImageBoxPixelPresentationModule.SimpleWrapper

Enclosing class:

BasicColorImageSequence

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

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static BasicColorImageSequence.Holder.Builder	builder()
static BasicColorImageSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsBasicColorImageSequence()
default BasicColorImageSequence	ensureBasicColorImageSequence()	Adds a new Basic Color Image Sequence (see BasicColorImageSequence) with initial capacity 1 (see ensureBasicColorImageSequence(int)) if it does not already exist.
default BasicColorImageSequence	ensureBasicColorImageSequence(int initialCapacity)	Adds a new Basic Color Image Sequence (see BasicColorImageSequence) if it does not already exist.
default BasicColorImageSequence	getBasicColorImageSequence()
default BasicColorImageSequence	newBasicColorImageSequence(int initialCapacity)	Adds a new Basic Color Image Sequence.
default void	removeBasicColorImageSequence()	Removes the Basic Color Image Sequence (see BasicColorImageSequence
static BasicColorImageSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Basic Color Image Sequence (see BasicColorImageSequence)

Returns:

a wrapper object implementing the BasicColorImageSequence.Holder interface.

builder

static BasicColorImageSequence.Holder.Builder builder()

Returns:

a BasicColorImageSequence.Holder.Builder to create Basic Color Image Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getBasicColorImageSequence

default BasicColorImageSequence getBasicColorImageSequence()

Returns:

the Basic Color Image Sequence (see BasicColorImageSequence)

newBasicColorImageSequence

default BasicColorImageSequence newBasicColorImageSequence(int initialCapacity)

Adds a new Basic Color Image Sequence. (see BasicColorImageSequence)

Parameters:

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

Returns:

the newly created BasicColorImageSequence.

ensureBasicColorImageSequence

default BasicColorImageSequence ensureBasicColorImageSequence(int initialCapacity)

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

Parameters:

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

Returns:

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

ensureBasicColorImageSequence

default BasicColorImageSequence ensureBasicColorImageSequence()

Adds a new Basic Color Image Sequence (see BasicColorImageSequence) with initial capacity 1 (see ensureBasicColorImageSequence(int)) if it does not already exist.

Returns:

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

containsBasicColorImageSequence

default boolean containsBasicColorImageSequence()

Returns:

whether it contains the Basic Color Image Sequence (see BasicColorImageSequence)

removeBasicColorImageSequence

default void removeBasicColorImageSequence()

Removes the Basic Color Image Sequence (see BasicColorImageSequence