Package org.dcm4che.typeddicom.dataelements

Interface FramePixelDataPropertiesSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

Enclosing class:

FramePixelDataPropertiesSequence

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

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static FramePixelDataPropertiesSequence.Holder.Builder	builder()
static FramePixelDataPropertiesSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsFramePixelDataPropertiesSequence()
default FramePixelDataPropertiesSequence	ensureFramePixelDataPropertiesSequence()	Adds a new Frame Pixel Data Properties Sequence (see FramePixelDataPropertiesSequence) with initial capacity 1 (see ensureFramePixelDataPropertiesSequence(int)) if it does not already exist.
default FramePixelDataPropertiesSequence	ensureFramePixelDataPropertiesSequence(int initialCapacity)	Adds a new Frame Pixel Data Properties Sequence (see FramePixelDataPropertiesSequence) if it does not already exist.
default FramePixelDataPropertiesSequence	getFramePixelDataPropertiesSequence()
default FramePixelDataPropertiesSequence	newFramePixelDataPropertiesSequence(int initialCapacity)	Adds a new Frame Pixel Data Properties Sequence.
default void	removeFramePixelDataPropertiesSequence()	Removes the Frame Pixel Data Properties Sequence (see FramePixelDataPropertiesSequence
static FramePixelDataPropertiesSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Frame Pixel Data Properties Sequence (see FramePixelDataPropertiesSequence)

Returns:

a wrapper object implementing the FramePixelDataPropertiesSequence.Holder interface.

builder

static FramePixelDataPropertiesSequence.Holder.Builder builder()

Returns:

a FramePixelDataPropertiesSequence.Holder.Builder to create Frame Pixel Data Properties Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getFramePixelDataPropertiesSequence

default FramePixelDataPropertiesSequence getFramePixelDataPropertiesSequence()

Returns:

the Frame Pixel Data Properties Sequence (see FramePixelDataPropertiesSequence)

newFramePixelDataPropertiesSequence

default FramePixelDataPropertiesSequence newFramePixelDataPropertiesSequence(int initialCapacity)

Adds a new Frame Pixel Data Properties Sequence. (see FramePixelDataPropertiesSequence)

Parameters:

initialCapacity - the initial capacity for the new Frame Pixel Data Properties Sequence

Returns:

the newly created FramePixelDataPropertiesSequence.

ensureFramePixelDataPropertiesSequence

default FramePixelDataPropertiesSequence ensureFramePixelDataPropertiesSequence(int initialCapacity)

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

Parameters:

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

Returns:

either the already existing Frame Pixel Data Properties Sequence (see FramePixelDataPropertiesSequence) or a new one with capacity initialCapacity.

ensureFramePixelDataPropertiesSequence

default FramePixelDataPropertiesSequence ensureFramePixelDataPropertiesSequence()

Adds a new Frame Pixel Data Properties Sequence (see FramePixelDataPropertiesSequence) with initial capacity 1 (see ensureFramePixelDataPropertiesSequence(int)) if it does not already exist.

Returns:

either the already existing Frame Pixel Data Properties Sequence (see FramePixelDataPropertiesSequence) or a new one with capacity 1.

containsFramePixelDataPropertiesSequence

default boolean containsFramePixelDataPropertiesSequence()

Returns:

whether it contains the Frame Pixel Data Properties Sequence (see FramePixelDataPropertiesSequence)

removeFramePixelDataPropertiesSequence

default void removeFramePixelDataPropertiesSequence()

Removes the Frame Pixel Data Properties Sequence (see FramePixelDataPropertiesSequence