KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > tools > ant > taskdefs > optional > jmx > converter > ValueConverter


1 package org.apache.tools.ant.taskdefs.optional.jmx.converter;
2
3 /*
4  * ============================================================================
5  * The Apache Software License, Version 1.1
6  * ============================================================================
7  *
8  * Copyright (C) 2000-2002 The Apache Software Foundation. All
9  * rights reserved.
10  *
11  * Redistribution and use in source and binary forms, with or without modifica-
12  * tion, are permitted provided that the following conditions are met:
13  *
14  * 1. Redistributions of source code must retain the above copyright notice,
15  * this list of conditions and the following disclaimer.
16  *
17  * 2. Redistributions in binary form must reproduce the above copyright notice,
18  * this list of conditions and the following disclaimer in the documentation
19  * and/or other materials provided with the distribution.
20  *
21  * 3. The end-user documentation included with the redistribution, if any, must
22  * include the following acknowledgment: "This product includes software
23  * developed by the Apache Software Foundation (http://www.apache.org/)."
24  * Alternately, this acknowledgment may appear in the software itself, if
25  * and wherever such third-party acknowledgments normally appear.
26  *
27  * 4. The names "Ant" and "Apache Software Foundation" must not be used to
28  * endorse or promote products derived from this software without prior
29  * written permission. For written permission, please contact
30  * apache@apache.org.
31  *
32  * 5. Products derived from this software may not be called "Apache", nor may
33  * "Apache" appear in their name, without prior written permission of the
34  * Apache Software Foundation.
35  *
36  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
37  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
38  * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
39  * APACHE SOFTWARE FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
40  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLU-
41  * DING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
42  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
43  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
44  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
45  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
46  *
47  * This software consists of voluntary contributions made by many individuals
48  * on behalf of the Apache Software Foundation. For more information on the
49  * Apache Software Foundation, please see <http://www.apache.org/>.
50  *
51  */
52
53
54
55 /**
56  * Objects that implement this interface are capable of converting a
57  * java.lang.String value into an equivalent value object of a given type.
58  *
59  * ValueConverter implementations register themselves with the ValueFactory class
60  * which is in turn called by various JMX Ant tasks to get/set MBean attributes.
61  *
62  * The ValueFactory is responsible for calling the appropriate
63  * ValueConverter to create an Object based on the types the builder supports.
64  *
65  * @author <a HREF="mailto:bdueck@yahoo.com">Brian Dueck</a>
66  * @version $Id: ValueConverter.java,v 1.3 2003/05/28 22:28:26 bdueck Exp $
67  */
68 public interface ValueConverter {
69  
70     /**
71      * Returns an array of types (Java class names, or Java primitives)
72      * this converter supports.
73      *
74      * @return An array of supported type names.
75      */
76     public String JavaDoc[] getSupportedTypes();
77         
78     /**
79      * Converts the specified string value to the specified type (java primitive type
80      * or java class name).
81      *
82      * @param value The attribute value.
83      * @param type The java primitive type or class name.
84      * @returns The value in a class specified by the type parameter.
85      */
86     public Object JavaDoc valueOf(String JavaDoc value, String JavaDoc type) throws Exception JavaDoc;
87     
88 }
89
90 /*
91  * $Log: ValueConverter.java,v $
92  * Revision 1.3 2003/05/28 22:28:26 bdueck
93  * *** empty log message ***
94  *
95  * Revision 1.2 2003/04/21 15:29:45 bdueck
96  * Various changes in preparation for version 1.2.
97  *
98  *
99  */
Popular Tags