/*
 * Copyright 2018, TeamDev. All rights reserved.
 *
 * Redistribution and use in source and/or binary forms, with or without
 * modification, must retain the above copyright notice and the following
 * disclaimer.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

package io.spine.tools.check;

import com.google.errorprone.VisitorState;
import com.sun.source.tree.Tree;
import io.spine.annotation.Internal;

/**
 * A basic interface to match the given expression against some known case of the {@link
 * com.google.errorprone.BugPattern}.
 *
 * @param <T> the expression {@code Tree}
 * @author Dmytro Kuzmin
 */
@Internal
public interface BugPatternMatcher<T extends Tree> {

    /**
     * Checks if the given expression matches the case of {@link com.google.errorprone.BugPattern}
     * stored in this class.
     *
     * <p>This method should be used from inside the {@link
     * com.google.errorprone.bugpatterns.BugChecker} implementations, so the Error Prone scanners
     * provide the proper {@code Tree} and {@code VisitorState} corresponding to the currently
     * assessed expression.
     *
     * @param tree  the expression {@code Tree}
     * @param state the current {@code VisitorState}
     * @return {@code true} if the expression matches the bug pattern and {@code false} otherwise
     */
    boolean matches(T tree, VisitorState state);

    /**
     * Obtains a {@code Fixer} for the case of the {@link com.google.errorprone.BugPattern} stored
     * in this class.
     *
     * @return the {@code Fixer} for the stored bug pattern
     */
    Fixer<T> getFixer();
}

@@ -1478,24 +1478,16 @@
 hes the 
-case of 
 %7B@link c
@@ -1518,24 +1518,29 @@
 Pattern%7D
+ case
 %0A     * 
 stored i
@@ -1535,17 +1535,20 @@
   * 
-stored in
+processed by
  thi
@@ -1575,18 +1575,17 @@
  * %3Cp%3ETh
-is
+e
  method 
@@ -2210,23 +2210,16 @@
 ern%7D
- stored
 %0A     * 
 in t
@@ -2214,18 +2214,28 @@
 %0A     * 
-in
+processed by
  this cl
@@ -2291,12 +2291,15 @@
 the 
-stor
+process
 ed b
@@ -2308,16 +2308,21 @@
  pattern
+ case
 %0A     */

Clarify doc