Remove fully qualified class names which can be shortened. #1538
This commit is contained in:
parent
940eb6509f
commit
693e8820d5
|
|
@ -28,7 +28,7 @@ import com.puppycrawl.tools.checkstyle.api.Check;
|
|||
|
||||
/**
|
||||
* <p> Abstract class for checks that verify strings using a
|
||||
* {@link java.util.regex.Pattern regular expression}. It
|
||||
* {@link Pattern regular expression}. It
|
||||
* provides support for setting the regular
|
||||
* expression using the property name <code>format</code>. </p>
|
||||
*
|
||||
|
|
@ -57,7 +57,7 @@ public abstract class AbstractFormatCheck
|
|||
* Creates a new <code>AbstractFormatCheck</code> instance.
|
||||
* @param defaultFormat default format
|
||||
* @param compileFlags the Pattern flags to compile the regexp with.
|
||||
* See {@link Pattern#compile(java.lang.String, int)}
|
||||
* See {@link Pattern#compile(String, int)}
|
||||
* @throws ConversionException unable to parse defaultFormat
|
||||
*/
|
||||
public AbstractFormatCheck(String defaultFormat, int compileFlags) {
|
||||
|
|
|
|||
|
|
@ -140,7 +140,7 @@ public final class CheckUtils {
|
|||
* type. Returns 0 for types other than float, double, int, and long.
|
||||
* @param text the string to be parsed.
|
||||
* @param type the token type of the text. Should be a constant of
|
||||
* {@link com.puppycrawl.tools.checkstyle.api.TokenTypes}.
|
||||
* {@link TokenTypes}.
|
||||
* @return the double value represented by the string argument.
|
||||
*/
|
||||
public static double parseDouble(String text, int type) {
|
||||
|
|
@ -229,7 +229,7 @@ public final class CheckUtils {
|
|||
* type. Returns 0 for types other than float, double, int, and long.
|
||||
* @param text the string to be parsed.
|
||||
* @param type the token type of the text. Should be a constant of
|
||||
* {@link com.puppycrawl.tools.checkstyle.api.TokenTypes}.
|
||||
* {@link TokenTypes}.
|
||||
* @return the float value represented by the string argument.
|
||||
*/
|
||||
public static double parseFloat(String text, int type) {
|
||||
|
|
|
|||
|
|
@ -33,14 +33,14 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes;
|
|||
/**
|
||||
* <p>
|
||||
* This class is used to verify that both the
|
||||
* {@link java.lang.Deprecated Deprecated} annotation
|
||||
* {@link Deprecated Deprecated} annotation
|
||||
* and the deprecated javadoc tag are present when
|
||||
* either one is present.
|
||||
* </p>
|
||||
*
|
||||
* <p>
|
||||
* Both ways of flagging deprecation serve their own purpose. The
|
||||
* {@link java.lang.Deprecated Deprecated} annotation is used for
|
||||
* {@link Deprecated Deprecated} annotation is used for
|
||||
* compilers and development tools. The deprecated javadoc tag is
|
||||
* used to document why something is deprecated and what, if any,
|
||||
* alternatives exist.
|
||||
|
|
|
|||
|
|
@ -32,15 +32,15 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes;
|
|||
|
||||
/**
|
||||
* <p>
|
||||
* This class is used to verify that the {@link java.lang.Override Override}
|
||||
* This class is used to verify that the {@link Override Override}
|
||||
* annotation is present when the inheritDoc javadoc tag is present.
|
||||
* </p>
|
||||
*
|
||||
* <p>
|
||||
* Rationale: The {@link java.lang.Override Override} annotation helps
|
||||
* Rationale: The {@link Override Override} annotation helps
|
||||
* compiler tools ensure that an override is actually occurring. It is
|
||||
* quite easy to accidentally overload a method or hide a static method
|
||||
* and using the {@link java.lang.Override Override} annotation points
|
||||
* and using the {@link Override Override} annotation points
|
||||
* out these problems.
|
||||
* </p>
|
||||
*
|
||||
|
|
|
|||
|
|
@ -22,7 +22,7 @@ package com.puppycrawl.tools.checkstyle.checks.blocks;
|
|||
/**
|
||||
* Represents the policy for checking block statements.
|
||||
* @author Rick Giles
|
||||
* @see com.puppycrawl.tools.checkstyle.checks.blocks.EmptyBlockCheck
|
||||
* @see EmptyBlockCheck
|
||||
*/
|
||||
public enum BlockOption {
|
||||
/**
|
||||
|
|
|
|||
|
|
@ -38,8 +38,8 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes;
|
|||
* </module>
|
||||
* </pre>
|
||||
* @author Alexander Jesse
|
||||
* @see com.puppycrawl.tools.checkstyle.checks.coding.AbstractNestedDepthCheck
|
||||
* @see com.puppycrawl.tools.checkstyle.checks.coding.NestedIfDepthCheck
|
||||
* @see AbstractNestedDepthCheck
|
||||
* @see NestedIfDepthCheck
|
||||
*/
|
||||
public final class NestedForDepthCheck extends AbstractNestedDepthCheck {
|
||||
|
||||
|
|
|
|||
|
|
@ -122,9 +122,9 @@ package com.puppycrawl.tools.checkstyle.checks.coding;
|
|||
*
|
||||
*
|
||||
* @author Travis Schneeberger
|
||||
* @see java.lang.Object#clone()
|
||||
* @see java.lang.Cloneable
|
||||
* @see java.lang.CloneNotSupportedException
|
||||
* @see Object#clone()
|
||||
* @see Cloneable
|
||||
* @see CloneNotSupportedException
|
||||
*/
|
||||
public class NoCloneCheck extends AbstractIllegalMethodCheck {
|
||||
|
||||
|
|
|
|||
|
|
@ -33,7 +33,7 @@ import com.puppycrawl.tools.checkstyle.Utils;
|
|||
|
||||
/**
|
||||
* Checks the header of the source against a header file that contains a
|
||||
* {@link java.util.regex.Pattern regular expression}
|
||||
* {@link Pattern regular expression}
|
||||
* for each line of the source header. In default configuration,
|
||||
* if header is not specified, the default value of header is set to null
|
||||
* and the check does not rise any violations.
|
||||
|
|
@ -144,7 +144,7 @@ public class RegexpHeaderCheck extends AbstractHeaderCheck {
|
|||
|
||||
/**
|
||||
* Validates the {@code header} by compiling it with
|
||||
* {@link Pattern#compile(java.lang.String) } and throws
|
||||
* {@link Pattern#compile(String) } and throws
|
||||
* {@link PatternSyntaxException} if {@code header} isn't a valid pattern.
|
||||
* @param header the header value to validate and set (in that order)
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -22,7 +22,7 @@ package com.puppycrawl.tools.checkstyle.checks.imports;
|
|||
/**
|
||||
* Represents the policy for checking import order statements.
|
||||
* @author David DIDIER
|
||||
* @see com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck
|
||||
* @see ImportOrderCheck
|
||||
*/
|
||||
public enum ImportOrderOption {
|
||||
/**
|
||||
|
|
|
|||
|
|
@ -30,7 +30,7 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes;
|
|||
* Checks that local, non-final variable names conform to a format specified
|
||||
* by the format property. A catch parameter is considered to be
|
||||
* a local variable. The format is a
|
||||
* {@link java.util.regex.Pattern regular expression}
|
||||
* {@link Pattern regular expression}
|
||||
* and defaults to
|
||||
* <strong>^[a-z][a-zA-Z0-9]*$</strong>.
|
||||
* </p>
|
||||
|
|
|
|||
|
|
@ -30,7 +30,7 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes;
|
|||
* The default allowable number of parameters is 7.
|
||||
* To change the number of allowable parameters, set property max.
|
||||
* Allows to ignore number of parameters for methods with
|
||||
* @{@link java.lang.Override} annotation.
|
||||
* @{@link Override} annotation.
|
||||
* </p>
|
||||
* <p>
|
||||
* An example of how to configure the check is:
|
||||
|
|
@ -40,7 +40,7 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes;
|
|||
* </pre>
|
||||
* <p>
|
||||
* An example of how to configure the check to allow 10 parameters
|
||||
* and ignoring parameters for methods with @{@link java.lang.Override}
|
||||
* and ignoring parameters for methods with @{@link Override}
|
||||
* annotation is:
|
||||
* </p>
|
||||
* <pre>
|
||||
|
|
@ -96,7 +96,7 @@ public class ParameterNumberCheck
|
|||
|
||||
/**
|
||||
* Ignore number of parameters for methods with
|
||||
* @{@link java.lang.Override} annotation.
|
||||
* @{@link Override} annotation.
|
||||
* @param ignoreOverriddenMethods set ignore overridden methods
|
||||
*/
|
||||
public void setIgnoreOverriddenMethods(boolean ignoreOverriddenMethods) {
|
||||
|
|
|
|||
|
|
@ -27,7 +27,7 @@ import com.puppycrawl.tools.checkstyle.api.AuditEvent;
|
|||
import com.puppycrawl.tools.checkstyle.api.Filter;
|
||||
|
||||
/**
|
||||
* This filter processes {@link com.puppycrawl.tools.checkstyle.api.AuditEvent}
|
||||
* This filter processes {@link AuditEvent}
|
||||
* objects based on the criteria of file, check, module id, line, and
|
||||
* column. It rejects an AuditEvent if the following match:
|
||||
* <ul>
|
||||
|
|
|
|||
|
|
@ -175,7 +175,7 @@ public class SuppressWithNearbyCommentFilter
|
|||
* @return a negative number if this tag is before the other tag,
|
||||
* 0 if they are at the same position, and a positive number if this
|
||||
* tag is after the other tag.
|
||||
* @see java.lang.Comparable#compareTo(java.lang.Object)
|
||||
* @see Comparable#compareTo(Object)
|
||||
*/
|
||||
@Override
|
||||
public int compareTo(Tag other) {
|
||||
|
|
|
|||
|
|
@ -177,7 +177,7 @@ public class SuppressionCommentFilter
|
|||
* @return a negative number if this tag is before the other tag,
|
||||
* 0 if they are at the same position, and a positive number if this
|
||||
* tag is after the other tag.
|
||||
* @see java.lang.Comparable#compareTo(java.lang.Object)
|
||||
* @see Comparable#compareTo(Object)
|
||||
*/
|
||||
@Override
|
||||
public int compareTo(Tag object) {
|
||||
|
|
|
|||
|
|
@ -84,7 +84,7 @@ class FileDrop {
|
|||
|
||||
/**
|
||||
* Constructs a {@link FileDrop} with a default light-blue border
|
||||
* and, if <var>c</var> is a {@link java.awt.Container}, recursively
|
||||
* and, if <var>c</var> is a {@link Container}, recursively
|
||||
* sets all elements contained within as drop targets, though only
|
||||
* the top level container will change borders.
|
||||
*
|
||||
|
|
|
|||
Loading…
Reference in New Issue