Operation.java

package net.sourceforge.dita4publishers.tools.imaging.im;

import java.util.LinkedList;
import java.util.List;

/**
 * This class models the command-line of an image-command. Objects of this class
 * hold the arguments in a list and keep track of special "dynamic" operations.
 */

public class Operation
{

  /**
   * Placeholder-string for images.
   */
  public final static String IMG_PLACEHOLDER = "?img?";

  /**
   * Placeholder-string for dynamic operations.
   */

  final static String DOP_PLACEHOLDER = "?dop?";

  /**
   * The list of command-line arguments.
   */
  LinkedList<String> iCmdArgs = null;

  /**
   * DynamicOperations for this Operation.
   */
  private LinkedList<DynamicOperation> iDynamicOperations = null;

  
  /**
   *
   */
  public Operation()
  {
    iCmdArgs = new LinkedList<String>();
    iDynamicOperations = new LinkedList<DynamicOperation>();
  }

  
  /**
   * Convert to String. Note that the arguments are not quoted!
   */
  public String toString()
  {
    StringBuffer buf = new StringBuffer();
    for (String arg : iCmdArgs)
    {
      buf.append(arg).append(" ");
    }
    return buf.toString();
  }
  

  /**
   * Clone the (java) object. Note that ImageMagick has a -clone operator,
   * therefore this class has a method clone() (inherited from Core) which does
   * not clone the java-object, but wraps the IM-clone operator!
   */
  public Operation cloneObject()
  {
    Operation op = new Operation();
    op.getCmdArgs().addAll(iCmdArgs);
    return op;
  }

  
  /**
   * Add raw text to the list of arguments.
   */
  public Operation addRawArgs(
    String... pArgs)
  {
    for (String arg : pArgs)
    {
      iCmdArgs.add(arg);
    }
    return this;
  }

  
  /**
   * Add raw text to the list of arguments.
   */
  public Operation addRawArgs(
    List<String> pArgs)
  {
    iCmdArgs.addAll(pArgs);
    return this;
  }

  
  /**
   * Return the raw arguments.
   */
  public LinkedList<String> getCmdArgs()
  {
    return iCmdArgs;
  }
  

  /**
   * Add image(s) to the operation.
   */
  public Operation addImage(
    String... pImages)
  {
    for (String img : pImages)
    {
      if (img != null)
      {
        iCmdArgs.add(img);
      }
    }
    return this;
  }

  
  /**
   * Add an image-placeholder to an Operation.
   */
  public Operation addImage()
  {
    return addImage(1);
  }

  
  /**
   * Add multiple image-placeholders to an Operation.
   */
  public Operation addImage(
    int n)
  {
    for (int i = 0; i < n; ++i)
    {
      iCmdArgs.add(IMG_PLACEHOLDER);
    }
    return this;
  }

  
  /**
   * Add an Operation.
   */
  public Operation addOperation(
    Operation pOperation)
  {
    return addRawArgs(pOperation.getCmdArgs());
  }

  
  /**
   * Add a DynamicOperation to this Operation. We just save the DynamicOperation
   * in the internal list and add a placeholder for the operation.
   * 
   * @param pOperation
   * @return
   */
  public Operation addDynamicOperation(
    DynamicOperation pOperation)
  {
    iDynamicOperations.add(pOperation);
    iCmdArgs.add(DOP_PLACEHOLDER);
    return this;
  }

  
  /**
   * Return the list of DynmicOperations.
   * 
   * @return
   */
  public LinkedList<DynamicOperation> getDynamicOperations()
  {
    return iDynamicOperations;
  }
  
}