Package org.dcm4che.typeddicom.dataelements

Interface ReferencedBasicAnnotationBoxSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

BasicFilmBoxRelationshipModule

All Known Implementing Classes:

BasicFilmBoxIOD, ReferencedBasicAnnotationBoxSequence.SimpleHolder

Enclosing class:

ReferencedBasicAnnotationBoxSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Referenced Basic Annotation Box Sequence" (see ReferencedBasicAnnotationBoxSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ReferencedBasicAnnotationBoxSequence.Holder.Builder	builder()
static ReferencedBasicAnnotationBoxSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsReferencedBasicAnnotationBoxSequence()
default ReferencedBasicAnnotationBoxSequence	ensureReferencedBasicAnnotationBoxSequence()	Adds a new Referenced Basic Annotation Box Sequence (see ReferencedBasicAnnotationBoxSequence) with initial capacity 1 (see ensureReferencedBasicAnnotationBoxSequence(int)) if it does not already exist.
default ReferencedBasicAnnotationBoxSequence	ensureReferencedBasicAnnotationBoxSequence(int initialCapacity)	Adds a new Referenced Basic Annotation Box Sequence (see ReferencedBasicAnnotationBoxSequence) if it does not already exist.
default ReferencedBasicAnnotationBoxSequence	getReferencedBasicAnnotationBoxSequence()
default ReferencedBasicAnnotationBoxSequence	newReferencedBasicAnnotationBoxSequence(int initialCapacity)	Adds a new Referenced Basic Annotation Box Sequence.
default void	removeReferencedBasicAnnotationBoxSequence()	Removes the Referenced Basic Annotation Box Sequence (see ReferencedBasicAnnotationBoxSequence
static ReferencedBasicAnnotationBoxSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Referenced Basic Annotation Box Sequence (see ReferencedBasicAnnotationBoxSequence)

Returns:

a wrapper object implementing the ReferencedBasicAnnotationBoxSequence.Holder interface.

builder

static ReferencedBasicAnnotationBoxSequence.Holder.Builder builder()

Returns:

a ReferencedBasicAnnotationBoxSequence.Holder.Builder to create Referenced Basic Annotation Box Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a ReferencedBasicAnnotationBoxSequence.Holder.Builder to create Referenced Basic Annotation Box Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getReferencedBasicAnnotationBoxSequence

default ReferencedBasicAnnotationBoxSequence getReferencedBasicAnnotationBoxSequence()

Returns:

the Referenced Basic Annotation Box Sequence (see ReferencedBasicAnnotationBoxSequence)

newReferencedBasicAnnotationBoxSequence

default ReferencedBasicAnnotationBoxSequence newReferencedBasicAnnotationBoxSequence(int initialCapacity)

Adds a new Referenced Basic Annotation Box Sequence. (see ReferencedBasicAnnotationBoxSequence)

Parameters:

initialCapacity - the initial capacity for the new Referenced Basic Annotation Box Sequence

Returns:

the newly created ReferencedBasicAnnotationBoxSequence.

ensureReferencedBasicAnnotationBoxSequence

default ReferencedBasicAnnotationBoxSequence ensureReferencedBasicAnnotationBoxSequence(int initialCapacity)

Adds a new Referenced Basic Annotation Box Sequence (see ReferencedBasicAnnotationBoxSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Referenced Basic Annotation Box Sequence (see ReferencedBasicAnnotationBoxSequence) or a new one with capacity initialCapacity.

ensureReferencedBasicAnnotationBoxSequence

default ReferencedBasicAnnotationBoxSequence ensureReferencedBasicAnnotationBoxSequence()

Adds a new Referenced Basic Annotation Box Sequence (see ReferencedBasicAnnotationBoxSequence) with initial capacity 1 (see ensureReferencedBasicAnnotationBoxSequence(int)) if it does not already exist.

Returns:

either the already existing Referenced Basic Annotation Box Sequence (see ReferencedBasicAnnotationBoxSequence) or a new one with capacity 1.

containsReferencedBasicAnnotationBoxSequence

default boolean containsReferencedBasicAnnotationBoxSequence()

Returns:

whether it contains the Referenced Basic Annotation Box Sequence (see ReferencedBasicAnnotationBoxSequence)

removeReferencedBasicAnnotationBoxSequence

default void removeReferencedBasicAnnotationBoxSequence()

Removes the Referenced Basic Annotation Box Sequence (see ReferencedBasicAnnotationBoxSequence