Package org.dcm4che.typeddicom.dataelements

Interface FrameComments.Holder

All Superinterfaces:

AttributesWrapper

Enclosing class:

FrameComments

public static interface FrameComments.Holder
extends AttributesWrapper

A class implementing this interface can hold attributes which contain the DICOM tag "Frame Comments" (see FrameComments)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static FrameComments.Holder.Builder	builder()
static FrameComments.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsFrameComments()
default FrameComments	getFrameComments()
default void	removeFrameComments()	Removes the Frame Comments (see FrameComments
static FrameComments.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Details

wrap

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

Parameters:

attributes - An attributes object containing the Frame Comments (see FrameComments)

Returns:

A wrapper object implementing the FrameComments.Holder interface.

builder

static FrameComments.Holder.Builder builder()

Returns:

a FrameComments.Holder.Builder to create Frame Comments Items with a fluent API.

builder

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

Parameters:

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

Returns:

a FrameComments.Holder.Builder to create Frame Comments Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getFrameComments

default FrameComments getFrameComments()

Returns:

the Frame Comments (see FrameComments)

containsFrameComments

default boolean containsFrameComments()

Returns:

Whether it contains the Frame Comments (see FrameComments)

removeFrameComments

default void removeFrameComments()

Removes the Frame Comments (see FrameComments