Package org.dcm4che.typeddicom.dataelements

Interface OverlayMode.Holder

All Superinterfaces:

AttributesWrapper

All Known Implementing Classes:

OverlayMode.SimpleHolder

Enclosing class:

OverlayMode

public static interface OverlayMode.Holder
extends AttributesWrapper

A class implementing this interface can hold attributes which contain the DICOM tag "Overlay Mode" (see OverlayMode)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static OverlayMode.Holder.Builder	builder()
static OverlayMode.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsOverlayMode()
default OverlayMode	getOverlayMode()
default void	removeOverlayMode()	Removes the Overlay Mode (see OverlayMode
static OverlayMode.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Details

wrap

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

Parameters:

attributes - An attributes object containing the Overlay Mode (see OverlayMode)

Returns:

A wrapper object implementing the OverlayMode.Holder interface.

builder

static OverlayMode.Holder.Builder builder()

Returns:

a OverlayMode.Holder.Builder to create Overlay Mode Items with a fluent API.

builder

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

Parameters:

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

Returns:

a OverlayMode.Holder.Builder to create Overlay Mode Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getOverlayMode

default OverlayMode getOverlayMode()

Returns:

the Overlay Mode (see OverlayMode)

containsOverlayMode

default boolean containsOverlayMode()

Returns:

Whether it contains the Overlay Mode (see OverlayMode)

removeOverlayMode

default void removeOverlayMode()

Removes the Overlay Mode (see OverlayMode