Package org.jibx.custom.classes

Class ClassItemSourceWrapper

  • All Implemented Interfaces:
    IClassItem
    public class ClassItemSourceWrapper
extends ClassItemWrapper
    Wrapper for class field or method item with added source information. This wraps the basic class handling implementation with added support for retrieving information from source files.
    Author:
    Dennis M. Sosnoski

    • Field Detail

      • m_checkedSource

        private boolean m_checkedSource

      • m_itemSource

        private Member m_itemSource

    • Constructor Detail

      • ClassItemSourceWrapper

        ClassItemSourceWrapper​(IClass clas,
                       ClassItem item)
        Constructor
        Parameters:
        clas -
        item -

    • Method Detail

      • matchSignature

        private boolean matchSignature​(JavaMethod method)
        Check for source method signature match.
        Parameters:
        method -
        Returns:
        true if match to this method, false if not

      • getItemSource

        private Member getItemSource()
        Internal method to get the source code information for this item.
        Returns:
        source information

      • docText

        private static java.lang.String docText​(java.lang.String text)
        Return JavaDoc text only if non-empty.
        Parameters:
        text - raw JavaDoc text
        Returns:
        trimmed text if non-empty, otherwise null

      • getJavaDoc

        public java.lang.String getJavaDoc()
        Description copied from interface: IClassItem
        Get item JavaDoc description, if available.
        Specified by:
        getJavaDoc in interface IClassItem
        Overrides:
        getJavaDoc in class ClassItemWrapper
        Returns:
        non-empty JavaDoc text (null if not available)

      • getParameterJavaDoc

        public java.lang.String getParameterJavaDoc​(int index)
        Description copied from interface: IClassItem
        Get method parameter JavaDoc description, if available. This method will throw a runtime exception if called on a field.
        Specified by:
        getParameterJavaDoc in interface IClassItem
        Overrides:
        getParameterJavaDoc in class ClassItemWrapper
        Parameters:
        index - parameter number
        Returns:
        non-empty JavaDoc text (null if not available)

      • getParameterName

        public java.lang.String getParameterName​(int index)
        Description copied from interface: IClassItem
        Get method parameter name, if available. This method will throw a runtime exception if called on a field.
        Specified by:
        getParameterName in interface IClassItem
        Overrides:
        getParameterName in class ClassItemWrapper
        Parameters:
        index - parameter number
        Returns:
        parameter name (null if not available)

      • getExceptionJavaDoc

        public java.lang.String getExceptionJavaDoc​(int index)
        Description copied from interface: IClassItem
        Get method throws JavaDoc description, if available. This method will throw a runtime exception if called on a field.
        Specified by:
        getExceptionJavaDoc in interface IClassItem
        Overrides:
        getExceptionJavaDoc in class ClassItemWrapper
        Parameters:
        index - exception index (into array returned by IClassItem.getExceptions()
        Returns:
        non-empty JavaDoc text (null if not available)