KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > tapestry > util > io > ISqueezeAdaptor


1 // Copyright 2004, 2005 The Apache Software Foundation
2
//
3
// Licensed under the Apache License, Version 2.0 (the "License");
4
// you may not use this file except in compliance with the License.
5
// You may obtain a copy of the License at
6
//
7
// http://www.apache.org/licenses/LICENSE-2.0
8
//
9
// Unless required by applicable law or agreed to in writing, software
10
// distributed under the License is distributed on an "AS IS" BASIS,
11
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
// See the License for the specific language governing permissions and
13
// limitations under the License.
14

15 package org.apache.tapestry.util.io;
16
17 import java.io.IOException JavaDoc;
18
19 import org.apache.tapestry.services.DataSqueezer;
20
21 /**
22  * Interface which defines a class used to convert data for a specific Java type
23  * into a String format (squeeze it), or convert from a String back into a Java
24  * type (unsqueeze).
25  *
26  * <p>
27  * This interface is somewhat misnamed; this is more of the GoF Strategy pattern
28  * than GoF Adaptor pattern.
29  *
30  * @author Howard Lewis Ship
31  *
32  */

33
34 public interface ISqueezeAdaptor
35 {
36     /**
37      * Converts the data object into a String.
38      *
39      * @throws IOException
40      * if the object can't be converted.
41      */

42
43     public String JavaDoc squeeze(DataSqueezer squeezer, Object JavaDoc data) throws IOException JavaDoc;
44
45     /**
46      * Converts a String back into an appropriate object.
47      *
48      * @throws IOException
49      * if the String can't be converted.
50      */

51
52     public Object JavaDoc unsqueeze(DataSqueezer squeezer, String JavaDoc string) throws IOException JavaDoc;
53
54     /**
55      * Invoked to ask an adaptor to register itself to the squeezer.
56      */

57
58     public void register(DataSqueezer squeezer);
59 }
Popular Tags