Package org.dcm4che.typeddicom.dataelements

Interface UpdatedMetadataSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

Enclosing class:

UpdatedMetadataSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Updated Metadata Sequence" (see UpdatedMetadataSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static UpdatedMetadataSequence.Holder.Builder	builder()
static UpdatedMetadataSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsUpdatedMetadataSequence()
default UpdatedMetadataSequence	ensureUpdatedMetadataSequence()	Adds a new Updated Metadata Sequence (see UpdatedMetadataSequence) with initial capacity 1 (see ensureUpdatedMetadataSequence(int)) if it does not already exist.
default UpdatedMetadataSequence	ensureUpdatedMetadataSequence(int initialCapacity)	Adds a new Updated Metadata Sequence (see UpdatedMetadataSequence) if it does not already exist.
default UpdatedMetadataSequence	getUpdatedMetadataSequence()
default UpdatedMetadataSequence	newUpdatedMetadataSequence(int initialCapacity)	Adds a new Updated Metadata Sequence.
default void	removeUpdatedMetadataSequence()	Removes the Updated Metadata Sequence (see UpdatedMetadataSequence
static UpdatedMetadataSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Updated Metadata Sequence (see UpdatedMetadataSequence)

Returns:

a wrapper object implementing the UpdatedMetadataSequence.Holder interface.

builder

static UpdatedMetadataSequence.Holder.Builder builder()

Returns:

a UpdatedMetadataSequence.Holder.Builder to create Updated Metadata Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a UpdatedMetadataSequence.Holder.Builder to create Updated Metadata Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getUpdatedMetadataSequence

default UpdatedMetadataSequence getUpdatedMetadataSequence()

Returns:

the Updated Metadata Sequence (see UpdatedMetadataSequence)

newUpdatedMetadataSequence

default UpdatedMetadataSequence newUpdatedMetadataSequence(int initialCapacity)

Adds a new Updated Metadata Sequence. (see UpdatedMetadataSequence)

Parameters:

initialCapacity - the initial capacity for the new Updated Metadata Sequence

Returns:

the newly created UpdatedMetadataSequence.

ensureUpdatedMetadataSequence

default UpdatedMetadataSequence ensureUpdatedMetadataSequence(int initialCapacity)

Adds a new Updated Metadata Sequence (see UpdatedMetadataSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Updated Metadata Sequence (see UpdatedMetadataSequence) or a new one with capacity initialCapacity.

ensureUpdatedMetadataSequence

default UpdatedMetadataSequence ensureUpdatedMetadataSequence()

Adds a new Updated Metadata Sequence (see UpdatedMetadataSequence) with initial capacity 1 (see ensureUpdatedMetadataSequence(int)) if it does not already exist.

Returns:

either the already existing Updated Metadata Sequence (see UpdatedMetadataSequence) or a new one with capacity 1.

containsUpdatedMetadataSequence

default boolean containsUpdatedMetadataSequence()

Returns:

whether it contains the Updated Metadata Sequence (see UpdatedMetadataSequence)

removeUpdatedMetadataSequence

default void removeUpdatedMetadataSequence()

Removes the Updated Metadata Sequence (see UpdatedMetadataSequence