org.gm4java.im4java

Class GMBatchCommand

java.lang.Object

org.im4java.process.ProcessStarter

org.im4java.core.ImageCommand

org.gm4java.im4java.GMBatchCommand

All Implemented Interfaces:

org.im4java.process.ErrorConsumer

public class GMBatchCommand
extends org.im4java.core.ImageCommand

This class wraps the GM command in interactive or batch mode.

Note: Does not support asynchronous mode; Does not support BufferedImage as output.

Author:

Kenneth Xu

Field Summary

Fields inherited from class org.im4java.process.ProcessStarter

BUFFER_SIZE

Constructor Summary

Constructors

Constructor and Description
GMBatchCommand(GMExecutor executor, String command) Construct a new instance of GMBatchCommand that uses given executor to execute specified command.

Method Summary

Methods

Modifier and Type	Method and Description
protected int	run(LinkedList<String> pArgs) This implementation uses GMExecutor to execute the command.
void	setErrorConsumer(org.im4java.process.ErrorConsumer pErrorConsumer)
void	setOutputConsumer(org.im4java.process.OutputConsumer pOutputConsumer)
void	setSearchPath(String pSearchPath) Deprecated.

Methods inherited from class org.im4java.core.ImageCommand

consumeError, createScript, createScript, createScript, finished, getCommand, getErrorText, getProcessTask, run, setCommand, setDefaultScriptGenerator, setScriptGenerator

Methods inherited from class org.im4java.process.ProcessStarter

addProcessEventListener, addProcessListener, finished, getGlobalSearchPath, getPID, getProcessTask, getSearchPath, isAsyncMode, removeProcessEventListener, searchForCmd, setAsyncMode, setGlobalSearchPath, setInputProvider, setPID, setPIDCounter

Methods inherited from class java.lang.Object

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

Constructor Detail

GMBatchCommand

public GMBatchCommand(@Nonnull
              GMExecutor executor,
              @Nonnull
              String command)

Construct a new instance of GMBatchCommand that uses given executor to execute specified command.

Parameters:

executor - executor to execute the command

command - command to be executed.

Method Detail

setOutputConsumer

public void setOutputConsumer(@Nonnull
                     org.im4java.process.OutputConsumer pOutputConsumer)

Overrides:

setOutputConsumer in class org.im4java.process.ProcessStarter

setErrorConsumer

public void setErrorConsumer(@Nonnull
                    org.im4java.process.ErrorConsumer pErrorConsumer)

Overrides:

setErrorConsumer in class org.im4java.process.ProcessStarter

run

protected int run(@Nonnull
      LinkedList<String> pArgs)
           throws Exception

This implementation uses GMExecutor to execute the command.

Overrides:

run in class org.im4java.process.ProcessStarter

Throws:

Exception

setSearchPath

@Deprecated
public void setSearchPath(String pSearchPath)

Deprecated.

Unlike other implementation of ImageCommand, GMBatchCommand uses GMExecutor instead of starting a new GraphicsMagick process. This makes setSearchPath(String) method useless. Calling this method always result in UnsupportedOperationException.

Overrides:

setSearchPath in class org.im4java.process.ProcessStarter

Parameters:

pSearchPath - not used