Package org.dcm4che.typeddicom.dataelements

Interface RelevantInformationSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

Enclosing class:

RelevantInformationSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Relevant Information Sequence" (see RelevantInformationSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static RelevantInformationSequence.Holder.Builder	builder()
static RelevantInformationSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsRelevantInformationSequence()
default RelevantInformationSequence	ensureRelevantInformationSequence()	Adds a new Relevant Information Sequence (see RelevantInformationSequence) with initial capacity 1 (see ensureRelevantInformationSequence(int)) if it does not already exist.
default RelevantInformationSequence	ensureRelevantInformationSequence(int initialCapacity)	Adds a new Relevant Information Sequence (see RelevantInformationSequence) if it does not already exist.
default RelevantInformationSequence	getRelevantInformationSequence()
default RelevantInformationSequence	newRelevantInformationSequence(int initialCapacity)	Adds a new Relevant Information Sequence.
default void	removeRelevantInformationSequence()	Removes the Relevant Information Sequence (see RelevantInformationSequence
static RelevantInformationSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Relevant Information Sequence (see RelevantInformationSequence)

Returns:

a wrapper object implementing the RelevantInformationSequence.Holder interface.

builder

static RelevantInformationSequence.Holder.Builder builder()

Returns:

a RelevantInformationSequence.Holder.Builder to create Relevant Information Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a RelevantInformationSequence.Holder.Builder to create Relevant Information Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getRelevantInformationSequence

default RelevantInformationSequence getRelevantInformationSequence()

Returns:

the Relevant Information Sequence (see RelevantInformationSequence)

newRelevantInformationSequence

default RelevantInformationSequence newRelevantInformationSequence(int initialCapacity)

Adds a new Relevant Information Sequence. (see RelevantInformationSequence)

Parameters:

initialCapacity - the initial capacity for the new Relevant Information Sequence

Returns:

the newly created RelevantInformationSequence.

ensureRelevantInformationSequence

default RelevantInformationSequence ensureRelevantInformationSequence(int initialCapacity)

Adds a new Relevant Information Sequence (see RelevantInformationSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Relevant Information Sequence (see RelevantInformationSequence) or a new one with capacity initialCapacity.

ensureRelevantInformationSequence

default RelevantInformationSequence ensureRelevantInformationSequence()

Adds a new Relevant Information Sequence (see RelevantInformationSequence) with initial capacity 1 (see ensureRelevantInformationSequence(int)) if it does not already exist.

Returns:

either the already existing Relevant Information Sequence (see RelevantInformationSequence) or a new one with capacity 1.

containsRelevantInformationSequence

default boolean containsRelevantInformationSequence()

Returns:

whether it contains the Relevant Information Sequence (see RelevantInformationSequence)

removeRelevantInformationSequence

default void removeRelevantInformationSequence()

Removes the Relevant Information Sequence (see RelevantInformationSequence