View Javadoc

1   /* 
2    * Copyright 2002-2004 The Apache Software Foundation
3    * Licensed  under the  Apache License,  Version 2.0  (the "License");
4    * you may not use  this file  except in  compliance with the License.
5    * You may obtain a copy of the License at 
6    * 
7    *   http://www.apache.org/licenses/LICENSE-2.0
8    * 
9    * Unless required by applicable law or agreed to in writing, software
10   * distributed  under the  License is distributed on an "AS IS" BASIS,
11   * WITHOUT  WARRANTIES OR CONDITIONS  OF ANY KIND, either  express  or
12   * implied.
13   * 
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.apache.struts.flow.core.source;
18  
19  
20  /***
21   * This class marks a source to be able to moved and copied to
22   * serveral other locations. This class should only be used if
23   * the implementations details should be hidden, otherwise
24   * the class SourceUtils can be used.
25   *
26   * @author <a href="mailto:dev@avalon.apache.org">Avalon Development Team</a>
27   * @version CVS $Id: MoveableSource.java,v 1.5 2004/02/28 11:47:26 cziegeler Exp $
28   */
29  public interface MoveableSource extends Source
30  {
31  
32      /***
33       * Copy the current source to a specified destination.
34       *
35       * @param destination Destination of the source.
36       *
37       * @throws SourceException If an exception occurs during
38       *                         the copy.
39       */
40      void copyTo(Source destination) throws SourceException;
41  
42      /***
43       * Move the current source to a specified destination.
44       *
45       * @param destination Destination of the source.
46       *
47       * @throws SourceException If an exception occurs during
48       *                         the move.
49       */
50      void moveTo(Source destination) throws SourceException;
51  }