org.ametys.plugins.blog

Class BlogSiteEnumerator

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.plugins.blog.BlogSiteEnumerator

All Implemented Interfaces:

Enumerator, LogEnabled, Serviceable

public class BlogSiteEnumerator
extends AbstractLogEnabled
implements Serviceable, Enumerator<String>, Enumerator

Blog site enumerator.

Field Summary

Fields

Modifier and Type	Field and Description
protected SiteManager	_siteManager The site manager.
static String	BLOG_SITE_TYPE The blog site type.

Constructor Summary

Constructors

Constructor and Description
BlogSiteEnumerator()

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	getConfiguration() Get the configuration of this enumerator
Map<Object,I18nizableText>	getEntries() Provides the enumerated values with their optional label.
I18nizableText	getEntry(String value) Retrieves a single label from a value.
Map<String,I18nizableText>	getTypedEntries() Provides the enumerated values with their optional label.
void	service(ServiceManager manager)

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Field Detail

BLOG_SITE_TYPE

public static final String BLOG_SITE_TYPE

The blog site type.

See Also:

Constant Field Values

_siteManager

protected SiteManager _siteManager

The site manager.

Constructor Detail

BlogSiteEnumerator

public BlogSiteEnumerator()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

getEntries

public Map<Object,I18nizableText> getEntries()
                                      throws Exception

Description copied from interface: Enumerator

Provides the enumerated values with their optional label.

Specified by:

getEntries in interface Enumerator

Returns:

the enumerated values and their label.

Throws:

Exception - if an error occurs.

getTypedEntries

public Map<String,I18nizableText> getTypedEntries()
                                           throws Exception

Description copied from interface: Enumerator

Provides the enumerated values with their optional label.

Returns:

the enumerated values and their label.

Throws:

Exception - if an error occurs. TODO NEWATTRIBUTEAPI: rename this method when Enumerator will be removed

getEntry

public I18nizableText getEntry(String value)
                        throws Exception

Description copied from interface: Enumerator

Retrieves a single label from a value.

Specified by:

getEntry in interface Enumerator

Parameters:

value - the value.

Returns:

the label or null if not found.

Throws:

Exception - if an error occurs.

getConfiguration

public Map<String,Object> getConfiguration()

Description copied from interface: Enumerator

Get the configuration of this enumerator

Specified by:

getConfiguration in interface Enumerator

Returns:

the configuration