View Javadoc

1   /*
2    * Copyright 2004-2005 the original author or authors.
3    * 
4    * Licensed under the Apache License, Version 2.0 (the "License"); you may not
5    * use this file except in compliance with the License. You may obtain a copy of
6    * the License at
7    * 
8    * http://www.apache.org/licenses/LICENSE-2.0
9    * 
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12   * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13   * License for the specific language governing permissions and limitations under
14   * the License.
15   */
16  package net.sf.morph.transform;
17  
18  import java.util.Locale;
19  
20  /**
21   * An object that can copy information from a source object to a destination
22   * object.
23   * 
24   * @author Matt Sgarlata
25   * @since October 31, 2004
26   */
27  public interface Copier extends Transformer {
28  
29  	/**
30  	 * <p>
31  	 * Copies information from the given source to the given destination.
32  	 * </p>
33  	 * 
34  	 * @param destination
35  	 *            the object to which information is written
36  	 * @param source
37  	 *            the object from which information is read
38  	 * @param locale
39  	 *            the locale of the current user, which may be null if the
40  	 *            locale is unknown or not applicable
41  	 * @throws TransformationException
42  	 *             if <code>source</code> or <code>destination</code> are
43  	 *             null or <br>
44  	 *             an error occurrs while copying
45  	 */
46  	public void copy(Object destination, Object source, Locale locale)
47  		throws TransformationException;
48  
49  }