Package org.ggf.drmaa

Class FileTransferMode

java.lang.Object
org.ggf.drmaa.FileTransferMode
All Implemented Interfaces:
Serializable, Cloneable

public class FileTransferMode extends Object implements Serializable, Cloneable
This class represents the streams which should be used for file transfers. For each of the three properties which is set to true, the corresponding stream's path property in the job template will be treated as a source or destination (depending on the stream) for file tranfers. For example, if the inputStream property is set to true, the inputPath property of the JobTemplate will be interpreted as a source from which to transfer files.
Since:
0.5
Version:
1.0
See Also:
  • Constructor Summary

    Constructors
    Constructor
    Description
    Creates a new instance of FileTransferMode
    FileTransferMode(boolean inputStream, boolean outputStream, boolean errorStream)
    Create a new instance with the property values preset.
  • Method Summary

    Modifier and Type
    Method
    Description
    Creates a copy of this FileTransferMode object.
    boolean
    Test whether two FileTransferMode objects have the same property settings.
    boolean
    Whether to transfer error stream files.
    boolean
    Whether to transfer error stream files.
    boolean
    Whether to transfer error stream files.
    int
    Returns a hash code based on the file transfer properties.
    void
    setErrorStream(boolean errorStream)
    Set whether to transfer error stream files.
    void
    setInputStream(boolean inputStream)
    Set whether to transfer error stream files.
    void
    setOutputStream(boolean outputStream)
    Set whether to transfer error stream files.
    Returns a string containing the stream settings.

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait
  • Constructor Details

    • FileTransferMode

      public FileTransferMode()
      Creates a new instance of FileTransferMode
    • FileTransferMode

      public FileTransferMode(boolean inputStream, boolean outputStream, boolean errorStream)
      Create a new instance with the property values preset.
      Parameters:
      inputStream - whether to transfer input stream files
      outputStream - whether to transfer output stream files
      errorStream - whether to transfer error stream files
  • Method Details

    • setErrorStream

      public void setErrorStream(boolean errorStream)
      Set whether to transfer error stream files.
      Parameters:
      errorStream - whether to transfer error stream files
    • getErrorStream

      public boolean getErrorStream()
      Whether to transfer error stream files.
      Returns:
      whether to transfer error stream files
    • setInputStream

      public void setInputStream(boolean inputStream)
      Set whether to transfer error stream files.
      Parameters:
      inputStream - whether to transfer error stream files
    • getInputStream

      public boolean getInputStream()
      Whether to transfer error stream files.
      Returns:
      whether to transfer error stream files
    • setOutputStream

      public void setOutputStream(boolean outputStream)
      Set whether to transfer error stream files.
      Parameters:
      outputStream - whether to transfer error stream files
    • getOutputStream

      public boolean getOutputStream()
      Whether to transfer error stream files.
      Returns:
      whether to transfer error stream files
    • equals

      public boolean equals(Object obj)
      Test whether two FileTransferMode objects have the same property settings.
      Overrides:
      equals in class Object
      Parameters:
      obj - the Object to test for equality
      Returns:
      whether the FileTransferMode object has the same property settings as this one
    • hashCode

      public int hashCode()
      Returns a hash code based on the file transfer properties.
      Overrides:
      hashCode in class Object
      Returns:
      a hash code based on the file transfer properties
    • clone

      public Object clone()
      Creates a copy of this FileTransferMode object.
      Returns:
      a copy of this FileTransferMode object
    • toString

      public String toString()
      Returns a string containing the stream settings.
      Overrides:
      toString in class Object
      Returns:
      a string containing the stream settings