CLI (FlowPDF Groovy Library 1.1.2.0 API)

com.cloudbees.flowpdf.components.cli.CLI

CLI is an Component that is responsible for command-line execution.

Properties Summary

Properties
Type	Name and description
`static FWLog`	`logger`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`Component`	`init(java.util.Map<java.lang.String, java.lang.Object> configuration, FlowPlugin plugin)` Method is used to configure the component.
	`boolean`	`isEFComponent()` Flag method that shows this component requires FlowPlugin instance on initialization.
	`static boolean`	`isWindows()` Checks if current OS is Windows.
	`Command`	`newCommand(java.lang.String program)` Creates new Command instance
	`Command`	`newCommand(java.lang.String program, java.lang.String... args)` Creates new Command instance
	`Command`	`newCommand(java.lang.String program, java.util.ArrayList<java.lang.String> args)` Creates new Command instance
	`ExecutionResult`	`runCommand(Command command)` Shortcut for a Command.run.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Component`	`init, isEFComponent`
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Property Detail
  - @groovy.lang.Lazy static FWLog logger
- Method Detail
  - @java.lang.Override Component init(@org.jetbrains.annotations.NotNull java.util.Map<java.lang.String, java.lang.Object> configuration, FlowPlugin plugin)
    
    Method is used to configure the component.
    Parameters:
    configuration
    plugin
    Returns:
  - boolean isEFComponent()
    
    Flag method that shows this component requires FlowPlugin instance on initialization.
  - static boolean isWindows()
    
    Checks if current OS is Windows.
    Returns:
    true if current OS is Windows
  - Command newCommand(java.lang.String program)
    
    Creates new Command instance
    Parameters:
    program - name of the program to be executed
    Returns:
    Command
  - Command newCommand(java.lang.String program, java.lang.String... args)
    
    Creates new Command instance
    Parameters:
    program - name of the program to be executed
    args - arguments for the program as a String array (variable-length args)
    Returns:
    Command
  - Command newCommand(java.lang.String program, java.util.ArrayList<java.lang.String> args)
    
    Creates new Command instance
    Parameters:
    program - name of the program to be executed
    args - arguments for the program as a List of strings
    Returns:
    Command
  - ExecutionResult runCommand(Command command)
    
    Shortcut for a Command.run.
    throws:
    IOException if system returned error for executing the program
    
    Parameters:
    command - preconfigured Command instance
    Returns:
    ExecutionResult instance.

Summary:
Property
Method

| Detail:
Property
Method

Groovy Documentation

[Groovy] Class CLI

Properties Summary

Methods Summary

Inherited Methods Summary

Property Detail

@groovy.lang.Lazy static FWLog logger

Method Detail

@java.lang.Override Component init(@org.jetbrains.annotations.NotNull java.util.Map<java.lang.String, java.lang.Object> configuration, FlowPlugin plugin)

boolean isEFComponent()

static boolean isWindows()

Command newCommand(java.lang.String program)

Command newCommand(java.lang.String program, java.lang.String... args)

Command newCommand(java.lang.String program, java.util.ArrayList<java.lang.String> args)

ExecutionResult runCommand(Command command)