001////////////////////////////////////////////////////////////////////////////////
002// checkstyle: Checks Java source code for adherence to a set of rules.
003// Copyright (C) 2001-2021 the original author or authors.
004//
005// This library is free software; you can redistribute it and/or
006// modify it under the terms of the GNU Lesser General Public
007// License as published by the Free Software Foundation; either
008// version 2.1 of the License, or (at your option) any later version.
009//
010// This library is distributed in the hope that it will be useful,
011// but WITHOUT ANY WARRANTY; without even the implied warranty of
012// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
013// Lesser General Public License for more details.
014//
015// You should have received a copy of the GNU Lesser General Public
016// License along with this library; if not, write to the Free Software
017// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
018////////////////////////////////////////////////////////////////////////////////
019
020package com.puppycrawl.tools.checkstyle.checks.coding;
021
022import com.puppycrawl.tools.checkstyle.StatelessCheck;
023
024/**
025 * <p>
026 * Checks that an overriding {@code clone()} method invokes {@code super.clone()}.
027 * Does not check native methods, as they have no possible java defined implementation.
028 * </p>
029 * <p>
030 * Reference:
031 * <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#clone%28%29">
032 * Object.clone()</a>.
033 * </p>
034 * <p>
035 * To configure the check:
036 * </p>
037 * <pre>
038 * &lt;module name=&quot;SuperClone&quot;/&gt;
039 * </pre>
040 * <p>Example:</p>
041 * <pre>
042 * class A {
043 *
044 *  public Object clone() { // OK
045 *   return super.clone();
046 *  }
047 * }
048 *
049 * class B {
050 * private int b;
051 *
052 *  public B clone() { // violation, does not call super.clone()
053 *   B other = new B();
054 *   other.b = this.b;
055 *   return other;
056 *  }
057 * }
058 *
059 * class C {
060 *
061 *  public C clone() { // OK
062 *   return (C) super.clone();
063 *  }
064 * }
065 * </pre>
066 * <p>
067 * Parent is {@code com.puppycrawl.tools.checkstyle.TreeWalker}
068 * </p>
069 * <p>
070 * Violation Message Keys:
071 * </p>
072 * <ul>
073 * <li>
074 * {@code missing.super.call}
075 * </li>
076 * </ul>
077 *
078 * @since 3.2
079 */
080@StatelessCheck
081public class SuperCloneCheck extends AbstractSuperCheck {
082
083    @Override
084    protected String getMethodName() {
085        return "clone";
086    }
087
088}