Package org.opencms.xml.xml2json.handler

Class CmsJsonHandlerList

java.lang.Object

org.opencms.xml.xml2json.handler.CmsJsonHandlerXmlContent

org.opencms.xml.xml2json.handler.CmsJsonHandlerList

All Implemented Interfaces:

I_CmsJsonHandler

public class CmsJsonHandlerList
extends CmsJsonHandlerXmlContent

JSON handler for rendering a list.

Nested Class Summary

Nested classes/interfaces inherited from class org.opencms.xml.xml2json.handler.CmsJsonHandlerXmlContent

CmsJsonHandlerXmlContent.PathNotFoundException

Field Summary

Fields inherited from class org.opencms.xml.xml2json.handler.CmsJsonHandlerXmlContent

PARAM_LOCALE, PARAM_PATH

Constructor Summary

Constructors

Constructor	Description
CmsJsonHandlerList()

Method Summary

Modifier and Type	Method	Description
double	getOrder()	Gets the sort order for this handler.
boolean	matches(CmsJsonHandlerContext context)	Returns true if the handler matches the given context.
CmsJsonResult	renderJson(CmsJsonHandlerContext context)	Renders the JSON.

Methods inherited from class org.opencms.xml.xml2json.handler.CmsJsonHandlerXmlContent

empty, renderJson

Methods inherited from class java.lang.Object

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

Constructor Detail

CmsJsonHandlerList

public CmsJsonHandlerList()

Method Detail

getOrder

public double getOrder()

Description copied from interface: I_CmsJsonHandler

Gets the sort order for this handler.

Handlers are sorted by ascending order, and the first matching handler is selected.

Specified by:

getOrder in interface I_CmsJsonHandler

Overrides:

getOrder in class CmsJsonHandlerXmlContent

Returns:

the sort order

See Also:

I_CmsJsonHandler.getOrder()

matches

public boolean matches(CmsJsonHandlerContext context)

Description copied from interface: I_CmsJsonHandler

Returns true if the handler matches the given context.

Specified by:

matches in interface I_CmsJsonHandler

Overrides:

matches in class CmsJsonHandlerXmlContent

Parameters:

context - the context

Returns:

true if the handler matches

See Also:

I_CmsJsonHandler.matches(org.opencms.xml.xml2json.handler.CmsJsonHandlerContext)

renderJson

public CmsJsonResult renderJson(CmsJsonHandlerContext context)

Description copied from interface: I_CmsJsonHandler

Renders the JSON.

Specified by:

renderJson in interface I_CmsJsonHandler

Overrides:

renderJson in class CmsJsonHandlerXmlContent

Parameters:

context - the context (provides information about the path and resource)

Returns:

the JSON result

See Also:

I_CmsJsonHandler.renderJson(org.opencms.xml.xml2json.handler.CmsJsonHandlerContext)