Package org.dcm4che.typeddicom.dataelements

Interface RouteSegmentSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

Enclosing class:

RouteSegmentSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Route Segment Sequence" (see RouteSegmentSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static RouteSegmentSequence.Holder.Builder	builder()
static RouteSegmentSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsRouteSegmentSequence()
default RouteSegmentSequence	ensureRouteSegmentSequence()	Adds a new Route Segment Sequence (see RouteSegmentSequence) with initial capacity 1 (see ensureRouteSegmentSequence(int)) if it does not already exist.
default RouteSegmentSequence	ensureRouteSegmentSequence(int initialCapacity)	Adds a new Route Segment Sequence (see RouteSegmentSequence) if it does not already exist.
default RouteSegmentSequence	getRouteSegmentSequence()
default RouteSegmentSequence	newRouteSegmentSequence(int initialCapacity)	Adds a new Route Segment Sequence.
default void	removeRouteSegmentSequence()	Removes the Route Segment Sequence (see RouteSegmentSequence
static RouteSegmentSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Route Segment Sequence (see RouteSegmentSequence)

Returns:

a wrapper object implementing the RouteSegmentSequence.Holder interface.

builder

static RouteSegmentSequence.Holder.Builder builder()

Returns:

a RouteSegmentSequence.Holder.Builder to create Route Segment Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a RouteSegmentSequence.Holder.Builder to create Route Segment Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getRouteSegmentSequence

default RouteSegmentSequence getRouteSegmentSequence()

Returns:

the Route Segment Sequence (see RouteSegmentSequence)

newRouteSegmentSequence

default RouteSegmentSequence newRouteSegmentSequence(int initialCapacity)

Adds a new Route Segment Sequence. (see RouteSegmentSequence)

Parameters:

initialCapacity - the initial capacity for the new Route Segment Sequence

Returns:

the newly created RouteSegmentSequence.

ensureRouteSegmentSequence

default RouteSegmentSequence ensureRouteSegmentSequence(int initialCapacity)

Adds a new Route Segment Sequence (see RouteSegmentSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Route Segment Sequence (see RouteSegmentSequence) or a new one with capacity initialCapacity.

ensureRouteSegmentSequence

default RouteSegmentSequence ensureRouteSegmentSequence()

Adds a new Route Segment Sequence (see RouteSegmentSequence) with initial capacity 1 (see ensureRouteSegmentSequence(int)) if it does not already exist.

Returns:

either the already existing Route Segment Sequence (see RouteSegmentSequence) or a new one with capacity 1.

containsRouteSegmentSequence

default boolean containsRouteSegmentSequence()

Returns:

whether it contains the Route Segment Sequence (see RouteSegmentSequence)

removeRouteSegmentSequence

default void removeRouteSegmentSequence()

Removes the Route Segment Sequence (see RouteSegmentSequence