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 org.opencms.json.JSONArray;
031
032import javax.servlet.jsp.JspException;
033import javax.servlet.jsp.JspTagException;
034
035/**
036 * Tag for defining a JSON array.
037 *
038 * Values created by nested JSON tags will be added to the array.
039 */
040public class CmsJspTagJsonArray extends A_CmsJspJsonTag implements I_CmsJspJsonContext {
041
042    /** Serial version id. */
043    private static final long serialVersionUID = -5609309021078612934L;
044
045    /** The JSON array to build. */
046    private JSONArray m_jsonArray;
047
048    /**
049     * Default constructor explicitly resetting all variables.
050     */
051    public CmsJspTagJsonArray() {
052
053        init();
054    }
055
056    /**
057     * @see org.opencms.jsp.I_CmsJspJsonContext#addValue(java.lang.String, java.lang.Object)
058     */
059    public void addValue(String key, Object val) throws JspException {
060
061        if (key != null) {
062            throw new JspTagException("Can not add value to JSONArray with a key (key:" + key + ", val:" + val + ")");
063        }
064
065        m_jsonArray.put(val);
066
067    }
068
069    /**
070     * @see javax.servlet.jsp.tagext.BodyTagSupport#doStartTag()
071     */
072    @Override
073    public int doStartTag() {
074
075        m_jsonArray = new JSONArray();
076        return EVAL_BODY_INCLUDE;
077    }
078
079    /**
080     * @see org.opencms.jsp.A_CmsJspJsonTag#getJsonValue()
081     */
082    @Override
083    public Object getJsonValue() {
084
085        return m_jsonArray;
086    }
087
088    /**
089     * Initializes / resets the internal values.<p>
090     */
091    @Override
092    protected void init() {
093
094        super.init();
095        m_jsonArray = null;
096    }
097}