Package org.dcm4che.typeddicom.dataelements

Interface PTORegionSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

Enclosing class:

PTORegionSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "PTO Region Sequence" (see PTORegionSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static PTORegionSequence.Holder.Builder	builder()
static PTORegionSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsPTORegionSequence()
default PTORegionSequence	ensurePTORegionSequence()	Adds a new PTO Region Sequence (see PTORegionSequence) with initial capacity 1 (see ensurePTORegionSequence(int)) if it does not already exist.
default PTORegionSequence	ensurePTORegionSequence(int initialCapacity)	Adds a new PTO Region Sequence (see PTORegionSequence) if it does not already exist.
default PTORegionSequence	getPTORegionSequence()
default PTORegionSequence	newPTORegionSequence(int initialCapacity)	Adds a new PTO Region Sequence.
default void	removePTORegionSequence()	Removes the PTO Region Sequence (see PTORegionSequence
static PTORegionSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the PTO Region Sequence (see PTORegionSequence)

Returns:

a wrapper object implementing the PTORegionSequence.Holder interface.

builder

static PTORegionSequence.Holder.Builder builder()

Returns:

a PTORegionSequence.Holder.Builder to create PTO Region Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a PTORegionSequence.Holder.Builder to create PTO Region Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getPTORegionSequence

default PTORegionSequence getPTORegionSequence()

Returns:

the PTO Region Sequence (see PTORegionSequence)

newPTORegionSequence

default PTORegionSequence newPTORegionSequence(int initialCapacity)

Adds a new PTO Region Sequence. (see PTORegionSequence)

Parameters:

initialCapacity - the initial capacity for the new PTO Region Sequence

Returns:

the newly created PTORegionSequence.

ensurePTORegionSequence

default PTORegionSequence ensurePTORegionSequence(int initialCapacity)

Adds a new PTO Region Sequence (see PTORegionSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing PTO Region Sequence (see PTORegionSequence) or a new one with capacity initialCapacity.

ensurePTORegionSequence

default PTORegionSequence ensurePTORegionSequence()

Adds a new PTO Region Sequence (see PTORegionSequence) with initial capacity 1 (see ensurePTORegionSequence(int)) if it does not already exist.

Returns:

either the already existing PTO Region Sequence (see PTORegionSequence) or a new one with capacity 1.

containsPTORegionSequence

default boolean containsPTORegionSequence()

Returns:

whether it contains the PTO Region Sequence (see PTORegionSequence)

removePTORegionSequence

default void removePTORegionSequence()

Removes the PTO Region Sequence (see PTORegionSequence