Illumination.Holder (dcm4che-typeddicom-lib-std 0.5.0-SNAPSHOT API)

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

BasicFilmBoxPresentationModule, SCMultiFrameImageModule

All Known Implementing Classes:

BasicFilmBoxIOD, Illumination.SimpleHolder, MultiFrameGrayscaleByteSCImageIOD, MultiFrameGrayscaleWordSCImageIOD, MultiFrameSingleBitSCImageIOD, MultiFrameTrueColorSCImageIOD

Enclosing class:

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

Nested Class Summary

Nested Classes
Modifier and Type Interface Description

static class Illumination.Holder.Builder

Method Summary

All Methods Static Methods Instance Methods Default Methods
Modifier and Type	Method	Description
`static Illumination.Holder.Builder`	`builder()`
`static Illumination.Holder.Builder`	`builder(org.dcm4che3.data.Attributes attributes)`
`default boolean`	`containsIllumination()`
`default Illumination`	`getIllumination()`
`default void`	`removeIllumination()`	Removes the Illumination (see `Illumination`
`static Illumination.Holder`	`wrap(org.dcm4che3.data.Attributes attributes)`

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

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