info.magnolia.config.registry

Interface DefinitionMetadata

All Superinterfaces:

DefinitionReference

All Known Implementing Classes:

DefinitionMetadataBuilder.DefinitionMetadataImpl

public interface DefinitionMetadata
extends DefinitionReference

Use a DefinitionMetadata type {name, type, moduleID, location}, with an asString() method that outputs the current format. Location is the path in the case of a configured item, but could be a class name for cbc, for example.

Method Summary

Modifier and Type	Method and Description
ConfigurationSourceType	getConfigurationSourceType() Returns the type of the configuration source which initially produced the definition.
default Optional<Deprecation>	getDeprecation()
String	getLocation() Location of the object that defines the attached definition; depends on the ConfigurationSource.
String	getReferenceId() This is the String that can be used to refer to this definition by ID, e.g as passed to Registry.getProvider(String).
DefinitionType	getType()

Methods inherited from interface info.magnolia.config.registry.DefinitionReference

getModule, getName, getRelativeLocation

Method Detail

getType

DefinitionType getType()

getReferenceId

String getReferenceId()

This is the String that can be used to refer to this definition by ID, e.g as passed to Registry.getProvider(String).

See Also:

deprecation commentaries which are relevant to this method

getLocation

String getLocation()

Location of the object that defines the attached definition; depends on the ConfigurationSource.

getConfigurationSourceType

ConfigurationSourceType getConfigurationSourceType()

Returns the type of the configuration source which initially produced the definition.

getDeprecation

default Optional<Deprecation> getDeprecation()