Package org.ametys.odf.content.code

Class AbstractUniqueCodeGenerator

java.lang.Object

org.ametys.odf.content.code.AbstractUniqueCodeGenerator

All Implemented Interfaces:

UniqueCodeGenerator, PluginAware, Configurable

Direct Known Subclasses:

PrefixedIncrementalCodeGenerator, RandomCodeGenerator

public abstract class AbstractUniqueCodeGenerator
extends Object
implements UniqueCodeGenerator, Configurable, PluginAware

Abstract class for a static UniqueCodeGenerator

Field Summary

Fields

Modifier and Type	Field	Description
protected String	_pluginName	The plugin name

Constructor Summary

Constructors

Constructor	Description
AbstractUniqueCodeGenerator()

Method Summary

Modifier and Type	Method	Description
void	configure(Configuration configuration)
String	getId()	Get the id
I18nizableText	getLabel()	Get the label
void	setPluginInfo(String pluginName, String featureName, String id)	Sets the plugin info relative to the current component. Note : The feature name may be null if the targeted component in declared at plugin level.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ametys.odf.content.code.UniqueCodeGenerator

generateUniqueCode

Field Details

_pluginName

protected String _pluginName

The plugin name

Constructor Details

AbstractUniqueCodeGenerator

public AbstractUniqueCodeGenerator()

Method Details

getId

public String getId()

Description copied from interface: UniqueCodeGenerator

Get the id

Specified by:

getId in interface UniqueCodeGenerator

Returns:

the id.

getLabel

public I18nizableText getLabel()

Description copied from interface: UniqueCodeGenerator

Get the label

Specified by:

getLabel in interface UniqueCodeGenerator

Returns:

The label

setPluginInfo

public void setPluginInfo(String pluginName,
 String featureName,
 String id)

Description copied from interface: PluginAware

Sets the plugin info relative to the current component.
Note : The feature name may be null if the targeted component in declared at plugin level.

Specified by:

setPluginInfo in interface PluginAware

Parameters:

pluginName - Unique identifier for the plugin hosting the extension

featureName - Unique feature identifier (unique for a given pluginName)

id - Unique identifier of this component

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Throws:

ConfigurationException