Package org.dcm4che.typeddicom.dataelements

Interface FrequencyEncodingCodeSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Implementing Classes:

FilterLookupTableSequence.Item, FrequencyEncodingCodeSequence.SimpleHolder, SummarizedFilterLookupTable.Item

Enclosing class:

FrequencyEncodingCodeSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Frequency Encoding Code Sequence" (see FrequencyEncodingCodeSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static FrequencyEncodingCodeSequence.Holder.Builder	builder()
static FrequencyEncodingCodeSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsFrequencyEncodingCodeSequence()
default FrequencyEncodingCodeSequence	ensureFrequencyEncodingCodeSequence()	Adds a new Frequency Encoding Code Sequence (see FrequencyEncodingCodeSequence) with initial capacity 1 (see ensureFrequencyEncodingCodeSequence(int)) if it does not already exist.
default FrequencyEncodingCodeSequence	ensureFrequencyEncodingCodeSequence(int initialCapacity)	Adds a new Frequency Encoding Code Sequence (see FrequencyEncodingCodeSequence) if it does not already exist.
default FrequencyEncodingCodeSequence	getFrequencyEncodingCodeSequence()
default FrequencyEncodingCodeSequence	newFrequencyEncodingCodeSequence(int initialCapacity)	Adds a new Frequency Encoding Code Sequence.
default void	removeFrequencyEncodingCodeSequence()	Removes the Frequency Encoding Code Sequence (see FrequencyEncodingCodeSequence
static FrequencyEncodingCodeSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Frequency Encoding Code Sequence (see FrequencyEncodingCodeSequence)

Returns:

a wrapper object implementing the FrequencyEncodingCodeSequence.Holder interface.

builder

static FrequencyEncodingCodeSequence.Holder.Builder builder()

Returns:

a FrequencyEncodingCodeSequence.Holder.Builder to create Frequency Encoding Code Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a FrequencyEncodingCodeSequence.Holder.Builder to create Frequency Encoding Code Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getFrequencyEncodingCodeSequence

default FrequencyEncodingCodeSequence getFrequencyEncodingCodeSequence()

Returns:

the Frequency Encoding Code Sequence (see FrequencyEncodingCodeSequence)

newFrequencyEncodingCodeSequence

default FrequencyEncodingCodeSequence newFrequencyEncodingCodeSequence(int initialCapacity)

Adds a new Frequency Encoding Code Sequence. (see FrequencyEncodingCodeSequence)

Parameters:

initialCapacity - the initial capacity for the new Frequency Encoding Code Sequence

Returns:

the newly created FrequencyEncodingCodeSequence.

ensureFrequencyEncodingCodeSequence

default FrequencyEncodingCodeSequence ensureFrequencyEncodingCodeSequence(int initialCapacity)

Adds a new Frequency Encoding Code Sequence (see FrequencyEncodingCodeSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

initialCapacity - the initial capacity (see ArrayList(int)) if a new Frequency Encoding Code Sequence is created.

Returns:

either the already existing Frequency Encoding Code Sequence (see FrequencyEncodingCodeSequence) or a new one with capacity initialCapacity.

ensureFrequencyEncodingCodeSequence

default FrequencyEncodingCodeSequence ensureFrequencyEncodingCodeSequence()

Adds a new Frequency Encoding Code Sequence (see FrequencyEncodingCodeSequence) with initial capacity 1 (see ensureFrequencyEncodingCodeSequence(int)) if it does not already exist.

Returns:

either the already existing Frequency Encoding Code Sequence (see FrequencyEncodingCodeSequence) or a new one with capacity 1.

containsFrequencyEncodingCodeSequence

default boolean containsFrequencyEncodingCodeSequence()

Returns:

whether it contains the Frequency Encoding Code Sequence (see FrequencyEncodingCodeSequence)

removeFrequencyEncodingCodeSequence

default void removeFrequencyEncodingCodeSequence()

Removes the Frequency Encoding Code Sequence (see FrequencyEncodingCodeSequence