Package adams.flow.control

Class JDeps

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ErrorHandler, InputConsumer, OutputProducer, Serializable, Comparable
    public class JDeps
extends AbstractTransformer
    Runs jdeps on the classname arriving at the input.
    The application's classpath is automatically added to the command-line if no classpath directories or jars are provided.
    Classpath directories and jars get combined, but directories take precedence over jars.

    Input/output:
    - accepts:
       java.lang.String
    - generates:
       java.lang.String


    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -name <java.lang.String> (property: name)
    The name of the actor.
    default: JDeps
 
    -annotation <adams.core.base.BaseAnnotation> (property: annotations)
    The annotations to attach to this actor.
    default: 
 
    -skip <boolean> (property: skip)
    If set to true, transformation is skipped and the input token is just forwarded 
    as it is.
    default: false
 
    -stop-flow-on-error <boolean> (property: stopFlowOnError)
    If set to true, the flow execution at this level gets stopped in case this 
    actor encounters an error; the error gets propagated; useful for critical 
    actors.
    default: false
 
    -silent <boolean> (property: silent)
    If enabled, then no errors are output in the console; Note: the enclosing 
    actor handler must have this enabled as well.
    default: false
 
    -executable <adams.core.io.PlaceholderFile> (property: executable)
    The full path to the jdeps executable.
 
    -classpath-dir <adams.core.io.PlaceholderDirectory> [-classpath-dir ...] (property: classpathDirs)
    The directories to use instead of the application's classpath.
    default: 
 
    -classpath-jar <adams.core.io.PlaceholderFile> [-classpath-jar ...] (property: classpathJars)
    The jars to use instead of the application's classpath.
    default: 
 
    -additional <java.lang.String> (property: additionalOptions)
    Additional options for the jdeps execution, supports inline variables.
    default:
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Executable

        protected PlaceholderFile m_Executable
        the jdeps executable.

      • m_ClasspathJars

        protected PlaceholderFile[] m_ClasspathJars
        the classpath jars.

      • m_AdditionalOptions

        protected String m_AdditionalOptions
        additional options for jdeps.

    • Constructor Detail

      • JDeps

        public JDeps()

    • Method Detail

      • getJDepsExecutablePath

        protected String getJDepsExecutablePath()
        Returns the full path of the JDeps executable, if possible.
        Returns:
        the full path of the executable if possible, otherwise just the executable

      • setExecutable

        public void setExecutable​(PlaceholderFile value)
        Sets the jdeps executable.
        Parameters:
        value - the executable

      • getExecutable

        public PlaceholderFile getExecutable()
        Returns the jdeps executable.
        Returns:
        the executable

      • executableTipText

        public String executableTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setClasspathDirs

        public void setClasspathDirs​(PlaceholderDirectory[] value)
        Sets the classpath directories to use instead of the application's classpath.
        Parameters:
        value - the directories

      • getClasspathDirs

        public PlaceholderDirectory[] getClasspathDirs()
        Returns the classpath directories to use instead of the application's classpath.
        Returns:
        the directories

      • classpathDirsTipText

        public String classpathDirsTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setClasspathJars

        public void setClasspathJars​(PlaceholderFile[] value)
        Sets the classpath jars to use instead of the application's classpath.
        Parameters:
        value - the jars

      • getClasspathJars

        public PlaceholderFile[] getClasspathJars()
        Returns the classpath jars to use instead of the application's classpath.
        Returns:
        the jars

      • classpathJarsTipText

        public String classpathJarsTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setAdditionalOptions

        public void setAdditionalOptions​(String value)
        Sets the additional options for jdeps.
        Parameters:
        value - the additional options

      • getAdditionalOptions

        public String getAdditionalOptions()
        Returns the additional options for jdeps.
        Returns:
        the additional options

      • additionalOptionsTipText

        public String additionalOptionsTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • canRunJDeps

        protected boolean canRunJDeps()
        Returns whether jdeps can be run.
        Returns:
        true if jdeps can be executed

      • accepts

        public Class[] accepts()
        Returns the class that the consumer accepts.
        Returns:
        the Class of objects that can be processed

      • generates

        public Class[] generates()
        Returns the class of objects that it generates.
        Returns:
        the Class of the generated tokens

      • doExecute

        protected String doExecute()
        Executes the flow item.
        Specified by:
        doExecute in class AbstractActor
        Returns:
        null if everything is fine, otherwise error message