Package org.ametys.runtime.plugin

Class Feature

java.lang.Object

org.ametys.runtime.plugin.Feature

public class Feature
extends Object

A plugin is composed by features, containing components definitions and extensions.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_NAME	Name for fake features, eg.

Method Summary

Modifier and Type	Method	Description
Map<String,String>	getComponentsIds()	Returns the components declared within this feature, stored by role.
Map<String,ConfigParameterInfo>	getConfigParameters()	List the configuration parameters declared in the feature.
Collection<String>	getConfigParametersReferences()	List the configuration parameters referenced from the feature.
Map<String,Collection<String>>	getExtensionsIds()	Returns the extensions declared within this feature, grouped by extension point.
String	getFeatureId()	Returns the feature id, ie.
String	getFeatureName()	Returns this feature name
String	getPluginName()	Returns the declaring plugin name
boolean	isPassive()	Returns true if this feature is passive.
boolean	isSafe()	Returns true if this feature is declared as safe.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DEFAULT_NAME

public static final String DEFAULT_NAME

Name for fake features, eg. declared on the fly

See Also:

• Constant Field Values

Method Details

getPluginName

public String getPluginName()

Returns the declaring plugin name

Returns:

the declaring plugin name

getFeatureName

public String getFeatureName()

Returns this feature name

Returns:

this feature name

getFeatureId

public String getFeatureId()

Returns the feature id, ie. getPluginName() + '/' + getFeatureName()

Returns:

the feature id.

isPassive

public boolean isPassive()

Returns true if this feature is passive.

Returns:

true if this feature is passive.

isSafe

public boolean isSafe()

Returns true if this feature is declared as safe.

Returns:

true if this feature is declared as safe.

getExtensionsIds

public Map<String,Collection<String>> getExtensionsIds()

Returns the extensions declared within this feature, grouped by extension point.

Returns:

the extensions declared within this feature, grouped by extension point.

getComponentsIds

public Map<String,String> getComponentsIds()

Returns the components declared within this feature, stored by role.

Returns:

the components declared within this feature, stored by role.

getConfigParameters

public Map<String,ConfigParameterInfo> getConfigParameters()

List the configuration parameters declared in the feature. See #getConfigParametersReferences

Returns:

The non null map of parameters

getConfigParametersReferences

public Collection<String> getConfigParametersReferences()

List the configuration parameters referenced from the feature. See #getConfigParameters

Returns:

The non null map of parameters