Package org.dcm4che.typeddicom.dataelements

Interface RegionPixelShiftSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Implementing Classes:

PixelShiftSequence.Item

Enclosing class:

RegionPixelShiftSequence

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

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static RegionPixelShiftSequence.Holder.Builder	builder()
static RegionPixelShiftSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsRegionPixelShiftSequence()
default RegionPixelShiftSequence	ensureRegionPixelShiftSequence()	Adds a new Region Pixel Shift Sequence (see RegionPixelShiftSequence) with initial capacity 1 (see ensureRegionPixelShiftSequence(int)) if it does not already exist.
default RegionPixelShiftSequence	ensureRegionPixelShiftSequence(int initialCapacity)	Adds a new Region Pixel Shift Sequence (see RegionPixelShiftSequence) if it does not already exist.
default RegionPixelShiftSequence	getRegionPixelShiftSequence()
default RegionPixelShiftSequence	newRegionPixelShiftSequence(int initialCapacity)	Adds a new Region Pixel Shift Sequence.
default void	removeRegionPixelShiftSequence()	Removes the Region Pixel Shift Sequence (see RegionPixelShiftSequence
static RegionPixelShiftSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

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

Returns:

a wrapper object implementing the RegionPixelShiftSequence.Holder interface.

builder

static RegionPixelShiftSequence.Holder.Builder builder()

Returns:

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

builder

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

Parameters:

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

Returns:

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

getRegionPixelShiftSequence

default RegionPixelShiftSequence getRegionPixelShiftSequence()

Returns:

the Region Pixel Shift Sequence (see RegionPixelShiftSequence)

newRegionPixelShiftSequence

default RegionPixelShiftSequence newRegionPixelShiftSequence(int initialCapacity)

Adds a new Region Pixel Shift Sequence. (see RegionPixelShiftSequence)

Parameters:

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

Returns:

the newly created RegionPixelShiftSequence.

ensureRegionPixelShiftSequence

default RegionPixelShiftSequence ensureRegionPixelShiftSequence(int initialCapacity)

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

Parameters:

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

Returns:

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

ensureRegionPixelShiftSequence

default RegionPixelShiftSequence ensureRegionPixelShiftSequence()

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

Returns:

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

containsRegionPixelShiftSequence

default boolean containsRegionPixelShiftSequence()

Returns:

whether it contains the Region Pixel Shift Sequence (see RegionPixelShiftSequence)

removeRegionPixelShiftSequence

default void removeRegionPixelShiftSequence()

Removes the Region Pixel Shift Sequence (see RegionPixelShiftSequence