Package org.dcm4che.typeddicom.dataelements

Interface CompensatorShapeSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Implementing Classes:

CompensatorDefinitionSequence.Item

Enclosing class:

CompensatorShapeSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Compensator Shape Sequence" (see CompensatorShapeSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CompensatorShapeSequence.Holder.Builder	builder()
static CompensatorShapeSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsCompensatorShapeSequence()
default CompensatorShapeSequence	ensureCompensatorShapeSequence()	Adds a new Compensator Shape Sequence (see CompensatorShapeSequence) with initial capacity 1 (see ensureCompensatorShapeSequence(int)) if it does not already exist.
default CompensatorShapeSequence	ensureCompensatorShapeSequence(int initialCapacity)	Adds a new Compensator Shape Sequence (see CompensatorShapeSequence) if it does not already exist.
default CompensatorShapeSequence	getCompensatorShapeSequence()
default CompensatorShapeSequence	newCompensatorShapeSequence(int initialCapacity)	Adds a new Compensator Shape Sequence.
default void	removeCompensatorShapeSequence()	Removes the Compensator Shape Sequence (see CompensatorShapeSequence
static CompensatorShapeSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Compensator Shape Sequence (see CompensatorShapeSequence)

Returns:

a wrapper object implementing the CompensatorShapeSequence.Holder interface.

builder

static CompensatorShapeSequence.Holder.Builder builder()

Returns:

a CompensatorShapeSequence.Holder.Builder to create Compensator Shape Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a CompensatorShapeSequence.Holder.Builder to create Compensator Shape Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getCompensatorShapeSequence

default CompensatorShapeSequence getCompensatorShapeSequence()

Returns:

the Compensator Shape Sequence (see CompensatorShapeSequence)

newCompensatorShapeSequence

default CompensatorShapeSequence newCompensatorShapeSequence(int initialCapacity)

Adds a new Compensator Shape Sequence. (see CompensatorShapeSequence)

Parameters:

initialCapacity - the initial capacity for the new Compensator Shape Sequence

Returns:

the newly created CompensatorShapeSequence.

ensureCompensatorShapeSequence

default CompensatorShapeSequence ensureCompensatorShapeSequence(int initialCapacity)

Adds a new Compensator Shape Sequence (see CompensatorShapeSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Compensator Shape Sequence (see CompensatorShapeSequence) or a new one with capacity initialCapacity.

ensureCompensatorShapeSequence

default CompensatorShapeSequence ensureCompensatorShapeSequence()

Adds a new Compensator Shape Sequence (see CompensatorShapeSequence) with initial capacity 1 (see ensureCompensatorShapeSequence(int)) if it does not already exist.

Returns:

either the already existing Compensator Shape Sequence (see CompensatorShapeSequence) or a new one with capacity 1.

containsCompensatorShapeSequence

default boolean containsCompensatorShapeSequence()

Returns:

whether it contains the Compensator Shape Sequence (see CompensatorShapeSequence)

removeCompensatorShapeSequence

default void removeCompensatorShapeSequence()

Removes the Compensator Shape Sequence (see CompensatorShapeSequence