JSONAble.java

/*
 * ModeShape (http://www.modeshape.org)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.modeshape.web.jcr.rest.model;

import org.codehaus.jettison.json.JSONException;
import org.codehaus.jettison.json.JSONObject;

/**
 * An interface which should be implemented by objects that provide a JSON (currently Jettison) implementation.
 * 
 * @author Horia Chiorean (hchiorea@redhat.com)
 */
public interface JSONAble {
    /**
     * Returns the JSON representation of this object.
     * 
     * @return a {@code non-null} {@link JSONObject}
     * @throws JSONException if conversion to JSON is not possible.
     */
    public JSONObject toJSON() throws JSONException;
}