Package org.dcm4che.typeddicom.dataelements

Interface USImageDescriptionSequence.Holder

All Superinterfaces:

AttributesWrapper

All Known Implementing Classes:

USImageDescriptionSequence.SimpleHolder

Enclosing class:

USImageDescriptionSequence

public static interface USImageDescriptionSequence.Holder
extends AttributesWrapper

A class implementing this interface can hold attributes which contain the DICOM tag "US Image Description Sequence" (see USImageDescriptionSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static USImageDescriptionSequence.Holder.Builder	builder()
static USImageDescriptionSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsUSImageDescriptionSequence()
default USImageDescriptionSequence	ensureUSImageDescriptionSequence()	Adds a new US Image Description Sequence (see USImageDescriptionSequence) with initial capacity 1 (see ensureUSImageDescriptionSequence(int)) if it does not already exist.
default USImageDescriptionSequence	ensureUSImageDescriptionSequence(int initialCapacity)	Adds a new US Image Description Sequence (see USImageDescriptionSequence) if it does not already exist.
default USImageDescriptionSequence	getUSImageDescriptionSequence()
default USImageDescriptionSequence	newUSImageDescriptionSequence(int initialCapacity)	Adds a new US Image Description Sequence.
default void	removeUSImageDescriptionSequence()	Removes the US Image Description Sequence (see USImageDescriptionSequence
static USImageDescriptionSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Details

wrap

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

Parameters:

attributes - An attributes object containing the US Image Description Sequence (see USImageDescriptionSequence)

Returns:

A wrapper object implementing the USImageDescriptionSequence.Holder interface.

builder

static USImageDescriptionSequence.Holder.Builder builder()

Returns:

a USImageDescriptionSequence.Holder.Builder to create US Image Description Sequence Items with a fluent API.

builder

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

Parameters:

attributes - The Attributes to be wrapped by the USImageDescriptionSequence.Holder.Builder.

Returns:

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

getUSImageDescriptionSequence

default USImageDescriptionSequence getUSImageDescriptionSequence()

Returns:

the US Image Description Sequence (see USImageDescriptionSequence)

newUSImageDescriptionSequence

default USImageDescriptionSequence newUSImageDescriptionSequence(int initialCapacity)

Adds a new US Image Description Sequence. (see USImageDescriptionSequence)

Parameters:

initialCapacity - the initial capacity for the new US Image Description Sequence

ensureUSImageDescriptionSequence

default USImageDescriptionSequence ensureUSImageDescriptionSequence(int initialCapacity)

Adds a new US Image Description Sequence (see USImageDescriptionSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

initialCapacity - The initial capacity (see ArrayList(int)) if a new US Image Description Sequence is created.

Returns:

Either the already existing US Image Description Sequence (see USImageDescriptionSequence) or a new one with capacity initialCapacity.

ensureUSImageDescriptionSequence

default USImageDescriptionSequence ensureUSImageDescriptionSequence()

Adds a new US Image Description Sequence (see USImageDescriptionSequence) with initial capacity 1 (see ensureUSImageDescriptionSequence(int)) if it does not already exist.

Returns:

Either the already existing US Image Description Sequence (see USImageDescriptionSequence) or a new one with capacity 1.

containsUSImageDescriptionSequence

default boolean containsUSImageDescriptionSequence()

Returns:

Whether it contains the US Image Description Sequence (see USImageDescriptionSequence)

removeUSImageDescriptionSequence

default void removeUSImageDescriptionSequence()

Removes the US Image Description Sequence (see USImageDescriptionSequence