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 Details

    • getOwningClass

      IClass getOwningClass()
      Get owning class information.
      Returns:
      owning class information
    • getName

      String getName()
      Get item name.
      Returns:
      item name
    • getJavaDoc

      String getJavaDoc()
      Get item JavaDoc description, if available.
      Returns:
      non-empty JavaDoc text (null if not available)
    • getTypeName

      String getTypeName()
      Get item type as fully qualified class name.
      Returns:
      item type name
    • getReturnJavaDoc

      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

      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

      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

      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

      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

      String[] getExceptions()
      Get names of exceptions thrown by method.
      Returns:
      array of exceptions thrown by method, or null if a field
    • getExceptionJavaDoc

      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 by getExceptions()
      Returns:
      non-empty JavaDoc text (null if not available)
    • getGenericsSignature

      String getGenericsSignature()
      Get the generics signature information for item.
      Returns:
      generics signature (null if none)