Package org.dcm4che.typeddicom.dataelements

Interface OverlayLocation.Holder

All Superinterfaces:

AttributesWrapper

All Known Implementing Classes:

OverlayLocation.SimpleHolder

Enclosing class:

OverlayLocation

public static interface OverlayLocation.Holder
extends AttributesWrapper

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static OverlayLocation.Holder.Builder	builder()
static OverlayLocation.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsOverlayLocation()
default OverlayLocation	getOverlayLocation()
default void	removeOverlayLocation()	Removes the Overlay Location (see OverlayLocation
static OverlayLocation.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Details

wrap

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

Parameters:

attributes - An attributes object containing the Overlay Location (see OverlayLocation)

Returns:

A wrapper object implementing the OverlayLocation.Holder interface.

builder

static OverlayLocation.Holder.Builder builder()

Returns:

a OverlayLocation.Holder.Builder to create Overlay Location Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getOverlayLocation

default OverlayLocation getOverlayLocation()

Returns:

the Overlay Location (see OverlayLocation)

containsOverlayLocation

default boolean containsOverlayLocation()

Returns:

Whether it contains the Overlay Location (see OverlayLocation)

removeOverlayLocation

default void removeOverlayLocation()

Removes the Overlay Location (see OverlayLocation