Package org.dcm4che.typeddicom.dataelements

Interface OverlayFormat.Holder

All Superinterfaces:

AttributesWrapper

All Known Implementing Classes:

OverlayFormat.SimpleHolder

Enclosing class:

OverlayFormat

public static interface OverlayFormat.Holder
extends AttributesWrapper

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static OverlayFormat.Holder.Builder	builder()
static OverlayFormat.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsOverlayFormat()
default OverlayFormat	getOverlayFormat()
default void	removeOverlayFormat()	Removes the Overlay Format (see OverlayFormat
static OverlayFormat.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Details

wrap

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

Parameters:

attributes - An attributes object containing the Overlay Format (see OverlayFormat)

Returns:

A wrapper object implementing the OverlayFormat.Holder interface.

builder

static OverlayFormat.Holder.Builder builder()

Returns:

a OverlayFormat.Holder.Builder to create Overlay Format Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getOverlayFormat

default OverlayFormat getOverlayFormat()

Returns:

the Overlay Format (see OverlayFormat)

containsOverlayFormat

default boolean containsOverlayFormat()

Returns:

Whether it contains the Overlay Format (see OverlayFormat)

removeOverlayFormat

default void removeOverlayFormat()

Removes the Overlay Format (see OverlayFormat