OverlayLabel.Holder (dcm4che-typeddicom-lib-std 0.5.5 API)

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

OverlayPlaneModule

All Known Implementing Classes:

ColorSoftcopyPresentationStateIOD, ComputedRadiographyImageIOD, CTImageIOD, DigitalIntraOralXRayImageIOD, DigitalMammographyXRayImageIOD, DigitalXRayImageIOD, GrayscaleSoftcopyPresentationStateIOD, MRImageIOD, NuclearMedicineImageIOD, OverlayPlaneModule.SimpleWrapper, PositronEmissionTomographyImageIOD, PseudoColorSoftcopyPresentationStateIOD, SecondaryCaptureImageIOD, UltrasoundImageIOD, UltrasoundMultiFrameImageIOD, VLEndoscopicImageIOD, VLMicroscopicImageIOD, VLPhotographicImageIOD, VLSlideCoordinatesMicroscopicImageIOD, XAXRFGrayscaleSoftcopyPresentationStateIOD, XRayAngiographicImageIOD, XRayRadiofluoroscopicImageIOD

Enclosing class:

OverlayLabel
```
public static interface OverlayLabel.Holder
extends org.dcm4che.typeddicom.AttributesWrapper
```
A class implementing this interface can hold attributes which contain the DICOM tag "Overlay Label" (see OverlayLabel)

Nested Class Summary

Nested Classes
Modifier and Type Interface Description

static class OverlayLabel.Holder.Builder

Method Summary

All Methods Static Methods Instance Methods Default Methods
Modifier and Type	Method	Description
`static OverlayLabel.Holder.Builder`	`builder()`
`static OverlayLabel.Holder.Builder`	`builder(org.dcm4che3.data.Attributes attributes)`
`default boolean`	`containsOverlayLabel()`
`default OverlayLabel`	`getOverlayLabel()`
`default void`	`removeOverlayLabel()`	Removes the Overlay Label (see `OverlayLabel`
`static OverlayLabel.Holder`	`wrap(org.dcm4che3.data.Attributes attributes)`

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper
copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

- Method Detail
  - wrap
```
static OverlayLabel.Holder wrap(org.dcm4che3.data.Attributes attributes)
```
    Parameters:
    
    attributes - an attributes object containing the Overlay Label (see OverlayLabel)
    
    Returns:
    
    a wrapper object implementing the OverlayLabel.Holder interface.
  - builder
```
static OverlayLabel.Holder.Builder builder()
```
    Returns:
    
    a OverlayLabel.Holder.Builder to create Overlay Label Items with a fluent API.
  - builder
```
static OverlayLabel.Holder.Builder builder(org.dcm4che3.data.Attributes attributes)
```
    Parameters:
    
    attributes - the Attributes to be wrapped by the OverlayLabel.Holder.Builder.
    
    Returns:
    
    a OverlayLabel.Holder.Builder to create Overlay Label Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.
  - getOverlayLabel
```
default OverlayLabel getOverlayLabel()
```
    Returns:
    
    the Overlay Label (see OverlayLabel)
  - containsOverlayLabel
```
default boolean containsOverlayLabel()
```
    Returns:
    
    whether it contains the Overlay Label (see OverlayLabel)
  - removeOverlayLabel
```
default void removeOverlayLabel()
```
    Removes the Overlay Label (see OverlayLabel