View Javadoc

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.JsonConfig;
21  
22  /**
23   * Base interface for custom serialization per property.
24   *
25   * @author Andres Almiray <aalmiray@users.sourceforge.net>
26   */
27  public interface JsonValueProcessor {
28     /**
29      * Processes the value an returns a suitable JSON value.
30      *
31      * @param value the input value
32      * @return a valid JSON value that represents the input value
33      * @throws JSONException if an error occurs during transformation
34      */
35     Object processArrayValue( Object value, JsonConfig jsonConfig );
36  
37     /**
38      * Processes the value an returns a suitable JSON value.
39      *
40      * @param key the name of the property
41      * @param value the value of the property
42      * @return a valid JSON value that represents the input property
43      * @throws JSONException if an error occurs during transformation
44      */
45     Object processObjectValue( String key, Object value, JsonConfig jsonConfig );
46  }