Package org.dcm4che.typeddicom.dataelements

Interface ReferencedOverlaySequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

Enclosing class:

ReferencedOverlaySequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Referenced Overlay Sequence" (see ReferencedOverlaySequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ReferencedOverlaySequence.Holder.Builder	builder()
static ReferencedOverlaySequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsReferencedOverlaySequence()
default ReferencedOverlaySequence	ensureReferencedOverlaySequence()	Adds a new Referenced Overlay Sequence (see ReferencedOverlaySequence) with initial capacity 1 (see ensureReferencedOverlaySequence(int)) if it does not already exist.
default ReferencedOverlaySequence	ensureReferencedOverlaySequence(int initialCapacity)	Adds a new Referenced Overlay Sequence (see ReferencedOverlaySequence) if it does not already exist.
default ReferencedOverlaySequence	getReferencedOverlaySequence()
default ReferencedOverlaySequence	newReferencedOverlaySequence(int initialCapacity)	Adds a new Referenced Overlay Sequence.
default void	removeReferencedOverlaySequence()	Removes the Referenced Overlay Sequence (see ReferencedOverlaySequence
static ReferencedOverlaySequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Referenced Overlay Sequence (see ReferencedOverlaySequence)

Returns:

a wrapper object implementing the ReferencedOverlaySequence.Holder interface.

builder

static ReferencedOverlaySequence.Holder.Builder builder()

Returns:

a ReferencedOverlaySequence.Holder.Builder to create Referenced Overlay Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getReferencedOverlaySequence

default ReferencedOverlaySequence getReferencedOverlaySequence()

Returns:

the Referenced Overlay Sequence (see ReferencedOverlaySequence)

newReferencedOverlaySequence

default ReferencedOverlaySequence newReferencedOverlaySequence(int initialCapacity)

Adds a new Referenced Overlay Sequence. (see ReferencedOverlaySequence)

Parameters:

initialCapacity - the initial capacity for the new Referenced Overlay Sequence

Returns:

the newly created ReferencedOverlaySequence.

ensureReferencedOverlaySequence

default ReferencedOverlaySequence ensureReferencedOverlaySequence(int initialCapacity)

Adds a new Referenced Overlay Sequence (see ReferencedOverlaySequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Referenced Overlay Sequence (see ReferencedOverlaySequence) or a new one with capacity initialCapacity.

ensureReferencedOverlaySequence

default ReferencedOverlaySequence ensureReferencedOverlaySequence()

Adds a new Referenced Overlay Sequence (see ReferencedOverlaySequence) with initial capacity 1 (see ensureReferencedOverlaySequence(int)) if it does not already exist.

Returns:

either the already existing Referenced Overlay Sequence (see ReferencedOverlaySequence) or a new one with capacity 1.

containsReferencedOverlaySequence

default boolean containsReferencedOverlaySequence()

Returns:

whether it contains the Referenced Overlay Sequence (see ReferencedOverlaySequence)

removeReferencedOverlaySequence

default void removeReferencedOverlaySequence()

Removes the Referenced Overlay Sequence (see ReferencedOverlaySequence