1 /*
2 * Copyright (c) 2011-2024 Qulice.com
3 *
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met: 1) Redistributions of source code must retain the above
9 * copyright notice, this list of conditions and the following
10 * disclaimer. 2) Redistributions in binary form must reproduce the above
11 * copyright notice, this list of conditions and the following
12 * disclaimer in the documentation and/or other materials provided
13 * with the distribution. 3) Neither the name of the Qulice.com nor
14 * the names of its contributors may be used to endorse or promote
15 * products derived from this software without specific prior written
16 * permission.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT
20 * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
21 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
22 * THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
23 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
24 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
25 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
27 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
29 * OF THE POSSIBILITY OF SUCH DAMAGE.
30 */
31 package com.qulice.checkstyle;
32
33 import com.puppycrawl.tools.checkstyle.api.FileText;
34 import com.puppycrawl.tools.checkstyle.checks.regexp.RegexpMultilineCheck;
35 import java.io.File;
36 import java.util.regex.Pattern;
37
38 /**
39 * Performs multiline regexp match only if a regexp condition passes.
40 * @since 0.5
41 */
42 public final class ConditionalRegexpMultilineCheck extends
43 RegexpMultilineCheck {
44 /**
45 * Condition that has to pass.
46 */
47 private Pattern condition = Pattern.compile(".");
48
49 @Override
50 public void processFiltered(final File file, final FileText lines) {
51 boolean found = false;
52 for (final String line: lines.toLinesArray()) {
53 if (this.condition.matcher(line).find()) {
54 found = true;
55 break;
56 }
57 }
58 if (found) {
59 super.processFiltered(file, lines);
60 }
61 }
62
63 /**
64 * Condition regexp that has to match before checking the core one.
65 * @param cond Regexp that has to match in file.
66 */
67 public void setCondition(final String cond) {
68 this.condition = Pattern.compile(cond);
69 }
70 }