blob: c6a9a39d9a570313da68e7542a036bf4bacd4578 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<main role="main">
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span><a id="line.1">/*</a>
<span class="sourceLineNo">002</span><a id="line.2"> * Licensed to the Apache Software Foundation (ASF) under one</a>
<span class="sourceLineNo">003</span><a id="line.3"> * or more contributor license agreements. See the NOTICE file</a>
<span class="sourceLineNo">004</span><a id="line.4"> * distributed with this work for additional information</a>
<span class="sourceLineNo">005</span><a id="line.5"> * regarding copyright ownership. The ASF licenses this file</a>
<span class="sourceLineNo">006</span><a id="line.6"> * to you under the Apache License, Version 2.0 (the</a>
<span class="sourceLineNo">007</span><a id="line.7"> * "License"); you may not use this file except in compliance</a>
<span class="sourceLineNo">008</span><a id="line.8"> * with the License. You may obtain a copy of the License at</a>
<span class="sourceLineNo">009</span><a id="line.9"> *</a>
<span class="sourceLineNo">010</span><a id="line.10"> * http://www.apache.org/licenses/LICENSE-2.0</a>
<span class="sourceLineNo">011</span><a id="line.11"> *</a>
<span class="sourceLineNo">012</span><a id="line.12"> * Unless required by applicable law or agreed to in writing,</a>
<span class="sourceLineNo">013</span><a id="line.13"> * software distributed under the License is distributed on an</a>
<span class="sourceLineNo">014</span><a id="line.14"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</a>
<span class="sourceLineNo">015</span><a id="line.15"> * KIND, either express or implied. See the License for the</a>
<span class="sourceLineNo">016</span><a id="line.16"> * specific language governing permissions and limitations</a>
<span class="sourceLineNo">017</span><a id="line.17"> * under the License.</a>
<span class="sourceLineNo">018</span><a id="line.18"> */</a>
<span class="sourceLineNo">019</span><a id="line.19">package org.apache.shiro.util;</a>
<span class="sourceLineNo">020</span><a id="line.20"></a>
<span class="sourceLineNo">021</span><a id="line.21">import java.util.regex.Pattern;</a>
<span class="sourceLineNo">022</span><a id="line.22">import java.util.regex.Matcher;</a>
<span class="sourceLineNo">023</span><a id="line.23"></a>
<span class="sourceLineNo">024</span><a id="line.24">/**</a>
<span class="sourceLineNo">025</span><a id="line.25"> * {@code PatternMatcher} implementation that uses standard {@link java.util.regex} objects.</a>
<span class="sourceLineNo">026</span><a id="line.26"> *</a>
<span class="sourceLineNo">027</span><a id="line.27"> * @see Pattern</a>
<span class="sourceLineNo">028</span><a id="line.28"> * @since 1.0</a>
<span class="sourceLineNo">029</span><a id="line.29"> */</a>
<span class="sourceLineNo">030</span><a id="line.30">public class RegExPatternMatcher implements PatternMatcher {</a>
<span class="sourceLineNo">031</span><a id="line.31"></a>
<span class="sourceLineNo">032</span><a id="line.32"> private static final int DEFAULT = Pattern.DOTALL;</a>
<span class="sourceLineNo">033</span><a id="line.33"></a>
<span class="sourceLineNo">034</span><a id="line.34"> private static final int CASE_INSENSITIVE = DEFAULT | Pattern.CASE_INSENSITIVE;</a>
<span class="sourceLineNo">035</span><a id="line.35"></a>
<span class="sourceLineNo">036</span><a id="line.36"> private boolean caseInsensitive = false;</a>
<span class="sourceLineNo">037</span><a id="line.37"></a>
<span class="sourceLineNo">038</span><a id="line.38"> /**</a>
<span class="sourceLineNo">039</span><a id="line.39"> * Simple implementation that merely uses the default pattern comparison logic provided by the</a>
<span class="sourceLineNo">040</span><a id="line.40"> * JDK.</a>
<span class="sourceLineNo">041</span><a id="line.41"> * &lt;p/&gt;This implementation essentially executes the following:</a>
<span class="sourceLineNo">042</span><a id="line.42"> * &lt;pre&gt;</a>
<span class="sourceLineNo">043</span><a id="line.43"> * Pattern p = Pattern.compile(pattern, Pattern.DOTALL);</a>
<span class="sourceLineNo">044</span><a id="line.44"> * Matcher m = p.matcher(source);</a>
<span class="sourceLineNo">045</span><a id="line.45"> * return m.matches();&lt;/pre&gt;</a>
<span class="sourceLineNo">046</span><a id="line.46"> * @param pattern the pattern to match against</a>
<span class="sourceLineNo">047</span><a id="line.47"> * @param source the source to match</a>
<span class="sourceLineNo">048</span><a id="line.48"> * @return {@code true} if the source matches the required pattern, {@code false} otherwise.</a>
<span class="sourceLineNo">049</span><a id="line.49"> */</a>
<span class="sourceLineNo">050</span><a id="line.50"> public boolean matches(String pattern, String source) {</a>
<span class="sourceLineNo">051</span><a id="line.51"> if (pattern == null) {</a>
<span class="sourceLineNo">052</span><a id="line.52"> throw new IllegalArgumentException("pattern argument cannot be null.");</a>
<span class="sourceLineNo">053</span><a id="line.53"> }</a>
<span class="sourceLineNo">054</span><a id="line.54"> Pattern p = Pattern.compile(pattern, caseInsensitive ? CASE_INSENSITIVE : DEFAULT);</a>
<span class="sourceLineNo">055</span><a id="line.55"> Matcher m = p.matcher(source);</a>
<span class="sourceLineNo">056</span><a id="line.56"> return m.matches();</a>
<span class="sourceLineNo">057</span><a id="line.57"> }</a>
<span class="sourceLineNo">058</span><a id="line.58"></a>
<span class="sourceLineNo">059</span><a id="line.59"> /**</a>
<span class="sourceLineNo">060</span><a id="line.60"> * Returns true if regex match should be case-insensitive.</a>
<span class="sourceLineNo">061</span><a id="line.61"> * @return true if regex match should be case-insensitive.</a>
<span class="sourceLineNo">062</span><a id="line.62"> */</a>
<span class="sourceLineNo">063</span><a id="line.63"> public boolean isCaseInsensitive() {</a>
<span class="sourceLineNo">064</span><a id="line.64"> return caseInsensitive;</a>
<span class="sourceLineNo">065</span><a id="line.65"> }</a>
<span class="sourceLineNo">066</span><a id="line.66"></a>
<span class="sourceLineNo">067</span><a id="line.67"> /**</a>
<span class="sourceLineNo">068</span><a id="line.68"> * Adds the Pattern.CASE_INSENSITIVE flag when compiling patterns.</a>
<span class="sourceLineNo">069</span><a id="line.69"> * @param caseInsensitive true if patterns should match case-insensitive.</a>
<span class="sourceLineNo">070</span><a id="line.70"> */</a>
<span class="sourceLineNo">071</span><a id="line.71"> public void setCaseInsensitive(boolean caseInsensitive) {</a>
<span class="sourceLineNo">072</span><a id="line.72"> this.caseInsensitive = caseInsensitive;</a>
<span class="sourceLineNo">073</span><a id="line.73"> }</a>
<span class="sourceLineNo">074</span><a id="line.74">}</a>
</pre>
</div>
</main>
</body>
</html>