KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jibx > binding > model > IClassItem


1 /*
2 Copyright (c) 2004-2005, Dennis M. Sosnoski
3 All rights reserved.
4
5 Redistribution and use in source and binary forms, with or without modification,
6 are permitted provided that the following conditions are met:
7
8  * Redistributions of source code must retain the above copyright notice, this
9    list of conditions and the following disclaimer.
10  * Redistributions in binary form must reproduce the above copyright notice,
11    this list of conditions and the following disclaimer in the documentation
12    and/or other materials provided with the distribution.
13  * Neither the name of JiBX nor the names of its contributors may be used
14    to endorse or promote products derived from this software without specific
15    prior written permission.
16
17 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
18 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
21 ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
24 ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
26 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29 package org.jibx.binding.model;
30
31 /**
32  * Interface for field or method information. Provides the information needed
33  * for access to the item.
34  *
35  * @author Dennis M. Sosnoski
36  * @version 1.0
37  */
38
39 public interface IClassItem
40 {
41     /**
42      * Get owning class information.
43      *
44      * @return owning class information
45      */
46     public IClass getOwningClass();
47     
48     /**
49      * Get item name.
50      *
51      * @return item name
52      */
53     public String JavaDoc getName();
54     
55     /**
56      * Get item type as fully qualified class name.
57      *
58      * @return item type name
59      */
60     public String JavaDoc getTypeName();
61     
62     /**
63      * Get number of arguments for method.
64      *
65      * @return argument count for method, or <code>-1</code> if not a method
66      */
67     public int getArgumentCount();
68     
69     /**
70      * Get argument type as fully qualified class name. This method will throw a
71      * runtime exception if called on a field.
72      *
73      * @param index argument number
74      * @return argument type name
75      */
76     public String JavaDoc getArgumentType(int index);
77     
78     /**
79      * Get access flags.
80      *
81      * @return flags for access type of field or method
82      */
83     public int getAccessFlags();
84     
85     /**
86      * Get field or method signature.
87      *
88      * @return encoded method signature
89      */
90     public String JavaDoc getSignature();
91     
92     /**
93      * Check if item is a method.
94      *
95      * @return <code>true</code> if a method, <code>false</code> if a field
96      */
97     public boolean isMethod();
98     
99     /**
100      * Check if item is an initializer.
101      *
102      * @return <code>true</code> if an initializer, <code>false</code> if a
103      * field or normal method
104      */
105     public boolean isInitializer();
106     
107     /**
108      * Get names of exceptions thrown by method. This method will throw a
109      * runtime exception if called on a field.
110      *
111      * @return array of exceptions thrown by method, or <code>null</code> if
112      * a field
113      */
114     public String JavaDoc[] getExceptions();
115 }
Popular Tags