sdk-pspdfkit/com.pspdfkit.annotations.configuration/AnnotationConfigurationRegistry/get

get

@Nullable
abstract fun get(@NonNull annotationType: AnnotationType): AnnotationConfiguration

Retrieve configuration for given annotation type.

Return

Annotation configuration or null if configuration does not exist.

Parameters

annotationType

Type of annotation for which to retrieve configuration.

@Nullable
abstract fun get(@NonNull annotationTool: AnnotationTool): AnnotationConfiguration

Retrieve configuration for given annotation tool. If no configuration is set for annotation tool, configuration for underlying annotation type (toAnnotationType is returned. The default tool variant is used in this method.

Return

Annotation configuration or null if configuration does not exist.

Parameters

annotationTool

Annotation tool for which to retrieve the configuration.

See also

to get configuration for specific tool variant.

@Nullable
abstract fun get(@NonNull annotationTool: AnnotationTool, @NonNull toolVariant: AnnotationToolVariant): AnnotationConfiguration

Retrieve configuration for given annotation tool and its tool variant. If no configuration is set for the requested variant, configuration for the default variant is returned. Finally, if no configuration is set for the default variant, configuration for the underlying annotation type (toAnnotationType is returned.

Return

Annotation configuration or null if configuration does not exist.

Parameters

annotationTool

Annotation tool for which to retrieve configuration.

toolVariant

Annotation tool variant for which to retrieve the configuration.

@Nullable
abstract fun <T : AnnotationConfiguration?> get(@NonNull annotationType: AnnotationType, @NonNull requiredClass: Class<T>): T

Retrieve configuration for given annotation type casted to required configuration type.

Return

Annotation configuration casted to T or null if configuration does not exist or has other type than T.

Parameters

annotationType

Type of annotation for which to retrieve configuration.

requiredClass

Required class of configuration.

<T>

Required type of configuration.

@Nullable
abstract fun <T : AnnotationConfiguration?> get(@NonNull annotationTool: AnnotationTool, @NonNull requiredClass: Class<T>): T

Retrieve configuration for given annotation tool casted to required configuration type. If no configuration is set for annotation tool, configuration for underlying annotation type (toAnnotationType is returned.

Return

Annotation configuration casted to T or null if configuration does not exist or has other type than T.

Parameters

annotationTool

Annotation tool for which to retrieve configuration.

requiredClass

Required class of configuration.

<T>

Required type of configuration.

See also

to get the configuration for the specific tool variant.

@Nullable
abstract fun <T : AnnotationConfiguration?> get(@NonNull annotationTool: AnnotationTool, @NonNull toolVariant: AnnotationToolVariant, @NonNull requiredClass: Class<T>): T

Retrieve configuration for given annotation tool and its variant casted to required configuration type. If no configuration is set for the requested variant, configuration for the default variant is returned. Finally, if no configuration is set for the default variant, configuration for the underlying annotation type (toAnnotationType is returned.

Return

Annotation configuration casted to T or null if configuration does not exist or has other type than T.

Parameters

annotationTool

Annotation tool for which to retrieve configuration.

toolVariant

Variant of the specified tool for which to retrieve the configuration.

requiredClass

Required class of configuration.

<T>

Required type of configuration.