Package org.opencms.xml.xml2json.handler

Class CmsJsonHandlerFolder

java.lang.Object

org.opencms.xml.xml2json.handler.CmsJsonHandlerFolder

All Implemented Interfaces:

I_CmsJsonHandler

public class CmsJsonHandlerFolder
extends Object
implements I_CmsJsonHandler

Produces directory listings in JSON format.

Constructor Summary

Constructors

Constructor	Description
CmsJsonHandlerFolder()

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 java.lang.Object

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

Constructor Details

CmsJsonHandlerFolder

public CmsJsonHandlerFolder()

Method Details

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

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

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

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)