Package edu.isi.pegasus.planner.dax

Class Invoke

  • public class Invoke
extends java.lang.Object
    The Notification invoke object for the Dax API
    Version:
    $Revision$
    Author:
    gmehta

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Invoke.JsonSerializer
      Custom serializer for YAML representation of an Invoke (Hook in 5.0)
      static class  Invoke.WHEN
      WHEN To INVOKE

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected java.lang.String mWhat
      What to invoke
      protected Invoke.WHEN mWhen
      WHen to Invoke

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Invoke clone()
      Create a copy of this Invoke object
      boolean equals​(java.lang.Object obj)
      Matches two Invoke objects
      java.lang.String getWhat()
      Get what to invoke
      java.lang.String getWhen()
      Get when to Invoke
      Invoke setWhat​(java.lang.String what)
      Set what executable to invoke and how
      Invoke setWhen​(Invoke.WHEN when)
      Set when to invoke
      java.lang.String toString()
      Returns the object as String
      void toXML​(edu.isi.pegasus.common.util.XMLWriter writer)
      Writes out XML representation using the writer
      void toXML​(edu.isi.pegasus.common.util.XMLWriter writer, int indent)
      Writes out XML representation using the writer

      • Methods inherited from class java.lang.Object

        finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Field Detail

      • mWhat

        protected java.lang.String mWhat
        What to invoke

    • Constructor Detail

      • Invoke

        public Invoke​(Invoke i)
        Copy Constructor
        Parameters:
        i - the invoke object

      • Invoke

        public Invoke​(Invoke.WHEN when)
        Crete a new Invoke object
        Parameters:
        when - when to invoke

      • Invoke

        public Invoke​(Invoke.WHEN when,
              java.lang.String what)
        Create a new Invoke object
        Parameters:
        when - when to invoke
        what - the executable with the arguments to invoke

    • Method Detail

      • getWhen

        public java.lang.String getWhen()
        Get when to Invoke
        Returns:
        when the notification occurs

      • setWhen

        public final Invoke setWhen​(Invoke.WHEN when)
        Set when to invoke
        Parameters:
        when - when the notification occurs
        Returns:
        Invoke

      • getWhat

        public java.lang.String getWhat()
        Get what to invoke
        Returns:
        the executable with arguments that are invoked

      • setWhat

        public Invoke setWhat​(java.lang.String what)
        Set what executable to invoke and how
        Parameters:
        what - executable with the arguments
        Returns:
        the Invoke

      • clone

        public Invoke clone()
        Create a copy of this Invoke object
        Overrides:
        clone in class java.lang.Object
        Returns:
        Invoke

      • toXML

        public void toXML​(edu.isi.pegasus.common.util.XMLWriter writer)
        Writes out XML representation using the writer
        Parameters:
        writer - the writer

      • toXML

        public void toXML​(edu.isi.pegasus.common.util.XMLWriter writer,
                  int indent)
        Writes out XML representation using the writer
        Parameters:
        writer - the writer
        indent - number pf indent spaces

      • toString

        public java.lang.String toString()
        Returns the object as String
        Overrides:
        toString in class java.lang.Object
        Returns:
        the description

      • equals

        public boolean equals​(java.lang.Object obj)
        Matches two Invoke objects
        Overrides:
        equals in class java.lang.Object
        Parameters:
        obj - object to being compared against
        Returns:
        true if the pfn and all the attributes match, false otherwise.