cvs commit: jakarta-slide/src/share/org/apache/slide/macro CopyListener.java

[ju...@apache.org]

juergen     02/04/03 22:22:47

  Added:       src/share/org/apache/slide/macro CopyListener.java
  Log:
  Initial revision.
  (ralf)
  
  Revision  Changes    Path
  1.1                  jakarta-slide/src/share/org/apache/slide/macro/CopyListener.java
  
  Index: CopyListener.java
  ===================================================================
  /*
   * $Header: /home/cvs/jakarta-slide/src/share/org/apache/slide/macro/CopyListener.java,v 1.1 2002/04/04 06:22:47 juergen Exp $
   * $Revision: 1.1 $
   * $Date: 2002/04/04 06:22:47 $
   *
   * ====================================================================
   *
   * The Apache Software License, Version 1.1
   *
   * Copyright (c) 1999 The Apache Software Foundation.  All rights
   * reserved.
   *
   * Redistribution and use in source and binary forms, with or without
   * modification, are permitted provided that the following conditions
   * are met:
   *
   * 1. Redistributions of source code must retain the above copyright
   *    notice, this list of conditions and the following disclaimer.
   *
   * 2. Redistributions in binary form must reproduce the above copyright
   *    notice, this list of conditions and the following disclaimer in
   *    the documentation and/or other materials provided with the
   *    distribution.
   *
   * 3. The end-user documentation included with the redistribution, if
   *    any, must include the following acknowlegement:
   *       "This product includes software developed by the
   *        Apache Software Foundation (http://www.apache.org/)."
   *    Alternately, this acknowlegement may appear in the software itself,
   *    if and wherever such third-party acknowlegements normally appear.
   *
   * 4. The names "The Jakarta Project", "Tomcat", and "Apache Software
   *    Foundation" must not be used to endorse or promote products derived
   *    from this software without prior written permission. For written
   *    permission, please contact apache@apache.org.
   *
   * 5. Products derived from this software may not be called "Apache"
   *    nor may "Apache" appear in their names without prior written
   *    permission of the Apache Group.
   *
   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
   * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
   * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
   * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
   * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
   * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   * SUCH DAMAGE.
   * ====================================================================
   *
   * This software consists of voluntary contributions made by many
   * individuals on behalf of the Apache Software Foundation.  For more
   * information on the Apache Software Foundation, please see
   * <http://www.apache.org/>.
   *
   * [Additional notices, if required by prior licensing conditions]
   *
   */
  
  package org.apache.slide.macro;
  
  // import list
  import org.apache.slide.common.SlideException;
  import org.apache.slide.structure.ObjectNode;
  
  /**
   * A CopyListener may be handed to the Macro helper in order to have more
   * control on the copy operation. The CopyListener will be notified
   * before and after copying any single resource that is target of the
   * recursive copy operation.
   *
   * @version $Revision: 1.1 $
   *
   * @author <a href="mailto:ralf.stuckert@softwareag.com">Ralf Stuckert</a>
   **/
  
  public interface CopyListener {
      
      /**
       * This method is called prior to copying the resource associated by
       * the given <code>sourceUri</code>. The copy can be prohibited by
       * throwing a SlideException.
       *
       * @param      sourceUri       the Uri of the resource that will be copied.
       * @param      destinationUri  the Uri of the copy.
       *
       * @throws     SlideException  this Exception will be passed to the caller
       *                             of the Macro helper (contained in the
       *                             MacroDeleteException.
       */
      public void beforeCopy(String sourceUri, String destinationUri) throws SlideException;
      
      /**
       * This method is called after copying the resource to
       * the given <code>destinationUri</code>.
       *
       * @param      sourceUri       the Uri of the resource that has been copied.
       * @param      destinationUri  the Uri of the copy.
       *
       * @throws     SlideException  this Exception will be passed to the caller
       *                             of the Macro helper (contained in the
       *                             MacroDeleteException.
       */
      public void afterCopy(String sourceUri, String destinationUri) throws SlideException;
      
  }
  
  
  
  

--
To unsubscribe, e-mail:   <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>