Convertor


1   /*
2    * Copyright 1999-2004 The Apache Software Foundation.
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.apache.cocoon.woody.datatype.convertor;
17  
18  import java.util.Locale  ;
19  
20  /**
21   * The purpose of a Convertor is to convert between Object and String
22   * representations of the same thing. For example, convert
23   * {@link Long}s or {@link java.util.Date Date}s to strings, and vice
24   * versa. The behaviour of this conversion process can depend on the
25   * user's Locale.
26   *
27   * <p>If you need to do mass conversion of a lot of values, it may be
28   * beneficial to pass a {@link FormatCache} object to the convert methods.
29   * Some convertors need to build and configure parser or formatting objects,
30   * which can be expensive if it needs to be done repeatedly.
31   *
32   * @version CVS $Id: Convertor.java 30932 2004-07-29 17:35:38Z vgritsenko $
33   */
34  public interface Convertor {
35      
36      /**
37       * Converts string representation into the object of convertor's type.
38       * Returns null if conversion fails.
39       *
40       * @param formatCache can be null if not needed
41       */
42      Object   convertFromString(String   value, Locale   locale, FormatCache formatCache);
43  
44      String   convertToString(Object   value, Locale   locale, FormatCache formatCache);
45  
46      Class   getTypeClass();
47  
48      public interface FormatCache {
49          public Object   get();
50          public void store(Object   object);
51      }
52  }
53
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags