Package org.dcm4che.typeddicom.dataelements

Interface OverlayType.Holder

All Superinterfaces:

AttributesWrapper

All Known Subinterfaces:

OverlayPlaneModule

All Known Implementing Classes:

ColorSoftcopyPresentationStateIOD, CRImageIOD, CTImageIOD, DigitalIntraOralXRayImageIOD, DigitalMammographyXRayImageIOD, DigitalXRayImageIOD, GrayscaleSoftcopyPresentationStateIOD, MRImageIOD, NMImageIOD, OverlayType.SimpleHolder, PETImageIOD, PseudoColorSoftcopyPresentationStateIOD, RTDoseIOD, SecondaryCaptureImageIOD, USImageIOD, USMultiFrameImageIOD, VLEndoscopicImageIOD, VLMicroscopicImageIOD, VLPhotographicImageIOD, VLSlideCoordinatesMicroscopicImageIOD, XAXRFGrayscaleSoftcopyPresentationStateIOD, XRayAngiographicImageIOD, XRayRadiofluoroscopicImageIOD

Enclosing class:

OverlayType

public static interface OverlayType.Holder
extends AttributesWrapper

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static OverlayType.Holder.Builder	builder()
static OverlayType.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsOverlayType()
default OverlayType	getOverlayType()
default void	removeOverlayType()	Removes the Overlay Type (see OverlayType
static OverlayType.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Details

wrap

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

Parameters:

attributes - An attributes object containing the Overlay Type (see OverlayType)

Returns:

A wrapper object implementing the OverlayType.Holder interface.

builder

static OverlayType.Holder.Builder builder()

Returns:

a OverlayType.Holder.Builder to create Overlay Type Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getOverlayType

default OverlayType getOverlayType()

Returns:

the Overlay Type (see OverlayType)

containsOverlayType

default boolean containsOverlayType()

Returns:

Whether it contains the Overlay Type (see OverlayType)

removeOverlayType

default void removeOverlayType()

Removes the Overlay Type (see OverlayType