Package org.dcm4che.typeddicom.dataelements

Interface OverlayComments.Holder

All Superinterfaces:

AttributesWrapper

All Known Implementing Classes:

OverlayComments.SimpleHolder

Enclosing class:

OverlayComments

public static interface OverlayComments.Holder
extends AttributesWrapper

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static OverlayComments.Holder.Builder	builder()
static OverlayComments.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsOverlayComments()
default OverlayComments	getOverlayComments()
default void	removeOverlayComments()	Removes the Overlay Comments (see OverlayComments
static OverlayComments.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Details

wrap

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

Parameters:

attributes - An attributes object containing the Overlay Comments (see OverlayComments)

Returns:

A wrapper object implementing the OverlayComments.Holder interface.

builder

static OverlayComments.Holder.Builder builder()

Returns:

a OverlayComments.Holder.Builder to create Overlay Comments Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getOverlayComments

default OverlayComments getOverlayComments()

Returns:

the Overlay Comments (see OverlayComments)

containsOverlayComments

default boolean containsOverlayComments()

Returns:

Whether it contains the Overlay Comments (see OverlayComments)

removeOverlayComments

default void removeOverlayComments()

Removes the Overlay Comments (see OverlayComments