Package org.dcm4che.typeddicom.dataelements

Interface PredecessorStructureSetSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

StructureSetModule

All Known Implementing Classes:

RTDoseIOD, RTStructureSetIOD, StructureSetModule.SimpleWrapper

Enclosing class:

PredecessorStructureSetSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Predecessor Structure Set Sequence" (see PredecessorStructureSetSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static PredecessorStructureSetSequence.Holder.Builder	builder()
static PredecessorStructureSetSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsPredecessorStructureSetSequence()
default PredecessorStructureSetSequence	ensurePredecessorStructureSetSequence()	Adds a new Predecessor Structure Set Sequence (see PredecessorStructureSetSequence) with initial capacity 1 (see ensurePredecessorStructureSetSequence(int)) if it does not already exist.
default PredecessorStructureSetSequence	ensurePredecessorStructureSetSequence(int initialCapacity)	Adds a new Predecessor Structure Set Sequence (see PredecessorStructureSetSequence) if it does not already exist.
default PredecessorStructureSetSequence	getPredecessorStructureSetSequence()
default PredecessorStructureSetSequence	newPredecessorStructureSetSequence(int initialCapacity)	Adds a new Predecessor Structure Set Sequence.
default void	removePredecessorStructureSetSequence()	Removes the Predecessor Structure Set Sequence (see PredecessorStructureSetSequence
static PredecessorStructureSetSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Predecessor Structure Set Sequence (see PredecessorStructureSetSequence)

Returns:

a wrapper object implementing the PredecessorStructureSetSequence.Holder interface.

builder

static PredecessorStructureSetSequence.Holder.Builder builder()

Returns:

a PredecessorStructureSetSequence.Holder.Builder to create Predecessor Structure Set Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a PredecessorStructureSetSequence.Holder.Builder to create Predecessor Structure Set Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getPredecessorStructureSetSequence

default PredecessorStructureSetSequence getPredecessorStructureSetSequence()

Returns:

the Predecessor Structure Set Sequence (see PredecessorStructureSetSequence)

newPredecessorStructureSetSequence

default PredecessorStructureSetSequence newPredecessorStructureSetSequence(int initialCapacity)

Adds a new Predecessor Structure Set Sequence. (see PredecessorStructureSetSequence)

Parameters:

initialCapacity - the initial capacity for the new Predecessor Structure Set Sequence

Returns:

the newly created PredecessorStructureSetSequence.

ensurePredecessorStructureSetSequence

default PredecessorStructureSetSequence ensurePredecessorStructureSetSequence(int initialCapacity)

Adds a new Predecessor Structure Set Sequence (see PredecessorStructureSetSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

initialCapacity - the initial capacity (see ArrayList(int)) if a new Predecessor Structure Set Sequence is created.

Returns:

either the already existing Predecessor Structure Set Sequence (see PredecessorStructureSetSequence) or a new one with capacity initialCapacity.

ensurePredecessorStructureSetSequence

default PredecessorStructureSetSequence ensurePredecessorStructureSetSequence()

Adds a new Predecessor Structure Set Sequence (see PredecessorStructureSetSequence) with initial capacity 1 (see ensurePredecessorStructureSetSequence(int)) if it does not already exist.

Returns:

either the already existing Predecessor Structure Set Sequence (see PredecessorStructureSetSequence) or a new one with capacity 1.

containsPredecessorStructureSetSequence

default boolean containsPredecessorStructureSetSequence()

Returns:

whether it contains the Predecessor Structure Set Sequence (see PredecessorStructureSetSequence)

removePredecessorStructureSetSequence

default void removePredecessorStructureSetSequence()

Removes the Predecessor Structure Set Sequence (see PredecessorStructureSetSequence