org.ametys.plugins.core.ui.help

Class HelpSerializer

java.lang.Object

com.fasterxml.jackson.databind.JsonSerializer<T>

com.fasterxml.jackson.databind.ser.std.StdSerializer<HelpLink>

org.ametys.plugins.core.ui.help.HelpSerializer

All Implemented Interfaces:

JsonFormatVisitable, SchemaAware, Serializable, LogEnabled, Component, Contextualizable, Serviceable

public class HelpSerializer
extends StdSerializer<HelpLink>
implements Component, Serviceable, LogEnabled, Contextualizable

Serializer for HelpLink objects. Returns the help url for the right language, for JSON value.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.fasterxml.jackson.databind.JsonSerializer

JsonSerializer.None

Field Summary

Fields

Modifier and Type	Field and Description
private Context	_context
private HelpManager	_helpManager
private Logger	_logger
static String	ROLE The Avalon Role

Fields inherited from class com.fasterxml.jackson.databind.ser.std.StdSerializer

_handledType

Constructor Summary

Constructors

Constructor and Description
HelpSerializer() Constructor

Method Summary

Modifier and Type	Method and Description
private List<String>	_getLanguages(Request request)
void	contextualize(Context context)
void	serialize(HelpLink value, JsonGenerator gen, SerializerProvider provider)
void	service(ServiceManager manager)
void	setLogger(Logger logger) Called at creation time to provide a Logger.

Methods inherited from class com.fasterxml.jackson.databind.ser.std.StdSerializer

acceptJsonFormatVisitor, createObjectNode, createSchemaNode, createSchemaNode, findAnnotatedContentSerializer, findConvertingContentSerializer, findFormatFeature, findFormatOverrides, findIncludeOverrides, findPropertyFilter, getSchema, getSchema, handledType, isDefaultSerializer, visitArrayFormat, visitArrayFormat, visitFloatFormat, visitIntFormat, visitIntFormat, visitStringFormat, visitStringFormat, wrapAndThrow, wrapAndThrow

Methods inherited from class com.fasterxml.jackson.databind.JsonSerializer

getDelegatee, isEmpty, isEmpty, isUnwrappingSerializer, properties, replaceDelegatee, serializeWithType, unwrappingSerializer, usesObjectId, withFilterId

Methods inherited from class java.lang.Object

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

Field Detail

ROLE

public static final String ROLE

The Avalon Role

_logger

private Logger _logger

_helpManager

private HelpManager _helpManager

_context

private Context _context

Constructor Detail

HelpSerializer

public HelpSerializer()

Constructor

Method Detail

serialize

public void serialize(HelpLink value,
                      JsonGenerator gen,
                      SerializerProvider provider)
               throws IOException

Specified by:

serialize in class StdSerializer<HelpLink>

Throws:

IOException

setLogger

public void setLogger(Logger logger)

Description copied from interface: LogEnabled

Called at creation time to provide a Logger.

Specified by:

setLogger in interface LogEnabled

Parameters:

logger - a Logger for messages.

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

_getLanguages

private List<String> _getLanguages(Request request)