dexy : java filter

← Back to Filter List

java

Compiles java code and runs main method.

Aliases for this filter

java

Converts from file formats:

.java

To file formats:

.txt

Available settings:

Setting	Description	Default
add-new-files	Boolean or list of extensions/patterns to match.	False
added-in-version	Dexy version when this filter was first available.
additional-doc-filters	Filters to apply to additional documents created as side effects.	{}
additional-doc-settings	Settings to apply to additional documents created as side effects.	{}
args	Arguments to be passed to the executable.
check-return-code	Whether to look for nonzero return code.	True
clargs	Arguments to be passed to the executable (same as 'args').
classpath	Custom entries in classpath.	[]
command-string	The full command string.	%(prog)s %(args)s "%(script_file)s" %(scriptargs)s "%(output_file)s"
compiled-extension	Extension which compiled files end with.	.class
compiler-args	Args to pass to compiler.
compiler-command-string	Command string to call compiler.	%(prog)s %(compiler_args)s %(classpath)s %(script_file)s
data-type	Alias of custom data class to use to store filter output.	generic
env	Dictionary of key-value pairs to be added to environment for runs.	{}
examples	Templates which should be used as examples for this filter.	[]
exclude-add-new-files	List of patterns to skip even if they match add-new-files.	[]
exclude-new-files-from-dir	List of directories to skip when adding new files.	[]
executable	The executable to be run	javac
ext	File extension to output.	None
extension-map	Dictionary mapping input extensions to default output extensions.	None
help	Helpstring for plugin.	Compiles java code and runs main method.
initial-timeout		10
input-extensions	List of extensions which this filter can accept as input.	['.java']
keep-originals	Whether, if additional-doc-filters are specified, the original unmodified docs should also be added.	False
main	Main method.	None
make-dummy-output	Whether to make a dummy output file when one is not generated and add-new-files is True.	False
mkdir	A directory which should be created in working dir.	None
mkdirs	A list of directories which should be created in working dir.	[]
nodoc	Whether filter should be excluded from documentation.	False
output	Whether to output results of this filter by default by reporters such as 'output' or 'website'.	False
output-extensions	List of extensions which this filter can produce as output.	['.txt']
override-workspace-exclude-filters	If True, document will be populated to other workspaces ignoring workspace-exclude-filters.	False
path-extensions	strings to extend path with	[]
preserve-prior-data-class	Whether output data class should be set to match the input data class.	False
record-vars	Whether to add code that will automatically record values of variables.	False
require-output	Should dexy raise an exception if no output is produced by this filter?	True
scriptargs	Arguments to be passed to the executable.
tags	Tags which describe the filter.	['code', 'java', 'jvm', 'compiled']
timeout		10
use-wd	Whether to use a custom working directory when running filter.	True
variables	A dictionary of variable names and values to make available to this filter.	{}
vars	A dictionary of variable names and values to make available to this filter.	{}
version-command	Command to call to return version of installed software.	java -version
windows-version-command	Command to call on windows to return version of installed software.	None
workspace-exclude-filters	Filters whose output should be excluded from workspace.	['pyg']
workspace-includes	If set to a list of filenames or extensions, only these will be populated to working dir.	None
write-stderr-to-stdout	Should stderr be piped to stdout?	True

Filter Source Code

class JavaFilter(SubprocessCompileFilter):
    """
    Compiles java code and runs main method.
    """
    aliases = ['java']
    _settings = {
            'check-return-code' : True,
            'classpath' : ("Custom entries in classpath.", []),
            'tags' : ['code', 'java', 'jvm', 'compiled'],
            'executable' : 'javac',
            'input-extensions' : ['.java'],
            'output-extensions' : ['.txt'],
            'main' : ("Main method.", None),
            'version-command' : 'java -version',
            'compiled-extension' : ".class",
            'compiler-command-string' : "%(prog)s %(compiler_args)s %(classpath)s %(script_file)s"
            }

    def setup_cp(self):
        """
        Makes sure the current working directory is on the classpath, also adds
        any specified CLASSPATH elements. Assumes that CLASSPATH elements are either
        absolute paths, or paths relative to the artifacts directory. Also, if
        an input has been passed through the javac filter, its directory is
        added to the classpath.
        """
        self.log_debug("in setup_cp for %s" % self.key)

        classpath_elements = []

        working_dir = os.path.join(self.workspace(), self.output_data.parent_dir())
        abs_working_dir = os.path.abspath(working_dir)
        self.log_debug("Adding working dir %s to classpath" % abs_working_dir)
        classpath_elements.append(abs_working_dir)

        for doc in self.doc.walk_input_docs():
            if (doc.output_data().ext == ".class") and ("javac" in doc.key):
                classpath_elements.append(doc.output_data().parent_dir())

        for item in self.setting('classpath'):
            for x in item.split(":"):
                classpath_elements.append(x)

        env = self.setup_env()
        if env and 'CLASSPATH' in env:
            for x in env['CLASSPATH'].split(":"):
                classpath_elements.append(x)

        cp = ":".join(classpath_elements)
        self.log_debug("Classpath %s" % cp)
        return cp

    def compile_command_string(self):
        args = self.default_command_string_args()
        args['compiler_args'] = self.setting('compiler-args')

        # classpath
        cp = self.setup_cp()
        if len(cp) == 0:
            args['classpath'] = ''
        else:
            args['classpath'] = "-classpath %s" % cp

        return self.setting('compiler-command-string') % args

    def run_command_string(self):
        args = self.default_command_string_args()
        args['main_method'] = self.setup_main_method()

        # classpath
        cp = self.setup_cp()
        if len(cp) == 0:
            args['classpath'] = ''
        else:
            args['classpath'] = "-cp %s" % cp

        return "java %(args)s %(classpath)s %(main_method)s" % args

    def setup_main_method(self):
        basename = os.path.basename(self.input_data.name)
        default_main = os.path.splitext(basename)[0]
        if self.setting('main'):
            return self.setting('main')
        else:
            return default_main

java filter

java

Aliases for this filter

Converts from file formats:

To file formats:

Available settings:

Filter Source Code

How to

Contact Us

Quick Note

About Dexy

Dexy is a free-form literate documentation tool for writing any kind of technical document incorporating code. Dexy helps you write correct documents, and to easily maintain them over time as your code changes.

Latest News

From Twitter

Thanks To

Dexy Sponsors