Package org.dspace.core

Interface NameAwarePlugin

All Known Subinterfaces:

ChoiceAuthority, HierarchicalAuthority

All Known Implementing Classes:

DCInputAuthority, DSpaceControlledVocabulary, MODSDisseminationCrosswalk, PDFPackager, QDCCrosswalk, SampleAuthority, SelfNamedPlugin, SHERPARoMEOJournalTitle, SHERPARoMEOPublisher, SimpleDCDisseminationCrosswalk, SolrAuthority, TestAuthority, XHTMLHeadDisseminationCrosswalk, XSLTCrosswalk, XSLTDisseminationCrosswalk, XSLTIngestionCrosswalk

public interface NameAwarePlugin

This is the interface that should be implemented by all the named plugin that like to be aware of their name

Version:

$Revision$

Author:

Andrea Bollini (andrea.bollini at 4science.it)

See Also:

PluginService

Method Summary

Modifier and Type	Method	Description
String	getPluginInstanceName()	Get the instance's particular name.
void	setPluginInstanceName(String name)	Set the name under which this plugin was instantiated.

Method Detail

getPluginInstanceName

String getPluginInstanceName()

Get the instance's particular name. Returns the name by which the class was chosen when this instance was created. Only works for instances created by PluginService, or if someone remembers to call setPluginName.

Useful when the implementation class wants to be configured differently when it is invoked under different names.

Returns:

name or null if not available.

setPluginInstanceName

void setPluginInstanceName(String name)

Set the name under which this plugin was instantiated. Not to be invoked by application code, it is called automatically by PluginService.getNamedPlugin() when the plugin is instantiated.

Parameters:

name - -- name used to select this class.