Package org.dcm4che.typeddicom.dataelements

Interface UVMappingSequence.Holder

All Superinterfaces:

AttributesWrapper

All Known Subinterfaces:

UVMappingModule

All Known Implementing Classes:

SurfaceScanMeshIOD, SurfaceScanPointCloudIOD, UVMappingSequence.SimpleHolder

Enclosing class:

UVMappingSequence

public static interface UVMappingSequence.Holder
extends AttributesWrapper

A class implementing this interface can hold attributes which contain the DICOM tag "UV Mapping Sequence" (see UVMappingSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static UVMappingSequence.Holder.Builder	builder()
static UVMappingSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsUVMappingSequence()
default UVMappingSequence	ensureUVMappingSequence()	Adds a new UV Mapping Sequence (see UVMappingSequence) with initial capacity 1 (see ensureUVMappingSequence(int)) if it does not already exist.
default UVMappingSequence	ensureUVMappingSequence(int initialCapacity)	Adds a new UV Mapping Sequence (see UVMappingSequence) if it does not already exist.
default UVMappingSequence	getUVMappingSequence()
default UVMappingSequence	newUVMappingSequence(int initialCapacity)	Adds a new UV Mapping Sequence.
default void	removeUVMappingSequence()	Removes the UV Mapping Sequence (see UVMappingSequence
static UVMappingSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Details

wrap

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

Parameters:

attributes - An attributes object containing the UV Mapping Sequence (see UVMappingSequence)

Returns:

A wrapper object implementing the UVMappingSequence.Holder interface.

builder

static UVMappingSequence.Holder.Builder builder()

Returns:

a UVMappingSequence.Holder.Builder to create UV Mapping Sequence Items with a fluent API.

builder

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

Parameters:

attributes - The Attributes to be wrapped by the UVMappingSequence.Holder.Builder.

Returns:

a UVMappingSequence.Holder.Builder to create UV Mapping Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getUVMappingSequence

default UVMappingSequence getUVMappingSequence()

Returns:

the UV Mapping Sequence (see UVMappingSequence)

newUVMappingSequence

default UVMappingSequence newUVMappingSequence(int initialCapacity)

Adds a new UV Mapping Sequence. (see UVMappingSequence)

Parameters:

initialCapacity - the initial capacity for the new UV Mapping Sequence

ensureUVMappingSequence

default UVMappingSequence ensureUVMappingSequence(int initialCapacity)

Adds a new UV Mapping Sequence (see UVMappingSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

initialCapacity - The initial capacity (see ArrayList(int)) if a new UV Mapping Sequence is created.

Returns:

Either the already existing UV Mapping Sequence (see UVMappingSequence) or a new one with capacity initialCapacity.

ensureUVMappingSequence

default UVMappingSequence ensureUVMappingSequence()

Adds a new UV Mapping Sequence (see UVMappingSequence) with initial capacity 1 (see ensureUVMappingSequence(int)) if it does not already exist.

Returns:

Either the already existing UV Mapping Sequence (see UVMappingSequence) or a new one with capacity 1.

containsUVMappingSequence

default boolean containsUVMappingSequence()

Returns:

Whether it contains the UV Mapping Sequence (see UVMappingSequence)

removeUVMappingSequence

default void removeUVMappingSequence()

Removes the UV Mapping Sequence (see UVMappingSequence