KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > directwebremoting > extend > Converter


1 /*
2  * Copyright 2005 Joe Walker
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 package org.directwebremoting.extend;
17
18 /**
19  * An interface for converting types from a string to some other type.
20  * @author Joe Walker [joe at getahead dot ltd dot uk]
21  */
22 public interface Converter
23 {
24     /**
25      * If we are a compound converter that farms out part of the conversion
26      * to other converters then you farm the conversion out via a configuration.
27      * @param config The confiuration object
28      */
29     void setConverterManager(ConverterManager config);
30
31     /**
32      * Attempt to coerce the data from a string to an Object.
33      * If anything goes wrong with inbound conversion then we generally throw
34      * an exception because we are converting data from the untrusted internet
35      * so we take the assumption that anything wrong is someone hacking.
36      * @param paramType The type to convert to
37      * @param data The data to convert
38      * @param inctx The map of data that we are working on
39      * @return The convered data, or null if the conversion was not possible
40      * @throws MarshallException If the conversion failed for some reason
41      */
42     Object JavaDoc convertInbound(Class JavaDoc paramType, InboundVariable data, InboundContext inctx) throws MarshallException;
43
44     /**
45      * Return a javascript string that defines the variable named varName to
46      * have the contents of the converted object data.
47      * <p>In contrast to <code>convertInbound()</code> failures in converting
48      * data on the way out should not stop processing, and we should carry on
49      * if we can. Failures are probably down to some misconfiguration so as much
50      * information about the error as can be safely generated to console logs is
51      * good. In other words if you need to loop in outbound conversion then it
52      * might be a good idea to catch issues inside the loop, log, and carry on.
53      * @param data The data to convert
54      * @param outctx A collection of objects already converted and the results
55      * @return The OutboundVariable that represents the data to convert
56      * @throws MarshallException If the conversion failed for some reason
57      */
58     OutboundVariable convertOutbound(Object JavaDoc data, OutboundContext outctx) throws MarshallException;
59 }
60
Popular Tags