Package org.dcm4che.typeddicom.dataelements

Interface HPGLDocumentSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

GenericImplantTemplate2DDrawingsModule

All Known Implementing Classes:

GenericImplantTemplate2DDrawingsModule.SimpleWrapper, GenericImplantTemplateIOD

Enclosing class:

HPGLDocumentSequence

public static interface HPGLDocumentSequence.Holder
extends org.dcm4che.typeddicom.AttributesWrapper

A class implementing this interface can hold attributes which contain the DICOM tag "HPGL Document Sequence" (see HPGLDocumentSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static HPGLDocumentSequence.Holder.Builder	builder()
static HPGLDocumentSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsHPGLDocumentSequence()
default HPGLDocumentSequence	ensureHPGLDocumentSequence()	Adds a new HPGL Document Sequence (see HPGLDocumentSequence) with initial capacity 1 (see ensureHPGLDocumentSequence(int)) if it does not already exist.
default HPGLDocumentSequence	ensureHPGLDocumentSequence(int initialCapacity)	Adds a new HPGL Document Sequence (see HPGLDocumentSequence) if it does not already exist.
default HPGLDocumentSequence	getHPGLDocumentSequence()
default HPGLDocumentSequence	newHPGLDocumentSequence(int initialCapacity)	Adds a new HPGL Document Sequence.
default void	removeHPGLDocumentSequence()	Removes the HPGL Document Sequence (see HPGLDocumentSequence
static HPGLDocumentSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the HPGL Document Sequence (see HPGLDocumentSequence)

Returns:

a wrapper object implementing the HPGLDocumentSequence.Holder interface.

builder

static HPGLDocumentSequence.Holder.Builder builder()

Returns:

a HPGLDocumentSequence.Holder.Builder to create HPGL Document Sequence Items with a fluent API.

builder

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

Parameters:

attributes - the Attributes to be wrapped by the HPGLDocumentSequence.Holder.Builder.

Returns:

a HPGLDocumentSequence.Holder.Builder to create HPGL Document Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getHPGLDocumentSequence

default HPGLDocumentSequence getHPGLDocumentSequence()

Returns:

the HPGL Document Sequence (see HPGLDocumentSequence)

newHPGLDocumentSequence

default HPGLDocumentSequence newHPGLDocumentSequence(int initialCapacity)

Adds a new HPGL Document Sequence. (see HPGLDocumentSequence)

Parameters:

initialCapacity - the initial capacity for the new HPGL Document Sequence

Returns:

the newly created HPGLDocumentSequence.

ensureHPGLDocumentSequence

default HPGLDocumentSequence ensureHPGLDocumentSequence(int initialCapacity)

Adds a new HPGL Document Sequence (see HPGLDocumentSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

initialCapacity - the initial capacity (see ArrayList(int)) if a new HPGL Document Sequence is created.

Returns:

either the already existing HPGL Document Sequence (see HPGLDocumentSequence) or a new one with capacity initialCapacity.

ensureHPGLDocumentSequence

default HPGLDocumentSequence ensureHPGLDocumentSequence()

Adds a new HPGL Document Sequence (see HPGLDocumentSequence) with initial capacity 1 (see ensureHPGLDocumentSequence(int)) if it does not already exist.

Returns:

either the already existing HPGL Document Sequence (see HPGLDocumentSequence) or a new one with capacity 1.

containsHPGLDocumentSequence

default boolean containsHPGLDocumentSequence()

Returns:

whether it contains the HPGL Document Sequence (see HPGLDocumentSequence)

removeHPGLDocumentSequence

default void removeHPGLDocumentSequence()

Removes the HPGL Document Sequence (see HPGLDocumentSequence