Package org.dcm4che.typeddicom.dataelements

Interface PixelShiftSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Implementing Classes:

MaskSubtractionSequence.Item

Enclosing class:

PixelShiftSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Pixel Shift Sequence" (see PixelShiftSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static PixelShiftSequence.Holder.Builder	builder()
static PixelShiftSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsPixelShiftSequence()
default PixelShiftSequence	ensurePixelShiftSequence()	Adds a new Pixel Shift Sequence (see PixelShiftSequence) with initial capacity 1 (see ensurePixelShiftSequence(int)) if it does not already exist.
default PixelShiftSequence	ensurePixelShiftSequence(int initialCapacity)	Adds a new Pixel Shift Sequence (see PixelShiftSequence) if it does not already exist.
default PixelShiftSequence	getPixelShiftSequence()
default PixelShiftSequence	newPixelShiftSequence(int initialCapacity)	Adds a new Pixel Shift Sequence.
default void	removePixelShiftSequence()	Removes the Pixel Shift Sequence (see PixelShiftSequence
static PixelShiftSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Pixel Shift Sequence (see PixelShiftSequence)

Returns:

a wrapper object implementing the PixelShiftSequence.Holder interface.

builder

static PixelShiftSequence.Holder.Builder builder()

Returns:

a PixelShiftSequence.Holder.Builder to create Pixel Shift Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a PixelShiftSequence.Holder.Builder to create Pixel Shift Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getPixelShiftSequence

default PixelShiftSequence getPixelShiftSequence()

Returns:

the Pixel Shift Sequence (see PixelShiftSequence)

newPixelShiftSequence

default PixelShiftSequence newPixelShiftSequence(int initialCapacity)

Adds a new Pixel Shift Sequence. (see PixelShiftSequence)

Parameters:

initialCapacity - the initial capacity for the new Pixel Shift Sequence

Returns:

the newly created PixelShiftSequence.

ensurePixelShiftSequence

default PixelShiftSequence ensurePixelShiftSequence(int initialCapacity)

Adds a new Pixel Shift Sequence (see PixelShiftSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Pixel Shift Sequence (see PixelShiftSequence) or a new one with capacity initialCapacity.

ensurePixelShiftSequence

default PixelShiftSequence ensurePixelShiftSequence()

Adds a new Pixel Shift Sequence (see PixelShiftSequence) with initial capacity 1 (see ensurePixelShiftSequence(int)) if it does not already exist.

Returns:

either the already existing Pixel Shift Sequence (see PixelShiftSequence) or a new one with capacity 1.

containsPixelShiftSequence

default boolean containsPixelShiftSequence()

Returns:

whether it contains the Pixel Shift Sequence (see PixelShiftSequence)

removePixelShiftSequence

default void removePixelShiftSequence()

Removes the Pixel Shift Sequence (see PixelShiftSequence