Package org.dcm4che.typeddicom.dataelements

Interface PlanePositionSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Implementing Classes:

CurrentFrameFunctionalGroupsSequence.Item, PerFrameFunctionalGroupsSequence.Item, PlanePositionSequence.SimpleHolder, SharedFunctionalGroupsSequence.Item

Enclosing class:

PlanePositionSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Plane Position Sequence" (see PlanePositionSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static PlanePositionSequence.Holder.Builder	builder()
static PlanePositionSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsPlanePositionSequence()
default PlanePositionSequence	ensurePlanePositionSequence()	Adds a new Plane Position Sequence (see PlanePositionSequence) with initial capacity 1 (see ensurePlanePositionSequence(int)) if it does not already exist.
default PlanePositionSequence	ensurePlanePositionSequence(int initialCapacity)	Adds a new Plane Position Sequence (see PlanePositionSequence) if it does not already exist.
default PlanePositionSequence	getPlanePositionSequence()
default PlanePositionSequence	newPlanePositionSequence(int initialCapacity)	Adds a new Plane Position Sequence.
default void	removePlanePositionSequence()	Removes the Plane Position Sequence (see PlanePositionSequence
static PlanePositionSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Plane Position Sequence (see PlanePositionSequence)

Returns:

a wrapper object implementing the PlanePositionSequence.Holder interface.

builder

static PlanePositionSequence.Holder.Builder builder()

Returns:

a PlanePositionSequence.Holder.Builder to create Plane Position Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a PlanePositionSequence.Holder.Builder to create Plane Position Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getPlanePositionSequence

default PlanePositionSequence getPlanePositionSequence()

Returns:

the Plane Position Sequence (see PlanePositionSequence)

newPlanePositionSequence

default PlanePositionSequence newPlanePositionSequence(int initialCapacity)

Adds a new Plane Position Sequence. (see PlanePositionSequence)

Parameters:

initialCapacity - the initial capacity for the new Plane Position Sequence

Returns:

the newly created PlanePositionSequence.

ensurePlanePositionSequence

default PlanePositionSequence ensurePlanePositionSequence(int initialCapacity)

Adds a new Plane Position Sequence (see PlanePositionSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Plane Position Sequence (see PlanePositionSequence) or a new one with capacity initialCapacity.

ensurePlanePositionSequence

default PlanePositionSequence ensurePlanePositionSequence()

Adds a new Plane Position Sequence (see PlanePositionSequence) with initial capacity 1 (see ensurePlanePositionSequence(int)) if it does not already exist.

Returns:

either the already existing Plane Position Sequence (see PlanePositionSequence) or a new one with capacity 1.

containsPlanePositionSequence

default boolean containsPlanePositionSequence()

Returns:

whether it contains the Plane Position Sequence (see PlanePositionSequence)

removePlanePositionSequence

default void removePlanePositionSequence()

Removes the Plane Position Sequence (see PlanePositionSequence