KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > tapestry > form > translator > Translator


1 // Copyright 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.form.translator;
16
17 import org.apache.tapestry.form.IFormComponent;
18 import org.apache.tapestry.form.FormComponentContributor;
19 import org.apache.tapestry.valid.ValidatorException;
20
21 /**
22  * Interface used by {@link ValidatableField}s to both format an object as text and translate
23  * submitted text into an appropriate object for a given field.
24  *
25  * @author Paul Ferraro
26  * @since 4.0
27  */
28 public interface Translator extends FormComponentContributor
29 {
30     /**
31      * Invoked during rendering to format an object (which may be null) into a text value (which
32      * should not be null) appropriate for the specified field.
33      */
34     public String JavaDoc format(IFormComponent field, Object JavaDoc object);
35
36     /**
37      * Invoked during rewind to parse a submitted input value into an object suitable for the
38      * specified component.
39      *
40      * @return the parsed object
41      * @throws ValidatorException
42      * if the specified text could not be parsed into an object.
43      */
44     public Object JavaDoc parse(IFormComponent field, String JavaDoc value) throws ValidatorException;
45 }
46
Popular Tags