dev.dimlight.maven.plugin.shellcheck

Class Shellcheck.Result

java.lang.Object

dev.dimlight.maven.plugin.shellcheck.Shellcheck.Result

Enclosing class:

Shellcheck

public static class Shellcheck.Result
extends Object

The results of a shellcheck run.

Field Summary

Fields

Modifier and Type	Field and Description
List<String>	cmdLine The actual command line that was ran to execute shellcheck, as a list.
int	exitCode The os exit code for the shellcheck invocation.
String	runId Run id.
Path	stderr Path where the captured stderr has been redirected.
Path	stdout Path where the captured stdout has been redirected.

Constructor Summary

Constructors

Constructor and Description
Result(String runId, List<String> cmdLine, int exitCode, Path stdout, Path stderr)

Method Summary

Modifier and Type	Method and Description
boolean	isNotOk()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

runId

public final String runId

Run id. A label to discriminate different shellcheck runs.

cmdLine

public final List<String> cmdLine

The actual command line that was ran to execute shellcheck, as a list. The content of the list is made up of:

1. /the/path/to/shellcheck
2. the options
3. the actual file arguments

exitCode

public final int exitCode

The os exit code for the shellcheck invocation.

stdout

public final Path stdout

Path where the captured stdout has been redirected.

stderr

public final Path stderr

Path where the captured stderr has been redirected.

Constructor Detail

Result

public Result(String runId,
              List<String> cmdLine,
              int exitCode,
              Path stdout,
              Path stderr)

Parameters:

runId - the id of the run.

cmdLine - the cmd line of the run.

exitCode - the exit code of the shellcheck invocation.

stdout - the path where stdout has been redirected.

stderr - the path where stderr has been redirected.

Method Detail

isNotOk

public boolean isNotOk()

Returns:

true if the exit code is non-zero.