jdk/src/share/classes/java/lang/Cloneable.java
author martin
Mon, 10 Mar 2008 14:32:51 -0700
changeset 48 dc5744ca15ea
parent 2 90ce3da70b43
child 5506 202f599c92aa
permissions -rw-r--r--
4960438: (process) Need IO redirection API for subprocesses Reviewed-by: alanb, iris
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     1
/*
90ce3da70b43 Initial load
duke
parents:
diff changeset
     2
 * Copyright 1995-2004 Sun Microsystems, Inc.  All Rights Reserved.
90ce3da70b43 Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
90ce3da70b43 Initial load
duke
parents:
diff changeset
     4
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
90ce3da70b43 Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
90ce3da70b43 Initial load
duke
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Sun designates this
90ce3da70b43 Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
90ce3da70b43 Initial load
duke
parents:
diff changeset
     9
 * by Sun in the LICENSE file that accompanied this code.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    10
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
90ce3da70b43 Initial load
duke
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
90ce3da70b43 Initial load
duke
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
90ce3da70b43 Initial load
duke
parents:
diff changeset
    15
 * accompanied this code).
90ce3da70b43 Initial load
duke
parents:
diff changeset
    16
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
90ce3da70b43 Initial load
duke
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    20
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    21
 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    22
 * CA 95054 USA or visit www.sun.com if you need additional information or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    23
 * have any questions.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    24
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    25
90ce3da70b43 Initial load
duke
parents:
diff changeset
    26
package java.lang;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    27
90ce3da70b43 Initial load
duke
parents:
diff changeset
    28
/**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    29
 * A class implements the <code>Cloneable</code> interface to
90ce3da70b43 Initial load
duke
parents:
diff changeset
    30
 * indicate to the {@link java.lang.Object#clone()} method that it
90ce3da70b43 Initial load
duke
parents:
diff changeset
    31
 * is legal for that method to make a
90ce3da70b43 Initial load
duke
parents:
diff changeset
    32
 * field-for-field copy of instances of that class.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    33
 * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    34
 * Invoking Object's clone method on an instance that does not implement the
90ce3da70b43 Initial load
duke
parents:
diff changeset
    35
 * <code>Cloneable</code> interface results in the exception
90ce3da70b43 Initial load
duke
parents:
diff changeset
    36
 * <code>CloneNotSupportedException</code> being thrown.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    37
 * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    38
 * By convention, classes that implement this interface should override
90ce3da70b43 Initial load
duke
parents:
diff changeset
    39
 * <tt>Object.clone</tt> (which is protected) with a public method.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    40
 * See {@link java.lang.Object#clone()} for details on overriding this
90ce3da70b43 Initial load
duke
parents:
diff changeset
    41
 * method.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    42
 * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    43
 * Note that this interface does <i>not</i> contain the <tt>clone</tt> method.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    44
 * Therefore, it is not possible to clone an object merely by virtue of the
90ce3da70b43 Initial load
duke
parents:
diff changeset
    45
 * fact that it implements this interface.  Even if the clone method is invoked
90ce3da70b43 Initial load
duke
parents:
diff changeset
    46
 * reflectively, there is no guarantee that it will succeed.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    47
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    48
 * @author  unascribed
90ce3da70b43 Initial load
duke
parents:
diff changeset
    49
 * @see     java.lang.CloneNotSupportedException
90ce3da70b43 Initial load
duke
parents:
diff changeset
    50
 * @see     java.lang.Object#clone()
90ce3da70b43 Initial load
duke
parents:
diff changeset
    51
 * @since   JDK1.0
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    53
public interface Cloneable {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    54
}