Package org.dcm4che.typeddicom.dataelements

Interface EventCodeSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Implementing Classes:

EventTimerSequence.Item

Enclosing class:

EventCodeSequence

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

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static EventCodeSequence.Holder.Builder	builder()
static EventCodeSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsEventCodeSequence()
default EventCodeSequence	ensureEventCodeSequence()	Adds a new Event Code Sequence (see EventCodeSequence) with initial capacity 1 (see ensureEventCodeSequence(int)) if it does not already exist.
default EventCodeSequence	ensureEventCodeSequence(int initialCapacity)	Adds a new Event Code Sequence (see EventCodeSequence) if it does not already exist.
default EventCodeSequence	getEventCodeSequence()
default EventCodeSequence	newEventCodeSequence(int initialCapacity)	Adds a new Event Code Sequence.
default void	removeEventCodeSequence()	Removes the Event Code Sequence (see EventCodeSequence
static EventCodeSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Event Code Sequence (see EventCodeSequence)

Returns:

a wrapper object implementing the EventCodeSequence.Holder interface.

builder

static EventCodeSequence.Holder.Builder builder()

Returns:

a EventCodeSequence.Holder.Builder to create Event Code Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getEventCodeSequence

default EventCodeSequence getEventCodeSequence()

Returns:

the Event Code Sequence (see EventCodeSequence)

newEventCodeSequence

default EventCodeSequence newEventCodeSequence(int initialCapacity)

Adds a new Event Code Sequence. (see EventCodeSequence)

Parameters:

initialCapacity - the initial capacity for the new Event Code Sequence

Returns:

the newly created EventCodeSequence.

ensureEventCodeSequence

default EventCodeSequence ensureEventCodeSequence(int initialCapacity)

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

Parameters:

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

Returns:

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

ensureEventCodeSequence

default EventCodeSequence ensureEventCodeSequence()

Adds a new Event Code Sequence (see EventCodeSequence) with initial capacity 1 (see ensureEventCodeSequence(int)) if it does not already exist.

Returns:

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

containsEventCodeSequence

default boolean containsEventCodeSequence()

Returns:

whether it contains the Event Code Sequence (see EventCodeSequence)

removeEventCodeSequence

default void removeEventCodeSequence()

Removes the Event Code Sequence (see EventCodeSequence