Package org.dcm4che.typeddicom.dataelements

Interface DocumentClassCodeSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

EncapsulatedDocumentModule, SCImageModule

All Known Implementing Classes:

EncapsulatedCDAIOD, EncapsulatedDocumentModule.SimpleWrapper, EncapsulatedMTLIOD, EncapsulatedOBJIOD, EncapsulatedPDFIOD, EncapsulatedSTLIOD, MultiFrameGrayscaleByteSecondaryCaptureImageIOD, MultiFrameGrayscaleWordSecondaryCaptureImageIOD, MultiFrameSingleBitSecondaryCaptureImageIOD, MultiFrameTrueColorSecondaryCaptureImageIOD, SCImageModule.SimpleWrapper, SecondaryCaptureImageIOD

Enclosing class:

DocumentClassCodeSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Document Class Code Sequence" (see DocumentClassCodeSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static DocumentClassCodeSequence.Holder.Builder	builder()
static DocumentClassCodeSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsDocumentClassCodeSequence()
default DocumentClassCodeSequence	ensureDocumentClassCodeSequence()	Adds a new Document Class Code Sequence (see DocumentClassCodeSequence) with initial capacity 1 (see ensureDocumentClassCodeSequence(int)) if it does not already exist.
default DocumentClassCodeSequence	ensureDocumentClassCodeSequence(int initialCapacity)	Adds a new Document Class Code Sequence (see DocumentClassCodeSequence) if it does not already exist.
default DocumentClassCodeSequence	getDocumentClassCodeSequence()
default DocumentClassCodeSequence	newDocumentClassCodeSequence(int initialCapacity)	Adds a new Document Class Code Sequence.
default void	removeDocumentClassCodeSequence()	Removes the Document Class Code Sequence (see DocumentClassCodeSequence
static DocumentClassCodeSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Document Class Code Sequence (see DocumentClassCodeSequence)

Returns:

a wrapper object implementing the DocumentClassCodeSequence.Holder interface.

builder

static DocumentClassCodeSequence.Holder.Builder builder()

Returns:

a DocumentClassCodeSequence.Holder.Builder to create Document Class Code Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getDocumentClassCodeSequence

default DocumentClassCodeSequence getDocumentClassCodeSequence()

Returns:

the Document Class Code Sequence (see DocumentClassCodeSequence)

newDocumentClassCodeSequence

default DocumentClassCodeSequence newDocumentClassCodeSequence(int initialCapacity)

Adds a new Document Class Code Sequence. (see DocumentClassCodeSequence)

Parameters:

initialCapacity - the initial capacity for the new Document Class Code Sequence

Returns:

the newly created DocumentClassCodeSequence.

ensureDocumentClassCodeSequence

default DocumentClassCodeSequence ensureDocumentClassCodeSequence(int initialCapacity)

Adds a new Document Class Code Sequence (see DocumentClassCodeSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Document Class Code Sequence (see DocumentClassCodeSequence) or a new one with capacity initialCapacity.

ensureDocumentClassCodeSequence

default DocumentClassCodeSequence ensureDocumentClassCodeSequence()

Adds a new Document Class Code Sequence (see DocumentClassCodeSequence) with initial capacity 1 (see ensureDocumentClassCodeSequence(int)) if it does not already exist.

Returns:

either the already existing Document Class Code Sequence (see DocumentClassCodeSequence) or a new one with capacity 1.

containsDocumentClassCodeSequence

default boolean containsDocumentClassCodeSequence()

Returns:

whether it contains the Document Class Code Sequence (see DocumentClassCodeSequence)

removeDocumentClassCodeSequence

default void removeDocumentClassCodeSequence()

Removes the Document Class Code Sequence (see DocumentClassCodeSequence