Package org.dcm4che.typeddicom.dataelements

Interface AnnotationContentSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Implementing Classes:

AnnotationContentSequence.SimpleHolder

Enclosing class:

AnnotationContentSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Annotation Content Sequence" (see AnnotationContentSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static AnnotationContentSequence.Holder.Builder	builder()
static AnnotationContentSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsAnnotationContentSequence()
default AnnotationContentSequence	ensureAnnotationContentSequence()	Adds a new Annotation Content Sequence (see AnnotationContentSequence) with initial capacity 1 (see ensureAnnotationContentSequence(int)) if it does not already exist.
default AnnotationContentSequence	ensureAnnotationContentSequence(int initialCapacity)	Adds a new Annotation Content Sequence (see AnnotationContentSequence) if it does not already exist.
default AnnotationContentSequence	getAnnotationContentSequence()
default AnnotationContentSequence	newAnnotationContentSequence(int initialCapacity)	Adds a new Annotation Content Sequence.
default void	removeAnnotationContentSequence()	Removes the Annotation Content Sequence (see AnnotationContentSequence
static AnnotationContentSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Annotation Content Sequence (see AnnotationContentSequence)

Returns:

a wrapper object implementing the AnnotationContentSequence.Holder interface.

builder

static AnnotationContentSequence.Holder.Builder builder()

Returns:

a AnnotationContentSequence.Holder.Builder to create Annotation Content Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a AnnotationContentSequence.Holder.Builder to create Annotation Content Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getAnnotationContentSequence

default AnnotationContentSequence getAnnotationContentSequence()

Returns:

the Annotation Content Sequence (see AnnotationContentSequence)

newAnnotationContentSequence

default AnnotationContentSequence newAnnotationContentSequence(int initialCapacity)

Adds a new Annotation Content Sequence. (see AnnotationContentSequence)

Parameters:

initialCapacity - the initial capacity for the new Annotation Content Sequence

Returns:

the newly created AnnotationContentSequence.

ensureAnnotationContentSequence

default AnnotationContentSequence ensureAnnotationContentSequence(int initialCapacity)

Adds a new Annotation Content Sequence (see AnnotationContentSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Annotation Content Sequence (see AnnotationContentSequence) or a new one with capacity initialCapacity.

ensureAnnotationContentSequence

default AnnotationContentSequence ensureAnnotationContentSequence()

Adds a new Annotation Content Sequence (see AnnotationContentSequence) with initial capacity 1 (see ensureAnnotationContentSequence(int)) if it does not already exist.

Returns:

either the already existing Annotation Content Sequence (see AnnotationContentSequence) or a new one with capacity 1.

containsAnnotationContentSequence

default boolean containsAnnotationContentSequence()

Returns:

whether it contains the Annotation Content Sequence (see AnnotationContentSequence)

removeAnnotationContentSequence

default void removeAnnotationContentSequence()

Removes the Annotation Content Sequence (see AnnotationContentSequence