1 /*
2 * Copyright 2002-2009 the original author or authors.
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17 package net.sf.json.processors;
18
19 import net.sf.json.JSONException;
20 import net.sf.json.JSONObject;
21 import net.sf.json.JsonConfig;
22
23 /**
24 * Base interface for custom serialization per Bean.
25 *
26 * @author Andres Almiray <aalmiray@users.sourceforge.net>
27 */
28 public interface JsonBeanProcessor {
29 /**
30 * Processes the bean an returns a suitable JSONObject representation.
31 *
32 * @param bean the input bean
33 * @param jsonConfig the current configuration environment
34 * @return a JSONObject that represents the input bean
35 * @throws JSONException if an error occurs during transformation
36 */
37 JSONObject processBean( Object bean, JsonConfig jsonConfig );
38 }