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.jsp;
029
030import javax.servlet.jsp.JspException;
031
032/**
033 * Interface implemented by JSON tags.
034 *
035 * <p>Used by nested tags to add values to the JSON being constructed.
036 */
037public interface I_CmsJspJsonContext {
038
039    /**
040     * Adds a value to the JSON value being constructed.
041     *
042     * <p>For a JSON object, the key must be not null, and for a JSON array, it must always be null.
043     *
044     * @param key the key (or null)
045     * @param val the value to add
046     *
047     * @throws JspException in case the value could not be added
048     */
049    void addValue(String key, Object val) throws JspException;
050
051}