001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * For further information about Alkacon Software, please see the
018 * company website: http://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: http://www.opencms.org
022 *
023 * You should have received a copy of the GNU Lesser General Public
024 * License along with this library; if not, write to the Free Software
025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
026 */
027
028package org.opencms.xml.xml2json.handler;
029
030import org.opencms.xml.xml2json.CmsJsonResult;
031
032/**
033 * Interface for individual JSON handlers.
034 *
035 * <p>The CmsJsonResourceHandler delegates the actual work of producing the JSON to a number of sub-handlers,
036 * e.g. one for XML contents, one for folders, etc. This is the base interface for these sub-handlers. Handlers are explicitly
037 * sorted by their order, and then the first matching handler is selected.
038 *
039 */
040public interface I_CmsJsonHandler {
041
042    /**
043     * Gets the sort order for this handler.<p>
044     *
045     * Handlers are sorted by ascending order, and the first matching handler is selected.
046     *
047     * @return the sort order
048     */
049    double getOrder();
050
051    /**
052     * Returns true if the handler matches the given context.
053     *
054     * @param context the context
055     * @return true if the handler matches
056     */
057    boolean matches(CmsJsonHandlerContext context);
058
059    /**
060     * Renders the JSON.
061     *
062     * @param context the context (provides information about the path and resource)
063     * @return the JSON result
064     */
065    CmsJsonResult renderJson(CmsJsonHandlerContext context);
066
067}