info.magnolia.config.registry

Interface DefinitionMetadata

All Known Implementing Classes:

DefinitionMetadataBuilder.DefinitionMetadataImpl

public interface DefinitionMetadata

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

Methods

Modifier and Type	Method and Description
String	getLocation() Location of the object that defines the attached definition; depends on the ConfigurationSource.
String	getModule()
String	getName()
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).
String	getRelativeLocation() Location of the object that defines the attached definition, relative to its module; depends on the ConfigurationSource.
DefinitionType	getType()

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).

getName

String getName()

getModule

String getModule()

getLocation

String getLocation()

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

getRelativeLocation

String getRelativeLocation()

Location of the object that defines the attached definition, relative to its module; depends on the ConfigurationSource. This can be used to compose the value returned by getReferenceId().