Package org.dcm4che.typeddicom.dataelements

Interface MaskSubtractionSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

MaskModule, PresentationStateMaskModule, XAXRFPresentationStateMaskModule

All Known Implementing Classes:

EnhancedXAImageIOD, EnhancedXRFImageIOD, GrayscaleSoftcopyPresentationStateIOD, MaskModule.SimpleWrapper, PresentationStateMaskModule.SimpleWrapper, PseudoColorSoftcopyPresentationStateIOD, XAXRFGrayscaleSoftcopyPresentationStateIOD, XAXRFPresentationStateMaskModule.SimpleWrapper, XRayAngiographicImageIOD, XRayRadiofluoroscopicImageIOD

Enclosing class:

MaskSubtractionSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Mask Subtraction Sequence" (see MaskSubtractionSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static MaskSubtractionSequence.Holder.Builder	builder()
static MaskSubtractionSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsMaskSubtractionSequence()
default MaskSubtractionSequence	ensureMaskSubtractionSequence()	Adds a new Mask Subtraction Sequence (see MaskSubtractionSequence) with initial capacity 1 (see ensureMaskSubtractionSequence(int)) if it does not already exist.
default MaskSubtractionSequence	ensureMaskSubtractionSequence(int initialCapacity)	Adds a new Mask Subtraction Sequence (see MaskSubtractionSequence) if it does not already exist.
default MaskSubtractionSequence	getMaskSubtractionSequence()
default MaskSubtractionSequence	newMaskSubtractionSequence(int initialCapacity)	Adds a new Mask Subtraction Sequence.
default void	removeMaskSubtractionSequence()	Removes the Mask Subtraction Sequence (see MaskSubtractionSequence
static MaskSubtractionSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Mask Subtraction Sequence (see MaskSubtractionSequence)

Returns:

a wrapper object implementing the MaskSubtractionSequence.Holder interface.

builder

static MaskSubtractionSequence.Holder.Builder builder()

Returns:

a MaskSubtractionSequence.Holder.Builder to create Mask Subtraction Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a MaskSubtractionSequence.Holder.Builder to create Mask Subtraction Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getMaskSubtractionSequence

default MaskSubtractionSequence getMaskSubtractionSequence()

Returns:

the Mask Subtraction Sequence (see MaskSubtractionSequence)

newMaskSubtractionSequence

default MaskSubtractionSequence newMaskSubtractionSequence(int initialCapacity)

Adds a new Mask Subtraction Sequence. (see MaskSubtractionSequence)

Parameters:

initialCapacity - the initial capacity for the new Mask Subtraction Sequence

Returns:

the newly created MaskSubtractionSequence.

ensureMaskSubtractionSequence

default MaskSubtractionSequence ensureMaskSubtractionSequence(int initialCapacity)

Adds a new Mask Subtraction Sequence (see MaskSubtractionSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Mask Subtraction Sequence (see MaskSubtractionSequence) or a new one with capacity initialCapacity.

ensureMaskSubtractionSequence

default MaskSubtractionSequence ensureMaskSubtractionSequence()

Adds a new Mask Subtraction Sequence (see MaskSubtractionSequence) with initial capacity 1 (see ensureMaskSubtractionSequence(int)) if it does not already exist.

Returns:

either the already existing Mask Subtraction Sequence (see MaskSubtractionSequence) or a new one with capacity 1.

containsMaskSubtractionSequence

default boolean containsMaskSubtractionSequence()

Returns:

whether it contains the Mask Subtraction Sequence (see MaskSubtractionSequence)

removeMaskSubtractionSequence

default void removeMaskSubtractionSequence()

Removes the Mask Subtraction Sequence (see MaskSubtractionSequence