Package org.dcm4che.typeddicom.dataelements

Interface MaskingImage.Holder

All Superinterfaces:

AttributesWrapper

All Known Implementing Classes:

MaskingImage.SimpleHolder

Enclosing class:

MaskingImage

public static interface MaskingImage.Holder
extends AttributesWrapper

A class implementing this interface can hold attributes which contain the DICOM tag "Masking Image" (see MaskingImage)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static MaskingImage.Holder.Builder	builder()
static MaskingImage.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsMaskingImage()
default MaskingImage	getMaskingImage()
default void	removeMaskingImage()	Removes the Masking Image (see MaskingImage
static MaskingImage.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Details

wrap

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

Parameters:

attributes - An attributes object containing the Masking Image (see MaskingImage)

Returns:

A wrapper object implementing the MaskingImage.Holder interface.

builder

static MaskingImage.Holder.Builder builder()

Returns:

a MaskingImage.Holder.Builder to create Masking Image Items with a fluent API.

builder

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

Parameters:

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

Returns:

a MaskingImage.Holder.Builder to create Masking Image Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getMaskingImage

default MaskingImage getMaskingImage()

Returns:

the Masking Image (see MaskingImage)

containsMaskingImage

default boolean containsMaskingImage()

Returns:

Whether it contains the Masking Image (see MaskingImage)

removeMaskingImage

default void removeMaskingImage()

Removes the Masking Image (see MaskingImage