Package org.dcm4che.typeddicom.dataelements

Interface InterlockCodeSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Implementing Classes:

InterlockCodeSequence.SimpleHolder, InterlockSequence.Item

Enclosing class:

InterlockCodeSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Interlock Code Sequence" (see InterlockCodeSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static InterlockCodeSequence.Holder.Builder	builder()
static InterlockCodeSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsInterlockCodeSequence()
default InterlockCodeSequence	ensureInterlockCodeSequence()	Adds a new Interlock Code Sequence (see InterlockCodeSequence) with initial capacity 1 (see ensureInterlockCodeSequence(int)) if it does not already exist.
default InterlockCodeSequence	ensureInterlockCodeSequence(int initialCapacity)	Adds a new Interlock Code Sequence (see InterlockCodeSequence) if it does not already exist.
default InterlockCodeSequence	getInterlockCodeSequence()
default InterlockCodeSequence	newInterlockCodeSequence(int initialCapacity)	Adds a new Interlock Code Sequence.
default void	removeInterlockCodeSequence()	Removes the Interlock Code Sequence (see InterlockCodeSequence
static InterlockCodeSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Interlock Code Sequence (see InterlockCodeSequence)

Returns:

a wrapper object implementing the InterlockCodeSequence.Holder interface.

builder

static InterlockCodeSequence.Holder.Builder builder()

Returns:

a InterlockCodeSequence.Holder.Builder to create Interlock Code Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getInterlockCodeSequence

default InterlockCodeSequence getInterlockCodeSequence()

Returns:

the Interlock Code Sequence (see InterlockCodeSequence)

newInterlockCodeSequence

default InterlockCodeSequence newInterlockCodeSequence(int initialCapacity)

Adds a new Interlock Code Sequence. (see InterlockCodeSequence)

Parameters:

initialCapacity - the initial capacity for the new Interlock Code Sequence

Returns:

the newly created InterlockCodeSequence.

ensureInterlockCodeSequence

default InterlockCodeSequence ensureInterlockCodeSequence(int initialCapacity)

Adds a new Interlock Code Sequence (see InterlockCodeSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Interlock Code Sequence (see InterlockCodeSequence) or a new one with capacity initialCapacity.

ensureInterlockCodeSequence

default InterlockCodeSequence ensureInterlockCodeSequence()

Adds a new Interlock Code Sequence (see InterlockCodeSequence) with initial capacity 1 (see ensureInterlockCodeSequence(int)) if it does not already exist.

Returns:

either the already existing Interlock Code Sequence (see InterlockCodeSequence) or a new one with capacity 1.

containsInterlockCodeSequence

default boolean containsInterlockCodeSequence()

Returns:

whether it contains the Interlock Code Sequence (see InterlockCodeSequence)

removeInterlockCodeSequence

default void removeInterlockCodeSequence()

Removes the Interlock Code Sequence (see InterlockCodeSequence