Package org.dcm4che.typeddicom.dataelements

Interface ReferencedFilmBoxSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

BasicFilmSessionRelationshipModule

All Known Implementing Classes:

BasicFilmSessionIOD, BasicFilmSessionRelationshipModule.SimpleWrapper

Enclosing class:

ReferencedFilmBoxSequence

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

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ReferencedFilmBoxSequence.Holder.Builder	builder()
static ReferencedFilmBoxSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsReferencedFilmBoxSequence()
default ReferencedFilmBoxSequence	ensureReferencedFilmBoxSequence()	Adds a new Referenced Film Box Sequence (see ReferencedFilmBoxSequence) with initial capacity 1 (see ensureReferencedFilmBoxSequence(int)) if it does not already exist.
default ReferencedFilmBoxSequence	ensureReferencedFilmBoxSequence(int initialCapacity)	Adds a new Referenced Film Box Sequence (see ReferencedFilmBoxSequence) if it does not already exist.
default ReferencedFilmBoxSequence	getReferencedFilmBoxSequence()
default ReferencedFilmBoxSequence	newReferencedFilmBoxSequence(int initialCapacity)	Adds a new Referenced Film Box Sequence.
default void	removeReferencedFilmBoxSequence()	Removes the Referenced Film Box Sequence (see ReferencedFilmBoxSequence
static ReferencedFilmBoxSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Referenced Film Box Sequence (see ReferencedFilmBoxSequence)

Returns:

a wrapper object implementing the ReferencedFilmBoxSequence.Holder interface.

builder

static ReferencedFilmBoxSequence.Holder.Builder builder()

Returns:

a ReferencedFilmBoxSequence.Holder.Builder to create Referenced Film Box Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getReferencedFilmBoxSequence

default ReferencedFilmBoxSequence getReferencedFilmBoxSequence()

Returns:

the Referenced Film Box Sequence (see ReferencedFilmBoxSequence)

newReferencedFilmBoxSequence

default ReferencedFilmBoxSequence newReferencedFilmBoxSequence(int initialCapacity)

Adds a new Referenced Film Box Sequence. (see ReferencedFilmBoxSequence)

Parameters:

initialCapacity - the initial capacity for the new Referenced Film Box Sequence

Returns:

the newly created ReferencedFilmBoxSequence.

ensureReferencedFilmBoxSequence

default ReferencedFilmBoxSequence ensureReferencedFilmBoxSequence(int initialCapacity)

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

Parameters:

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

Returns:

either the already existing Referenced Film Box Sequence (see ReferencedFilmBoxSequence) or a new one with capacity initialCapacity.

ensureReferencedFilmBoxSequence

default ReferencedFilmBoxSequence ensureReferencedFilmBoxSequence()

Adds a new Referenced Film Box Sequence (see ReferencedFilmBoxSequence) with initial capacity 1 (see ensureReferencedFilmBoxSequence(int)) if it does not already exist.

Returns:

either the already existing Referenced Film Box Sequence (see ReferencedFilmBoxSequence) or a new one with capacity 1.

containsReferencedFilmBoxSequence

default boolean containsReferencedFilmBoxSequence()

Returns:

whether it contains the Referenced Film Box Sequence (see ReferencedFilmBoxSequence)

removeReferencedFilmBoxSequence

default void removeReferencedFilmBoxSequence()

Removes the Referenced Film Box Sequence (see ReferencedFilmBoxSequence