Package org.dcm4che.typeddicom.dataelements

Interface TextString.Holder

All Superinterfaces:

AttributesWrapper

All Known Subinterfaces:

BasicAnnotationPresentationModule

All Known Implementing Classes:

BasicAnnotationBoxIOD

Enclosing class:

TextString

public static interface TextString.Holder
extends AttributesWrapper

A class implementing this interface can hold attributes which contain the DICOM tag "Text String" (see TextString)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static TextString.Holder.Builder	builder()
static TextString.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsTextString()
default TextString	getTextString()
default void	removeTextString()	Removes the Text String (see TextString
static TextString.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Details

wrap

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

Parameters:

attributes - An attributes object containing the Text String (see TextString)

Returns:

A wrapper object implementing the TextString.Holder interface.

builder

static TextString.Holder.Builder builder()

Returns:

a TextString.Holder.Builder to create Text String Items with a fluent API.

builder

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

Parameters:

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

Returns:

a TextString.Holder.Builder to create Text String Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getTextString

default TextString getTextString()

Returns:

the Text String (see TextString)

containsTextString

default boolean containsTextString()

Returns:

Whether it contains the Text String (see TextString)

removeTextString

default void removeTextString()

Removes the Text String (see TextString