Polishing

Author: jhoeller

spring-aop/src/main/java/org/springframework/aop/support/AbstractRegexpMethodPointcut.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2012 the original author or authors.
+ * Copyright 2002-2013 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -29,17 +29,16 @@
  * <ul>
  * <li>pattern: regular expression for the fully-qualified method names to match.
  * The exact regexp syntax will depend on the subclass (e.g. Perl5 regular expressions)
- * <li>patterns: alternative property taking a String array of patterns. The result will
- * be the union of these patterns.
+ * <li>patterns: alternative property taking a String array of patterns.
+ * The result will be the union of these patterns.
  * </ul>
  *
  * <p>Note: the regular expressions must be a match. For example,
  * {@code .*get.*} will match com.mycom.Foo.getBar().
  * {@code get.*} will not.
  *
- * <p>This base class is serializable. Subclasses should declare all fields transient
- * - the initPatternRepresentation method in this class will be invoked again on the
- * client side on deserialization.
+ * <p>This base class is serializable. Subclasses should declare all fields transient;
+ * the {@link #initPatternRepresentation} method will be invoked again on deserialization.
  *
  * @author Rod Johnson
  * @author Juergen Hoeller
@@ -51,10 +50,14 @@
 public abstract class AbstractRegexpMethodPointcut extends StaticMethodMatcherPointcut
 		implements Serializable {
 
-	/** Regular expressions to match */
+	/**
+	 * Regular expressions to match.
+	 */
 	private String[] patterns = new String[0];
 
-	/** Regular expressions <strong>not</strong> to match */
+	/**
+	 * Regular expressions <strong>not</strong> to match.
+	 */
 	private String[] excludedPatterns = new String[0];
 
 
@@ -69,8 +72,8 @@ public void setPattern(String pattern) {
 
 	/**
 	 * Set the regular expressions defining methods to match.
-	 * Matching will be the union of all these; if any match,
-	 * the pointcut matches.
+	 * Matching will be the union of all these; if any match, the pointcut matches.
+	 * @see #setPattern
 	 */
 	public void setPatterns(String... patterns) {
 		Assert.notEmpty(patterns, "'patterns' must not be empty");
@@ -99,8 +102,8 @@ public void setExcludedPattern(String excludedPattern) {
 
 	/**
 	 * Set the regular expressions defining methods to match for exclusion.
-	 * Matching will be the union of all these; if any match,
-	 * the pointcut matches.
+	 * Matching will be the union of all these; if any match, the pointcut matches.
+	 * @see #setExcludedPattern
 	 */
 	public void setExcludedPatterns(String... excludedPatterns) {
 		Assert.notEmpty(excludedPatterns, "'excludedPatterns' must not be empty");
@@ -173,18 +176,18 @@ protected boolean matchesPattern(String signatureString) {
 	protected abstract void initExcludedPatternRepresentation(String[] patterns) throws IllegalArgumentException;
 
 	/**
-	 * Does the pattern at the given index match this string?
-	 * @param pattern {@code String} pattern to match
-	 * @param patternIndex index of pattern from 0
-	 * @return {@code true} if there is a match, else {@code false}.
+	 * Does the pattern at the given index match the given String?
+	 * @param pattern the {@code String} pattern to match
+	 * @param patternIndex index of pattern (starting from 0)
+	 * @return {@code true} if there is a match, {@code false} otherwise
 	 */
 	protected abstract boolean matches(String pattern, int patternIndex);
 
 	/**
-	 * Does the exclusion pattern at the given index match this string?
-	 * @param pattern {@code String} pattern to match.
-	 * @param patternIndex index of pattern starting from 0.
-	 * @return {@code true} if there is a match, else {@code false}.
+	 * Does the exclusion pattern at the given index match the given String?
+	 * @param pattern the {@code String} pattern to match
+	 * @param patternIndex index of pattern (starting from 0)
+	 * @return {@code true} if there is a match, {@code false} otherwise
 	 */
 	protected abstract boolean matchesExclusion(String pattern, int patternIndex);