Package org.dcm4che.typeddicom.dataelements

Interface XRayFilterSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Implementing Classes:

XRayFilterSequence.SimpleHolder

Enclosing class:

XRayFilterSequence

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

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static XRayFilterSequence.Holder.Builder	builder()
static XRayFilterSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsXRayFilterSequence()
default XRayFilterSequence	ensureXRayFilterSequence()	Adds a new X-Ray Filter Sequence (see XRayFilterSequence) with initial capacity 1 (see ensureXRayFilterSequence(int)) if it does not already exist.
default XRayFilterSequence	ensureXRayFilterSequence(int initialCapacity)	Adds a new X-Ray Filter Sequence (see XRayFilterSequence) if it does not already exist.
default XRayFilterSequence	getXRayFilterSequence()
default XRayFilterSequence	newXRayFilterSequence(int initialCapacity)	Adds a new X-Ray Filter Sequence.
default void	removeXRayFilterSequence()	Removes the X-Ray Filter Sequence (see XRayFilterSequence
static XRayFilterSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the X-Ray Filter Sequence (see XRayFilterSequence)

Returns:

a wrapper object implementing the XRayFilterSequence.Holder interface.

builder

static XRayFilterSequence.Holder.Builder builder()

Returns:

a XRayFilterSequence.Holder.Builder to create X-Ray Filter Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getXRayFilterSequence

default XRayFilterSequence getXRayFilterSequence()

Returns:

the X-Ray Filter Sequence (see XRayFilterSequence)

newXRayFilterSequence

default XRayFilterSequence newXRayFilterSequence(int initialCapacity)

Adds a new X-Ray Filter Sequence. (see XRayFilterSequence)

Parameters:

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

Returns:

the newly created XRayFilterSequence.

ensureXRayFilterSequence

default XRayFilterSequence ensureXRayFilterSequence(int initialCapacity)

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

Parameters:

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

Returns:

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

ensureXRayFilterSequence

default XRayFilterSequence ensureXRayFilterSequence()

Adds a new X-Ray Filter Sequence (see XRayFilterSequence) with initial capacity 1 (see ensureXRayFilterSequence(int)) if it does not already exist.

Returns:

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

containsXRayFilterSequence

default boolean containsXRayFilterSequence()

Returns:

whether it contains the X-Ray Filter Sequence (see XRayFilterSequence)

removeXRayFilterSequence

default void removeXRayFilterSequence()

Removes the X-Ray Filter Sequence (see XRayFilterSequence