Package org.dcm4che.typeddicom.dataelements

Interface XRayGridSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

Enclosing class:

XRayGridSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "X-Ray Grid Sequence" (see XRayGridSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static XRayGridSequence.Holder.Builder	builder()
static XRayGridSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsXRayGridSequence()
default XRayGridSequence	ensureXRayGridSequence()	Adds a new X-Ray Grid Sequence (see XRayGridSequence) with initial capacity 1 (see ensureXRayGridSequence(int)) if it does not already exist.
default XRayGridSequence	ensureXRayGridSequence(int initialCapacity)	Adds a new X-Ray Grid Sequence (see XRayGridSequence) if it does not already exist.
default XRayGridSequence	getXRayGridSequence()
default XRayGridSequence	newXRayGridSequence(int initialCapacity)	Adds a new X-Ray Grid Sequence.
default void	removeXRayGridSequence()	Removes the X-Ray Grid Sequence (see XRayGridSequence
static XRayGridSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the X-Ray Grid Sequence (see XRayGridSequence)

Returns:

a wrapper object implementing the XRayGridSequence.Holder interface.

builder

static XRayGridSequence.Holder.Builder builder()

Returns:

a XRayGridSequence.Holder.Builder to create X-Ray Grid Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a XRayGridSequence.Holder.Builder to create X-Ray Grid Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getXRayGridSequence

default XRayGridSequence getXRayGridSequence()

Returns:

the X-Ray Grid Sequence (see XRayGridSequence)

newXRayGridSequence

default XRayGridSequence newXRayGridSequence(int initialCapacity)

Adds a new X-Ray Grid Sequence. (see XRayGridSequence)

Parameters:

initialCapacity - the initial capacity for the new X-Ray Grid Sequence

Returns:

the newly created XRayGridSequence.

ensureXRayGridSequence

default XRayGridSequence ensureXRayGridSequence(int initialCapacity)

Adds a new X-Ray Grid Sequence (see XRayGridSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

initialCapacity - the initial capacity (see ArrayList(int)) if a new X-Ray Grid Sequence is created.

Returns:

either the already existing X-Ray Grid Sequence (see XRayGridSequence) or a new one with capacity initialCapacity.

ensureXRayGridSequence

default XRayGridSequence ensureXRayGridSequence()

Adds a new X-Ray Grid Sequence (see XRayGridSequence) with initial capacity 1 (see ensureXRayGridSequence(int)) if it does not already exist.

Returns:

either the already existing X-Ray Grid Sequence (see XRayGridSequence) or a new one with capacity 1.

containsXRayGridSequence

default boolean containsXRayGridSequence()

Returns:

whether it contains the X-Ray Grid Sequence (see XRayGridSequence)

removeXRayGridSequence

default void removeXRayGridSequence()

Removes the X-Ray Grid Sequence (see XRayGridSequence