Package org.dcm4che.typeddicom.dataelements

Interface DoseComment.Holder

All Superinterfaces:

AttributesWrapper

All Known Subinterfaces:

RTDoseModule

All Known Implementing Classes:

DoseComment.SimpleHolder, RTDoseIOD

Enclosing class:

DoseComment

public static interface DoseComment.Holder
extends AttributesWrapper

A class implementing this interface can hold attributes which contain the DICOM tag "Dose Comment" (see DoseComment)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static DoseComment.Holder.Builder	builder()
static DoseComment.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsDoseComment()
default DoseComment	getDoseComment()
default void	removeDoseComment()	Removes the Dose Comment (see DoseComment
static DoseComment.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Details

wrap

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

Parameters:

attributes - An attributes object containing the Dose Comment (see DoseComment)

Returns:

A wrapper object implementing the DoseComment.Holder interface.

builder

static DoseComment.Holder.Builder builder()

Returns:

a DoseComment.Holder.Builder to create Dose Comment Items with a fluent API.

builder

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

Parameters:

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

Returns:

a DoseComment.Holder.Builder to create Dose Comment Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getDoseComment

default DoseComment getDoseComment()

Returns:

the Dose Comment (see DoseComment)

containsDoseComment

default boolean containsDoseComment()

Returns:

Whether it contains the Dose Comment (see DoseComment)

removeDoseComment

default void removeDoseComment()

Removes the Dose Comment (see DoseComment