ConfigurationTypeHandler


1   /*
2    * The contents of this file are subject to the Sapient Public License
3    * Version 1.0 (the "License"); you may not use this file except in compliance
4    * with the License. You may obtain a copy of the License at
5    * http://carbon.sf.net/License.html.
6    *
7    * Software distributed under the License is distributed on an "AS IS" basis,
8    * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for
9    * the specific language governing rights and limitations under the License.
10   *
11   * The Original Code is The Carbon Component Framework.
12   *
13   * The Initial Developer of the Original Code is Sapient Corporation
14   *
15   * Copyright (C) 2003 Sapient Corporation. All Rights Reserved.
16   */
17  
18  package org.sape.carbon.core.config.type;
19  
20  /**
21   * <p>This interface provides for the basic functionality of reading
22   * and writing configuration elements from and two configuration storage
23   * mechanisms. This works with configuration types that use string-based
24   * formats as their underlying types.
25   * </p>
26   *
27   * Copyright 2002 Sapient
28   * @since carbon 1.0
29   * @author Greg Hinkle, January 2002
30   * @version $Revision: 1.12 $($Author: dvoet $ / $Date: 2003/05/05 21:21:20 $)
31   */
32  public interface ConfigurationTypeHandler {
33  
34      /**
35       * Translates the an Object into the string version of itself
36       * @param objectValue The object to be translated
37       * @return the string version of the object
38       */
39      String   toString(Object   objectValue);
40  
41      /**
42       * Translates the String representation of data in an object
43       * version
44       * @param returnType the type of the return value
45       * @param stringValue the string representation of the data
46       * @throws TypeConversionException when there is a formatting problem
47       *         with the supplied string data
48       * @return the object value of the data represented by the supplied
49       *         string
50       */
51      Object   toObject(Class   returnType, String   stringValue)
52          throws TypeConversionException;
53  
54  }
55
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags