Package org.dcm4che.typeddicom.dataelements

Interface FramePixelShiftSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Implementing Classes:

CurrentFrameFunctionalGroupsSequence.Item, PerFrameFunctionalGroupsSequence.Item, SharedFunctionalGroupsSequence.Item

Enclosing class:

FramePixelShiftSequence

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

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static FramePixelShiftSequence.Holder.Builder	builder()
static FramePixelShiftSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsFramePixelShiftSequence()
default FramePixelShiftSequence	ensureFramePixelShiftSequence()	Adds a new Frame Pixel Shift Sequence (see FramePixelShiftSequence) with initial capacity 1 (see ensureFramePixelShiftSequence(int)) if it does not already exist.
default FramePixelShiftSequence	ensureFramePixelShiftSequence(int initialCapacity)	Adds a new Frame Pixel Shift Sequence (see FramePixelShiftSequence) if it does not already exist.
default FramePixelShiftSequence	getFramePixelShiftSequence()
default FramePixelShiftSequence	newFramePixelShiftSequence(int initialCapacity)	Adds a new Frame Pixel Shift Sequence.
default void	removeFramePixelShiftSequence()	Removes the Frame Pixel Shift Sequence (see FramePixelShiftSequence
static FramePixelShiftSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

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

Returns:

a wrapper object implementing the FramePixelShiftSequence.Holder interface.

builder

static FramePixelShiftSequence.Holder.Builder builder()

Returns:

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

builder

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

Parameters:

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

Returns:

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

getFramePixelShiftSequence

default FramePixelShiftSequence getFramePixelShiftSequence()

Returns:

the Frame Pixel Shift Sequence (see FramePixelShiftSequence)

newFramePixelShiftSequence

default FramePixelShiftSequence newFramePixelShiftSequence(int initialCapacity)

Adds a new Frame Pixel Shift Sequence. (see FramePixelShiftSequence)

Parameters:

initialCapacity - the initial capacity for the new Frame Pixel Shift Sequence

Returns:

the newly created FramePixelShiftSequence.

ensureFramePixelShiftSequence

default FramePixelShiftSequence ensureFramePixelShiftSequence(int initialCapacity)

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

Parameters:

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

Returns:

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

ensureFramePixelShiftSequence

default FramePixelShiftSequence ensureFramePixelShiftSequence()

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

Returns:

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

containsFramePixelShiftSequence

default boolean containsFramePixelShiftSequence()

Returns:

whether it contains the Frame Pixel Shift Sequence (see FramePixelShiftSequence)

removeFramePixelShiftSequence

default void removeFramePixelShiftSequence()

Removes the Frame Pixel Shift Sequence (see FramePixelShiftSequence