You are viewing a plain text version of this content. The canonical link for it is here.
Posted to slide-dev@jakarta.apache.org by ju...@apache.org on 2002/05/07 09:28:23 UTC

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

juergen     02/05/07 00:28:23

  Added:       src/share/org/apache/slide/macro CopyRouteRedirector.java
                        DeleteTargetRedirector.java
  Log:
  Initial revision.
  (ralf)
  
  Revision  Changes    Path
  1.1                  jakarta-slide/src/share/org/apache/slide/macro/CopyRouteRedirector.java
  
  Index: CopyRouteRedirector.java
  ===================================================================
  /*
   * $Header: /home/cvs/jakarta-slide/src/share/org/apache/slide/macro/CopyRouteRedirector.java,v 1.1 2002/05/07 07:28:23 juergen Exp $
   * $Revision: 1.1 $
   * $Date: 2002/05/07 07:28:23 $
   *
   * ====================================================================
   *
   * 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", "Slide", 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;
  
  /**
   * A CopyRouteRedirector may be passed to the Macro helper in order to have more
   * control on the <code>copy</code> operation. A CopyRouteRedirector
   * may either return the given CopyRoute or any (redirected) CopyRoute.
   *
   * @version $Revision: 1.1 $
   *
   * @author <a href="mailto:ralf.stuckert@softwareag.com">Ralf Stuckert</a>
   **/
  public interface CopyRouteRedirector  {
      
      
      /**
       * A CopyRoute defines the source and the destination URI of a
       * <code>copy</code> operation.
       *
       * @version $Revision: 1.1 $
       *
       * @author <a href="mailto:ralf.stuckert@softwareag.com">Ralf Stuckert</a>
       **/
      public static class CopyRoute {
          
          /**
           * Message of the IllegalArgumentException that is thrown by constructor
           * {@link #CopyRoute CopyRoute} if parameter <code>sourceUri</code> is
           * <code>null</code>.
           */
          public static String SOURCE_MUST_NOT_BE_NULL = "Parameter 'sourceUri' must not be null";
          
          /**
           * Message of the IllegalArgumentException that is thrown by constructor
           * {@link #CopyRoute CopyRoute} if parameter <code>destinationUri</code> is
           * <code>null</code>.
           */
          public static String DESTINATION_MUST_NOT_BE_NULL = "Parameter 'destinationUri' must not be null";
          
          
          /**
           * The source Uri.
           */
          protected String sourceUri = null;
          
          /**
           * The destination Uri.
           */
          protected String destinationUri = null;
          
          /**
           * Creates a CopyRoute from the given URIs.
           *
           * @param      sourceUri       the Uri of the source.
           *                             Must not be <code>null</code>.
           * @param      destinationUri  the Uri of the destination.
           *                             Must not be <code>null</code>.
           *
           * @throws     IllegalArgumentException if one of the parameters is
           *             <code>null</code>.
           */
          public CopyRoute(String sourceUri, String destinationUri) throws IllegalArgumentException {
              
              if (sourceUri == null) {
                  throw new IllegalArgumentException(SOURCE_MUST_NOT_BE_NULL);
              }
              if (destinationUri == null) {
                  throw new IllegalArgumentException(DESTINATION_MUST_NOT_BE_NULL);
              }
              this.sourceUri = sourceUri;
              this.destinationUri = destinationUri;
          }
          
          /**
           * Returns the source Uri.
           *
           * @return     the source Uri.
           */
          public String getSourceUri() {
              return sourceUri;
          }
          
          /**
           * Returns the destination Uri.
           *
           * @return     the destination Uri.
           */
          public String getDestinationUri() {
              return destinationUri;
          }
      }
      
      
      
      /**
       * Returns the (redirected) CopyRoute to use. Must not be <code>null</code>.
       *
       * @param      the original CopyRoute.
       *
       * @return     the (redirected) CopyRoute to use.
       *
       * @throws     SlideException  this Exception will be passed to the caller
       *                             of the Macro helper (contained in the
       *                             MacroCopyException).
       */
      public CopyRoute getRedirectedCopyRoute(CopyRoute copyRoute) throws SlideException;
      
  }
  
  
  
  
  1.1                  jakarta-slide/src/share/org/apache/slide/macro/DeleteTargetRedirector.java
  
  Index: DeleteTargetRedirector.java
  ===================================================================
  /*
   * $Header: /home/cvs/jakarta-slide/src/share/org/apache/slide/macro/DeleteTargetRedirector.java,v 1.1 2002/05/07 07:28:23 juergen Exp $
   * $Revision: 1.1 $
   * $Date: 2002/05/07 07:28:23 $
   *
   * ====================================================================
   *
   * 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", "Slide", 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;
  
  /**
   * A DeleteTargetRedirector may be passed to the Macro helper in order to have more
   * control on the <code>delete</code> operation. A DeleteTargetRedirector
   * may either return the given URI or any (redirected) URI.
   *
   * @version $Revision: 1.1 $
   *
   * @author <a href="mailto:ralf.stuckert@softwareag.com">Ralf Stuckert</a>
   **/
  public interface DeleteTargetRedirector  {
      
      /**
       * Returns the (redirected) target Uri to use. Must not be <code>null</code>.
       *
       * @param      the original target Uri.
       *
       * @return     the (redirected) target Uri to use.
       *
       * @throws     SlideException  this Exception will be passed to the caller
       *                             of the Macro helper (contained in the
       *                             MacroDeleteException).
       */
      public String getRedirectedTargetUri(String targetUri) throws SlideException;
  
  }
  
  
  
  

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