Package org.dcm4che.typeddicom.dataelements

Interface AuthorIdentificationSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

RadiotherapyCommonInstanceModule

All Known Implementing Classes:

CArmPhotonElectronRadiationIOD, CArmPhotonElectronRadiationRecordIOD, RadiotherapyCommonInstanceModule.SimpleWrapper, RoboticArmRadiationIOD, RoboticArmRadiationRecordIOD, RTPhysicianIntentIOD, RTRadiationRecordSetIOD, RTRadiationSalvageRecordIOD, RTRadiationSetDeliveryInstructionIOD, RTRadiationSetIOD, RTSegmentAnnotationIOD, RTTreatmentPreparationIOD, TomotherapeuticRadiationIOD, TomotherapeuticRadiationRecordIOD

Enclosing class:

AuthorIdentificationSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Author Identification Sequence" (see AuthorIdentificationSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static AuthorIdentificationSequence.Holder.Builder	builder()
static AuthorIdentificationSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsAuthorIdentificationSequence()
default AuthorIdentificationSequence	ensureAuthorIdentificationSequence()	Adds a new Author Identification Sequence (see AuthorIdentificationSequence) with initial capacity 1 (see ensureAuthorIdentificationSequence(int)) if it does not already exist.
default AuthorIdentificationSequence	ensureAuthorIdentificationSequence(int initialCapacity)	Adds a new Author Identification Sequence (see AuthorIdentificationSequence) if it does not already exist.
default AuthorIdentificationSequence	getAuthorIdentificationSequence()
default AuthorIdentificationSequence	newAuthorIdentificationSequence(int initialCapacity)	Adds a new Author Identification Sequence.
default void	removeAuthorIdentificationSequence()	Removes the Author Identification Sequence (see AuthorIdentificationSequence
static AuthorIdentificationSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Author Identification Sequence (see AuthorIdentificationSequence)

Returns:

a wrapper object implementing the AuthorIdentificationSequence.Holder interface.

builder

static AuthorIdentificationSequence.Holder.Builder builder()

Returns:

a AuthorIdentificationSequence.Holder.Builder to create Author Identification Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a AuthorIdentificationSequence.Holder.Builder to create Author Identification Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getAuthorIdentificationSequence

default AuthorIdentificationSequence getAuthorIdentificationSequence()

Returns:

the Author Identification Sequence (see AuthorIdentificationSequence)

newAuthorIdentificationSequence

default AuthorIdentificationSequence newAuthorIdentificationSequence(int initialCapacity)

Adds a new Author Identification Sequence. (see AuthorIdentificationSequence)

Parameters:

initialCapacity - the initial capacity for the new Author Identification Sequence

Returns:

the newly created AuthorIdentificationSequence.

ensureAuthorIdentificationSequence

default AuthorIdentificationSequence ensureAuthorIdentificationSequence(int initialCapacity)

Adds a new Author Identification Sequence (see AuthorIdentificationSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Author Identification Sequence (see AuthorIdentificationSequence) or a new one with capacity initialCapacity.

ensureAuthorIdentificationSequence

default AuthorIdentificationSequence ensureAuthorIdentificationSequence()

Adds a new Author Identification Sequence (see AuthorIdentificationSequence) with initial capacity 1 (see ensureAuthorIdentificationSequence(int)) if it does not already exist.

Returns:

either the already existing Author Identification Sequence (see AuthorIdentificationSequence) or a new one with capacity 1.

containsAuthorIdentificationSequence

default boolean containsAuthorIdentificationSequence()

Returns:

whether it contains the Author Identification Sequence (see AuthorIdentificationSequence)

removeAuthorIdentificationSequence

default void removeAuthorIdentificationSequence()

Removes the Author Identification Sequence (see AuthorIdentificationSequence