| 1 | /* Cloneable.java -- Interface for marking objects cloneable by Object.clone()
|
|---|
| 2 | Copyright (C) 1998, 1999, 2001 Free Software Foundation, Inc.
|
|---|
| 3 |
|
|---|
| 4 | This file is part of GNU Classpath.
|
|---|
| 5 |
|
|---|
| 6 | GNU Classpath is free software; you can redistribute it and/or modify
|
|---|
| 7 | it under the terms of the GNU General Public License as published by
|
|---|
| 8 | the Free Software Foundation; either version 2, or (at your option)
|
|---|
| 9 | any later version.
|
|---|
| 10 |
|
|---|
| 11 | GNU Classpath is distributed in the hope that it will be useful, but
|
|---|
| 12 | WITHOUT ANY WARRANTY; without even the implied warranty of
|
|---|
| 13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|---|
| 14 | General Public License for more details.
|
|---|
| 15 |
|
|---|
| 16 | You should have received a copy of the GNU General Public License
|
|---|
| 17 | along with GNU Classpath; see the file COPYING. If not, write to the
|
|---|
| 18 | Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
|
|---|
| 19 | 02111-1307 USA.
|
|---|
| 20 |
|
|---|
| 21 | Linking this library statically or dynamically with other modules is
|
|---|
| 22 | making a combined work based on this library. Thus, the terms and
|
|---|
| 23 | conditions of the GNU General Public License cover the whole
|
|---|
| 24 | combination.
|
|---|
| 25 |
|
|---|
| 26 | As a special exception, the copyright holders of this library give you
|
|---|
| 27 | permission to link this library with independent modules to produce an
|
|---|
| 28 | executable, regardless of the license terms of these independent
|
|---|
| 29 | modules, and to copy and distribute the resulting executable under
|
|---|
| 30 | terms of your choice, provided that you also meet, for each linked
|
|---|
| 31 | independent module, the terms and conditions of the license of that
|
|---|
| 32 | module. An independent module is a module which is not derived from
|
|---|
| 33 | or based on this library. If you modify this library, you may extend
|
|---|
| 34 | this exception to your version of the library, but you are not
|
|---|
| 35 | obligated to do so. If you do not wish to do so, delete this
|
|---|
| 36 | exception statement from your version. */
|
|---|
| 37 |
|
|---|
| 38 |
|
|---|
| 39 | package java.lang;
|
|---|
| 40 |
|
|---|
| 41 | /* Written using "Java Class Libraries", 2nd edition, ISBN 0-201-31002-3
|
|---|
| 42 | * "The Java Language Specification", ISBN 0-201-63451-1
|
|---|
| 43 | * plus online API docs for JDK 1.2 beta from http://www.javasoft.com.
|
|---|
| 44 | * Status: Believed complete and correct.
|
|---|
| 45 | */
|
|---|
| 46 |
|
|---|
| 47 | /**
|
|---|
| 48 | * This interface should be implemented by classes wishing to
|
|---|
| 49 | * support of override <code>Object.clone()</code>. The default
|
|---|
| 50 | * behaviour of <code>clone()</code> performs a shallow copy, but
|
|---|
| 51 | * subclasses often change this to perform a deep copy. Therefore,
|
|---|
| 52 | * it is a good idea to document how deep your clone will go.
|
|---|
| 53 | * If <code>clone()</code> is called on an object which does not
|
|---|
| 54 | * implement this interface, a <code>CloneNotSupportedException</code>
|
|---|
| 55 | * will be thrown.
|
|---|
| 56 | * <p>
|
|---|
| 57 | *
|
|---|
| 58 | * This interface is simply a tagging interface; it carries no
|
|---|
| 59 | * requirements on methods to implement. However, it is typical for
|
|---|
| 60 | * a Cloneable class to implement at least <code>equals</code>,
|
|---|
| 61 | * <code>hashCode</code>, and <code>clone</code>, sometimes
|
|---|
| 62 | * increasing the accessibility of clone to be public. The typical
|
|---|
| 63 | * implementation of <code>clone</code> invokes <code>super.clone()</code>
|
|---|
| 64 | * rather than a constructor, but this is not a requirement.
|
|---|
| 65 | * <p>
|
|---|
| 66 | *
|
|---|
| 67 | * If an object that implement Cloneable should not be cloned,
|
|---|
| 68 | * simply override the <code>clone</code> method to throw a
|
|---|
| 69 | * <code>CloneNotSupportedException</code>.
|
|---|
| 70 | * <p>
|
|---|
| 71 | *
|
|---|
| 72 | * All array types implement Cloneable, and have a public
|
|---|
| 73 | * <code>clone</code> method that will never fail with a
|
|---|
| 74 | * <code>CloneNotSupportedException</code>.
|
|---|
| 75 | *
|
|---|
| 76 | * @since 1.0
|
|---|
| 77 | * @author Paul Fisher
|
|---|
| 78 | * @author Eric Blake <[email protected]>
|
|---|
| 79 | * @author Warren Levy <[email protected]>
|
|---|
| 80 | *
|
|---|
| 81 | * @see Object#clone()
|
|---|
| 82 | * @see CloneNotSupportedException
|
|---|
| 83 | */
|
|---|
| 84 | public interface Cloneable
|
|---|
| 85 | {
|
|---|
| 86 | // Tagging interface only.
|
|---|
| 87 | }
|
|---|
