/**
* Helios, OpenSource Monitoring
* Brought to you by the Helios Development Group
*
* Copyright 2007, Helios Development Group and individual contributors
* as indicated by the @author tags. See the copyright.txt file in the
* distribution for a full listing of individual contributors.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*
*/
package org.helios.apmrouter.metric;
import org.json.JSONException;
import org.json.JSONObject;
/**
* <p>Title: JSONFormatter</p>
* <p>Description: Defines a class that formats an array of {@link IMetric}s into a JSON document</p>
* <p>Company: Helios Development Group LLC</p>
* @author Whitehead (nwhitehead AT heliosdev DOT org)
* <p><code>org.helios.apmrouter.metric.JSONFormatter</code></p>
*/
public interface JSONFormatter {
/**
* Converts the passed metrics to a JSON Object
* @param metrics The metrics to format
* @return a compound JSON object
* @throws JSONException thrown on errors writing the json document
*/
public JSONObject toJSONObject(IMetric...metrics) throws JSONException;
/**
* Converts the passed metrics to a JSON string
* @param metrics The metrics to format
* @return a compound JSON string
* @throws JSONException thrown on errors writing the json document
*/
public String toJSON(IMetric...metrics) throws JSONException;
/**
* Converts the passed metrics to a JSON byte array
* @param metrics The metrics to format
* @return a compound JSON byet array
* @throws JSONException thrown on errors writing the json document
*/
public byte[] toJSONBytes(IMetric...metrics) throws JSONException;
}