Package org.dcm4che.typeddicom.dataelements

Interface ReferencedOverlayPlaneSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

Enclosing class:

ReferencedOverlayPlaneSequence

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

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ReferencedOverlayPlaneSequence.Holder.Builder	builder()
static ReferencedOverlayPlaneSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsReferencedOverlayPlaneSequence()
default ReferencedOverlayPlaneSequence	ensureReferencedOverlayPlaneSequence()	Adds a new Referenced Overlay Plane Sequence (see ReferencedOverlayPlaneSequence) with initial capacity 1 (see ensureReferencedOverlayPlaneSequence(int)) if it does not already exist.
default ReferencedOverlayPlaneSequence	ensureReferencedOverlayPlaneSequence(int initialCapacity)	Adds a new Referenced Overlay Plane Sequence (see ReferencedOverlayPlaneSequence) if it does not already exist.
default ReferencedOverlayPlaneSequence	getReferencedOverlayPlaneSequence()
default ReferencedOverlayPlaneSequence	newReferencedOverlayPlaneSequence(int initialCapacity)	Adds a new Referenced Overlay Plane Sequence.
default void	removeReferencedOverlayPlaneSequence()	Removes the Referenced Overlay Plane Sequence (see ReferencedOverlayPlaneSequence
static ReferencedOverlayPlaneSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

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

Returns:

a wrapper object implementing the ReferencedOverlayPlaneSequence.Holder interface.

builder

static ReferencedOverlayPlaneSequence.Holder.Builder builder()

Returns:

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

builder

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

Parameters:

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

Returns:

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

getReferencedOverlayPlaneSequence

default ReferencedOverlayPlaneSequence getReferencedOverlayPlaneSequence()

Returns:

the Referenced Overlay Plane Sequence (see ReferencedOverlayPlaneSequence)

newReferencedOverlayPlaneSequence

default ReferencedOverlayPlaneSequence newReferencedOverlayPlaneSequence(int initialCapacity)

Adds a new Referenced Overlay Plane Sequence. (see ReferencedOverlayPlaneSequence)

Parameters:

initialCapacity - the initial capacity for the new Referenced Overlay Plane Sequence

Returns:

the newly created ReferencedOverlayPlaneSequence.

ensureReferencedOverlayPlaneSequence

default ReferencedOverlayPlaneSequence ensureReferencedOverlayPlaneSequence(int initialCapacity)

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

Parameters:

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

Returns:

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

ensureReferencedOverlayPlaneSequence

default ReferencedOverlayPlaneSequence ensureReferencedOverlayPlaneSequence()

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

Returns:

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

containsReferencedOverlayPlaneSequence

default boolean containsReferencedOverlayPlaneSequence()

Returns:

whether it contains the Referenced Overlay Plane Sequence (see ReferencedOverlayPlaneSequence)

removeReferencedOverlayPlaneSequence

default void removeReferencedOverlayPlaneSequence()

Removes the Referenced Overlay Plane Sequence (see ReferencedOverlayPlaneSequence