Package org.dcm4che.typeddicom.dataelements

Interface ReferencedSurfaceSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Implementing Classes:

ReferencedSurfaceSequence.SimpleHolder, SegmentSequence.Item

Enclosing class:

ReferencedSurfaceSequence

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

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ReferencedSurfaceSequence.Holder.Builder	builder()
static ReferencedSurfaceSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsReferencedSurfaceSequence()
default ReferencedSurfaceSequence	ensureReferencedSurfaceSequence()	Adds a new Referenced Surface Sequence (see ReferencedSurfaceSequence) with initial capacity 1 (see ensureReferencedSurfaceSequence(int)) if it does not already exist.
default ReferencedSurfaceSequence	ensureReferencedSurfaceSequence(int initialCapacity)	Adds a new Referenced Surface Sequence (see ReferencedSurfaceSequence) if it does not already exist.
default ReferencedSurfaceSequence	getReferencedSurfaceSequence()
default ReferencedSurfaceSequence	newReferencedSurfaceSequence(int initialCapacity)	Adds a new Referenced Surface Sequence.
default void	removeReferencedSurfaceSequence()	Removes the Referenced Surface Sequence (see ReferencedSurfaceSequence
static ReferencedSurfaceSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Referenced Surface Sequence (see ReferencedSurfaceSequence)

Returns:

a wrapper object implementing the ReferencedSurfaceSequence.Holder interface.

builder

static ReferencedSurfaceSequence.Holder.Builder builder()

Returns:

a ReferencedSurfaceSequence.Holder.Builder to create Referenced Surface Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getReferencedSurfaceSequence

default ReferencedSurfaceSequence getReferencedSurfaceSequence()

Returns:

the Referenced Surface Sequence (see ReferencedSurfaceSequence)

newReferencedSurfaceSequence

default ReferencedSurfaceSequence newReferencedSurfaceSequence(int initialCapacity)

Adds a new Referenced Surface Sequence. (see ReferencedSurfaceSequence)

Parameters:

initialCapacity - the initial capacity for the new Referenced Surface Sequence

Returns:

the newly created ReferencedSurfaceSequence.

ensureReferencedSurfaceSequence

default ReferencedSurfaceSequence ensureReferencedSurfaceSequence(int initialCapacity)

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

Parameters:

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

Returns:

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

ensureReferencedSurfaceSequence

default ReferencedSurfaceSequence ensureReferencedSurfaceSequence()

Adds a new Referenced Surface Sequence (see ReferencedSurfaceSequence) with initial capacity 1 (see ensureReferencedSurfaceSequence(int)) if it does not already exist.

Returns:

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

containsReferencedSurfaceSequence

default boolean containsReferencedSurfaceSequence()

Returns:

whether it contains the Referenced Surface Sequence (see ReferencedSurfaceSequence)

removeReferencedSurfaceSequence

default void removeReferencedSurfaceSequence()

Removes the Referenced Surface Sequence (see ReferencedSurfaceSequence