alvinalexander.com | career | drupal | java | mac | mysql | perl | scala | uml | unix  

Commons Digester example source code file (RegexRules.java)

This example Commons Digester source code file (RegexRules.java) is included in the DevDaily.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" TM.

Java - Commons Digester tags/keywords

abstractrulesimpl, arraylist, arraylist, illegalargumentexception, list, override, override, regexmatcher, regexrules, registeredrule, registeredrule, rule, rule, string, util

The Commons Digester RegexRules.java source code

/* $Id: RegexRules.java 992060 2010-09-02 19:09:47Z simonetripodi $
 *
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.commons.digester;

import java.util.ArrayList;
import java.util.List;

/**
 * <p>Rules implementation that uses regular expression matching for paths.

* * <p>The regex implementation is pluggable, allowing different strategies to be used. * The basic way that this class work does not vary. * All patterns are tested to see if they match the path using the regex matcher. * All those that do are return in the order which the rules were added.</p> * * @since 1.5 */ public class RegexRules extends AbstractRulesImpl { // --------------------------------------------------------- Fields /** All registered <code>Rule's */ private ArrayList<RegisteredRule> registeredRules = new ArrayList(); /** The regex strategy used by this RegexRules */ private RegexMatcher matcher; // --------------------------------------------------------- Constructor /** * Construct sets the Regex matching strategy. * * @param matcher the regex strategy to be used, not null * @throws IllegalArgumentException if the strategy is null */ public RegexRules(RegexMatcher matcher) { setRegexMatcher(matcher); } // --------------------------------------------------------- Properties /** * Gets the current regex matching strategy. */ public RegexMatcher getRegexMatcher() { return matcher; } /** * Sets the current regex matching strategy. * * @param matcher use this RegexMatcher, not null * @throws IllegalArgumentException if the strategy is null */ public void setRegexMatcher(RegexMatcher matcher) { if (matcher == null) { throw new IllegalArgumentException("RegexMatcher must not be null."); } this.matcher = matcher; } // --------------------------------------------------------- Public Methods /** * Register a new Rule instance matching the specified pattern. * * @param pattern Nesting pattern to be matched for this Rule * @param rule Rule instance to be registered */ @Override protected void registerRule(String pattern, Rule rule) { registeredRules.add(new RegisteredRule(pattern, rule)); } /** * Clear all existing Rule instance registrations. */ @Override public void clear() { registeredRules.clear(); } /** * Finds matching rules by using current regex matching strategy. * The rule associated with each path that matches is added to the list of matches. * The order of matching rules is the same order that they were added. * * @param namespaceURI Namespace URI for which to select matching rules, * or <code>null to match regardless of namespace URI * @param pattern Nesting pattern to be matched * @return a list of matching <code>Rule's */ @Override public List<Rule> match(String namespaceURI, String pattern) { // // not a particularly quick implementation // regex is probably going to be slower than string equality // so probably should have a set of strings // and test each only once // // XXX FIX ME - Time And Optimize // ArrayList<Rule> rules = new ArrayList(registeredRules.size()); for (RegisteredRule rr : registeredRules) { if (matcher.match(pattern, rr.pattern)) { rules.add(rr.rule); } } return rules; } /** * Return a List of all registered Rule instances, or a zero-length List * if there are no registered Rule instances. If more than one Rule * instance has been registered, they <strong>must be returned * in the order originally registered through the <code>add() * method. */ @Override public List<Rule> rules() { ArrayList<Rule> rules = new ArrayList(registeredRules.size()); for (RegisteredRule rr : registeredRules) { rules.add(rr.rule); } return rules; } /** Used to associate rules with paths in the rules list */ private class RegisteredRule { String pattern; Rule rule; RegisteredRule(String pattern, Rule rule) { this.pattern = pattern; this.rule = rule; } } }

Other Commons Digester examples (source code examples)

Here is a short list of links related to this Commons Digester RegexRules.java source code file:

... this post is sponsored by my books ...

#1 New Release!

FP Best Seller

 

new blog posts

 

Copyright 1998-2021 Alvin Alexander, alvinalexander.com
All Rights Reserved.

A percentage of advertising revenue from
pages under the /java/jwarehouse URI on this website is
paid back to open source projects.