Package org.jibx.util
Interface IClassItem
-
- All Known Implementing Classes:
ClassItemSourceWrapper
,ClassItemWrapper
public interface IClassItem
Interface for field or method information. Provides the information needed for access to the item.- Version:
- 1.0
- Author:
- Dennis M. Sosnoski
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description int
getAccessFlags()
Get access flags.int
getArgumentCount()
Get number of arguments for method.java.lang.String
getArgumentType(int index)
Get argument type as fully qualified class name.java.lang.String
getExceptionJavaDoc(int index)
Get method throws JavaDoc description, if available.java.lang.String[]
getExceptions()
Get names of exceptions thrown by method.java.lang.String
getGenericsSignature()
Get the generics signature information for item.java.lang.String
getJavaDoc()
Get item JavaDoc description, if available.java.lang.String
getName()
Get item name.IClass
getOwningClass()
Get owning class information.java.lang.String
getParameterJavaDoc(int index)
Get method parameter JavaDoc description, if available.java.lang.String
getParameterName(int index)
Get method parameter name, if available.java.lang.String
getReturnJavaDoc()
Get return JavaDoc description for method, if available.java.lang.String
getSignature()
Get field or method signature.java.lang.String
getTypeName()
Get item type as fully qualified class name.boolean
isInitializer()
Check if item is an initializer.boolean
isMethod()
Check if item is a method.
-
-
-
Method Detail
-
getOwningClass
IClass getOwningClass()
Get owning class information.- Returns:
- owning class information
-
getName
java.lang.String getName()
Get item name.- Returns:
- item name
-
getJavaDoc
java.lang.String getJavaDoc()
Get item JavaDoc description, if available.- Returns:
- non-empty JavaDoc text (
null
if not available)
-
getTypeName
java.lang.String getTypeName()
Get item type as fully qualified class name.- Returns:
- item type name
-
getReturnJavaDoc
java.lang.String getReturnJavaDoc()
Get return JavaDoc description for method, if available.- Returns:
- non-empty JavaDoc text (
null
if not available)
-
getArgumentCount
int getArgumentCount()
Get number of arguments for method.- Returns:
- argument count for method, or
-1
if not a method
-
getArgumentType
java.lang.String getArgumentType(int index)
Get argument type as fully qualified class name. This method will throw a runtime exception if called on a field.- Parameters:
index
- argument number- Returns:
- argument type name
-
getParameterName
java.lang.String getParameterName(int index)
Get method parameter name, if available. This method will throw a runtime exception if called on a field.- Parameters:
index
- parameter number- Returns:
- parameter name (
null
if not available)
-
getParameterJavaDoc
java.lang.String getParameterJavaDoc(int index)
Get method parameter JavaDoc description, if available. This method will throw a runtime exception if called on a field.- Parameters:
index
- parameter number- Returns:
- non-empty JavaDoc text (
null
if not available)
-
getAccessFlags
int getAccessFlags()
Get access flags.- Returns:
- flags for access type of field or method
-
getSignature
java.lang.String getSignature()
Get field or method signature.- Returns:
- encoded method signature
-
isMethod
boolean isMethod()
Check if item is a method.- Returns:
true
if a method,false
if a field
-
isInitializer
boolean isInitializer()
Check if item is an initializer.- Returns:
true
if an initializer,false
if a field or normal method
-
getExceptions
java.lang.String[] getExceptions()
Get names of exceptions thrown by method.- Returns:
- array of exceptions thrown by method, or
null
if a field
-
getExceptionJavaDoc
java.lang.String getExceptionJavaDoc(int index)
Get method throws JavaDoc description, if available. This method will throw a runtime exception if called on a field.- Parameters:
index
- exception index (into array returned bygetExceptions()
- Returns:
- non-empty JavaDoc text (
null
if not available)
-
getGenericsSignature
java.lang.String getGenericsSignature()
Get the generics signature information for item.- Returns:
- generics signature (
null
if none)
-
-