Package org.dcm4che.typeddicom.dataelements

Interface ScanPatternTypeCodeSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

OphthalmicTomographyParametersModule

All Known Implementing Classes:

OCTBscanAnalysisAcquisitionParametersSequence.Item, OphthalmicTomographyImageIOD, OphthalmicTomographyParametersModule.SimpleWrapper

Enclosing class:

ScanPatternTypeCodeSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Scan Pattern Type Code Sequence" (see ScanPatternTypeCodeSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ScanPatternTypeCodeSequence.Holder.Builder	builder()
static ScanPatternTypeCodeSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsScanPatternTypeCodeSequence()
default ScanPatternTypeCodeSequence	ensureScanPatternTypeCodeSequence()	Adds a new Scan Pattern Type Code Sequence (see ScanPatternTypeCodeSequence) with initial capacity 1 (see ensureScanPatternTypeCodeSequence(int)) if it does not already exist.
default ScanPatternTypeCodeSequence	ensureScanPatternTypeCodeSequence(int initialCapacity)	Adds a new Scan Pattern Type Code Sequence (see ScanPatternTypeCodeSequence) if it does not already exist.
default ScanPatternTypeCodeSequence	getScanPatternTypeCodeSequence()
default ScanPatternTypeCodeSequence	newScanPatternTypeCodeSequence(int initialCapacity)	Adds a new Scan Pattern Type Code Sequence.
default void	removeScanPatternTypeCodeSequence()	Removes the Scan Pattern Type Code Sequence (see ScanPatternTypeCodeSequence
static ScanPatternTypeCodeSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Scan Pattern Type Code Sequence (see ScanPatternTypeCodeSequence)

Returns:

a wrapper object implementing the ScanPatternTypeCodeSequence.Holder interface.

builder

static ScanPatternTypeCodeSequence.Holder.Builder builder()

Returns:

a ScanPatternTypeCodeSequence.Holder.Builder to create Scan Pattern Type Code Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a ScanPatternTypeCodeSequence.Holder.Builder to create Scan Pattern Type Code Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getScanPatternTypeCodeSequence

default ScanPatternTypeCodeSequence getScanPatternTypeCodeSequence()

Returns:

the Scan Pattern Type Code Sequence (see ScanPatternTypeCodeSequence)

newScanPatternTypeCodeSequence

default ScanPatternTypeCodeSequence newScanPatternTypeCodeSequence(int initialCapacity)

Adds a new Scan Pattern Type Code Sequence. (see ScanPatternTypeCodeSequence)

Parameters:

initialCapacity - the initial capacity for the new Scan Pattern Type Code Sequence

Returns:

the newly created ScanPatternTypeCodeSequence.

ensureScanPatternTypeCodeSequence

default ScanPatternTypeCodeSequence ensureScanPatternTypeCodeSequence(int initialCapacity)

Adds a new Scan Pattern Type Code Sequence (see ScanPatternTypeCodeSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

initialCapacity - the initial capacity (see ArrayList(int)) if a new Scan Pattern Type Code Sequence is created.

Returns:

either the already existing Scan Pattern Type Code Sequence (see ScanPatternTypeCodeSequence) or a new one with capacity initialCapacity.

ensureScanPatternTypeCodeSequence

default ScanPatternTypeCodeSequence ensureScanPatternTypeCodeSequence()

Adds a new Scan Pattern Type Code Sequence (see ScanPatternTypeCodeSequence) with initial capacity 1 (see ensureScanPatternTypeCodeSequence(int)) if it does not already exist.

Returns:

either the already existing Scan Pattern Type Code Sequence (see ScanPatternTypeCodeSequence) or a new one with capacity 1.

containsScanPatternTypeCodeSequence

default boolean containsScanPatternTypeCodeSequence()

Returns:

whether it contains the Scan Pattern Type Code Sequence (see ScanPatternTypeCodeSequence)

removeScanPatternTypeCodeSequence

default void removeScanPatternTypeCodeSequence()

Removes the Scan Pattern Type Code Sequence (see ScanPatternTypeCodeSequence