rt/emul/compact/src/main/java/java/lang/Cloneable.java
author Jaroslav Tulach <jaroslav.tulach@apidesign.org>
Tue, 26 Feb 2013 16:54:16 +0100
changeset 772 d382dacfd73f
parent 557 emul/compact/src/main/java/java/lang/Cloneable.java@5be31d9fa455
child 1688 e709c530c227
permissions -rw-r--r--
Moving modules around so the runtime is under one master pom and can be built without building other modules that are in the repository
jaroslav@557
     1
/*
jaroslav@557
     2
 * Copyright (c) 1995, 2004, Oracle and/or its affiliates. All rights reserved.
jaroslav@557
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
jaroslav@557
     4
 *
jaroslav@557
     5
 * This code is free software; you can redistribute it and/or modify it
jaroslav@557
     6
 * under the terms of the GNU General Public License version 2 only, as
jaroslav@557
     7
 * published by the Free Software Foundation.  Oracle designates this
jaroslav@557
     8
 * particular file as subject to the "Classpath" exception as provided
jaroslav@557
     9
 * by Oracle in the LICENSE file that accompanied this code.
jaroslav@557
    10
 *
jaroslav@557
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
jaroslav@557
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
jaroslav@557
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
jaroslav@557
    14
 * version 2 for more details (a copy is included in the LICENSE file that
jaroslav@557
    15
 * accompanied this code).
jaroslav@557
    16
 *
jaroslav@557
    17
 * You should have received a copy of the GNU General Public License version
jaroslav@557
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
jaroslav@557
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
jaroslav@557
    20
 *
jaroslav@557
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
jaroslav@557
    22
 * or visit www.oracle.com if you need additional information or have any
jaroslav@557
    23
 * questions.
jaroslav@557
    24
 */
jaroslav@557
    25
jaroslav@557
    26
package java.lang;
jaroslav@557
    27
jaroslav@557
    28
/**
jaroslav@557
    29
 * A class implements the <code>Cloneable</code> interface to
jaroslav@557
    30
 * indicate to the {@link java.lang.Object#clone()} method that it
jaroslav@557
    31
 * is legal for that method to make a
jaroslav@557
    32
 * field-for-field copy of instances of that class.
jaroslav@557
    33
 * <p>
jaroslav@557
    34
 * Invoking Object's clone method on an instance that does not implement the
jaroslav@557
    35
 * <code>Cloneable</code> interface results in the exception
jaroslav@557
    36
 * <code>CloneNotSupportedException</code> being thrown.
jaroslav@557
    37
 * <p>
jaroslav@557
    38
 * By convention, classes that implement this interface should override
jaroslav@557
    39
 * <tt>Object.clone</tt> (which is protected) with a public method.
jaroslav@557
    40
 * See {@link java.lang.Object#clone()} for details on overriding this
jaroslav@557
    41
 * method.
jaroslav@557
    42
 * <p>
jaroslav@557
    43
 * Note that this interface does <i>not</i> contain the <tt>clone</tt> method.
jaroslav@557
    44
 * Therefore, it is not possible to clone an object merely by virtue of the
jaroslav@557
    45
 * fact that it implements this interface.  Even if the clone method is invoked
jaroslav@557
    46
 * reflectively, there is no guarantee that it will succeed.
jaroslav@557
    47
 *
jaroslav@557
    48
 * @author  unascribed
jaroslav@557
    49
 * @see     java.lang.CloneNotSupportedException
jaroslav@557
    50
 * @see     java.lang.Object#clone()
jaroslav@557
    51
 * @since   JDK1.0
jaroslav@557
    52
 */
jaroslav@557
    53
public interface Cloneable {
jaroslav@557
    54
}