Interface ClassSource_Streamer


  • public interface ClassSource_Streamer

    Call back type for class source processing.

    • Method Detail

      • doProcess

        boolean doProcess​(java.lang.String className,
                          ClassSource_Aggregate.ScanPolicy scanPolicy)

        Tell if a specified class is to be scanned.

        Parameters:
        className - The name of the class to test.
        scanPolicy - The policy to test against.
        Returns:
        True if the class is to be processed. Otherwise, false.
      • process

        boolean process​(java.lang.String classSourceName,
                        java.lang.String className,
                        java.io.InputStream inputStream,
                        ClassSource_Aggregate.ScanPolicy scanPolicy)
                 throws ClassSource_Exception

        Process the data for the specified class.

        Parameters:
        classSourceName - The name of the class source which contains the class.
        className - The name of the class to process.
        inputStream - The stream containing the class data.
        scanPolicy - The policy active on the class.
        Returns:
        True if the class was processed. Otherwise, false.
        Throws:
        ClassSource_Exception - Thrown if an error occurred while testing the specified class.
      • supportsJandex

        boolean supportsJandex()

        Tell if this streamer supports the processing of JANDEX class information.

        Returns:
        True or false telling if this streamer supports the processing of JANDEX class information.
      • process

        boolean process​(java.lang.String classSourceName,
                        java.lang.Object jandexClassInfo,
                        ClassSource_Aggregate.ScanPolicy scanPolicy)
                 throws ClassSource_Exception

        Process the data for the specified class.

        Parameters:
        classSourceName - The name of the class source which contains the class.
        className - The name of the class to process.
        jandexClassInfo - JANDEX class information for the class. Note: Type is Object because we can't expose org.jboss.jandex.ClassInfo in SPI.
        scanPolicy - The policy active on the class.
        Returns:
        True if the class was processed. Otherwise, false.
        Throws:
        ClassSource_Exception - Thrown if an error occurred while testing the specified class.