ant-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From dona...@apache.org
Subject cvs commit: jakarta-ant-myrmidon/container/src/java/org/apache/myrmidon/interfaces/model Module.java
Date Sun, 28 Apr 2002 05:44:34 GMT
donaldp     02/04/27 22:44:34

  Added:       container/src/java/org/apache/myrmidon/interfaces/model
                        Module.java
  Log:
  Add interface for Module that is the
  interface which a Project will implement.
  
  Revision  Changes    Path
  1.1                  jakarta-ant-myrmidon/container/src/java/org/apache/myrmidon/interfaces/model/Module.java
  
  Index: Module.java
  ===================================================================
  /*
   * Copyright (C) The Apache Software Foundation. All rights reserved.
   *
   * This software is published under the terms of the Apache Software License
   * version 1.1, a copy of which has been included  with this distribution in
   * the LICENSE.txt file.
   */
  package org.apache.myrmidon.interfaces.model;
  
  import org.apache.myrmidon.api.TaskException;
  import org.apache.myrmidon.interfaces.executor.ExecutionFrame;
  
  /**
   * A Module represents a executable module that Myrmidon is
   * capable of executing. ie Myrmidon as a Build tool would
   * have the Project object implement the Module interface.
   * While using Myrmidon as a Scheduler would have the Job
   * object implement the Module interface.
   *
   * @author <a href="mailto:peter@apache.org">Peter Donald</a>
   * @version $Revision: 1.1 $ $Date: 2002/04/28 05:44:34 $
   */
  public interface Module
  {
      /**
       * Retrieve MetaData associated with Module.
       * The primary purpose of the MetaData is to
       * enable a decent UI to run the Module.
       *
       * @return the MetaData for Module
       */
      TargetMetaData getMetaData();
  
      /**
       * Execute the specified target in module
       * using specified {@link ExecutionFrame}.
       *
       * @param frame the frame in which to execute
       * @param target the target to execute
       * @throws TaskException if an error occurs executing module
       */
      void execute( ExecutionFrame frame,
                    TargetMetaData target )
          throws TaskException;
  }
  
  
  
  

--
To unsubscribe, e-mail:   <mailto:ant-dev-unsubscribe@jakarta.apache.org>
For additional commands, e-mail: <mailto:ant-dev-help@jakarta.apache.org>


Mime
View raw message