Command (FlowPDF Groovy Library 1.1.2.0 API)

com.cloudbees.flowpdf.components.cli.Command

This class represents a system command that is being used by CLI.

Field Summary

Fields
Modifiers	Name	Description
`java.util.ArrayList<java.lang.String>`	`args`	Arguments for the program.
`java.lang.String`	`program`	Name of the program to run.
`long`	`timeout`	Default timeout is set to 300 seconds (5 minutes)
`java.io.File`	`workingDirectory`	Working directory for the program.

Properties Summary

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

Constructor Summary

Constructors
Constructor and description
`Command (java.util.Map<java.lang.String, java.io.Serializable> initArgs)` Constructor.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`addArguments(java.lang.String... newArgs)` Adds new arguments to the command.
	`void`	`addArguments(java.util.List<java.lang.String> newArgs)` Adds new arguments to the command.
	`long`	`getTimeout()` Returns current value for the command timeout
	`java.lang.ProcessBuilder`	`renderCommand()` Builds a ProcessBuilder for given program and arguments.
	`ExecutionResult`	`run()` Renders a Command to a ProcessBuilder and executes it.
	`void`	`setTimeout(long timeout)` Sets new value value for the command timeout

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`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()`

- Field Detail
  - public java.util.ArrayList<java.lang.String> args
    
    Arguments for the program.
  - public java.lang.String program
    
    Name of the program to run.
  - public long timeout
    
    Default timeout is set to 300 seconds (5 minutes)
  - public java.io.File workingDirectory
    
    Working directory for the program.
- Property Detail
  - @groovy.lang.Lazy static FWLog logger
- Constructor Detail
  - Command(java.util.Map<java.lang.String, java.io.Serializable> initArgs)
    
    Constructor.
    Parameters:
    initArgs - Map of the initialization parameters
- Method Detail
  - void addArguments(java.lang.String... newArgs)
    
    Adds new arguments to the command.
    Parameters:
    newArgs - array of arguments
  - void addArguments(java.util.List<java.lang.String> newArgs)
    
    Adds new arguments to the command.
    Parameters:
    newArgs - array of arguments in a list
  - long getTimeout()
    
    Returns current value for the command timeout
  - java.lang.ProcessBuilder renderCommand()
    
    Builds a ProcessBuilder for given program and arguments.
    Returns:
    ProcessBuilder instance that can be used to repeatedly run a program with specified arguments.
  - ExecutionResult run()
    
    Renders a Command to a ProcessBuilder and executes it.
    throws:
    IOException if system returned error for executing the program
    
    Parameters:
    command - preconfigured Command instance
    Returns:
    ExecutionResult instance.
  - void setTimeout(long timeout)
    
    Sets new value value for the command timeout
    Parameters:
    timeout - value in milliseconds

Summary:
Field
Property
Constructor
Method

Groovy Documentation

[Groovy] Class Command

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

public java.util.ArrayList<java.lang.String> args

public java.lang.String program

public long timeout

public java.io.File workingDirectory

Property Detail

@groovy.lang.Lazy static FWLog logger

Constructor Detail

Command(java.util.Map<java.lang.String, java.io.Serializable> initArgs)

Method Detail

void addArguments(java.lang.String... newArgs)

void addArguments(java.util.List<java.lang.String> newArgs)

long getTimeout()

java.lang.ProcessBuilder renderCommand()

ExecutionResult run()

void setTimeout(long timeout)