Cloneable.java 3.3 KB

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