Return-Path: X-Original-To: apmail-commons-commits-archive@minotaur.apache.org Delivered-To: apmail-commons-commits-archive@minotaur.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 448496E3E for ; Sat, 28 May 2011 15:02:43 +0000 (UTC) Received: (qmail 53438 invoked by uid 500); 28 May 2011 15:02:43 -0000 Delivered-To: apmail-commons-commits-archive@commons.apache.org Received: (qmail 53370 invoked by uid 500); 28 May 2011 15:02:43 -0000 Mailing-List: contact commits-help@commons.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@commons.apache.org Delivered-To: mailing list commits@commons.apache.org Received: (qmail 53363 invoked by uid 99); 28 May 2011 15:02:43 -0000 Received: from athena.apache.org (HELO athena.apache.org) (140.211.11.136) by apache.org (qpsmtpd/0.29) with ESMTP; Sat, 28 May 2011 15:02:43 +0000 X-ASF-Spam-Status: No, hits=-2000.0 required=5.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Sat, 28 May 2011 15:02:41 +0000 Received: by eris.apache.org (Postfix, from userid 65534) id CF67C2388A33; Sat, 28 May 2011 15:02:21 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r1128655 - /commons/sandbox/digester3/trunk/src/main/java/org/apache/commons/digester3/ExtendedBaseRules.java Date: Sat, 28 May 2011 15:02:21 -0000 To: commits@commons.apache.org From: simonetripodi@apache.org X-Mailer: svnmailer-1.0.8 Message-Id: <20110528150221.CF67C2388A33@eris.apache.org> Author: simonetripodi Date: Sat May 28 15:02:21 2011 New Revision: 1128655 URL: http://svn.apache.org/viewvc?rev=1128655&view=rev Log: fixed javadoc Modified: commons/sandbox/digester3/trunk/src/main/java/org/apache/commons/digester3/ExtendedBaseRules.java Modified: commons/sandbox/digester3/trunk/src/main/java/org/apache/commons/digester3/ExtendedBaseRules.java URL: http://svn.apache.org/viewvc/commons/sandbox/digester3/trunk/src/main/java/org/apache/commons/digester3/ExtendedBaseRules.java?rev=1128655&r1=1128654&r2=1128655&view=diff ============================================================================== --- commons/sandbox/digester3/trunk/src/main/java/org/apache/commons/digester3/ExtendedBaseRules.java (original) +++ commons/sandbox/digester3/trunk/src/main/java/org/apache/commons/digester3/ExtendedBaseRules.java Sat May 28 15:02:21 2011 @@ -159,10 +159,7 @@ public class ExtendedBaseRules // --------------------------------------------------------- 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 + * {@inheritDoc} */ @Override public void add( String pattern, Rule rule ) @@ -173,11 +170,7 @@ public class ExtendedBaseRules } /** - * Return a List of all registered Rule instances that match the specified nesting pattern, or a zero-length List if - * there are no matches. If more than one Rule instance matches, they must be returned in the order - * originally registered through the add() method. - * - * @param pattern Nesting pattern to be matched + * {@inheritDoc} */ @Override public List match( String namespace, String pattern ) @@ -455,7 +448,12 @@ public class ExtendedBaseRules } /** - * Matching parent. + * Checks the input parentPattern contains the input key at the end. + * + * @param key The key to be found + * @param pattern FIXME unused + * @param parentPattern The pattern where looking for the key + * @return true, if {@code key} is found inside {@code parentPattern}, false otherwise */ private boolean parentMatch( String key, String pattern, String parentPattern ) { @@ -464,6 +462,10 @@ public class ExtendedBaseRules /** * Standard match. Matches the end of the pattern to the key. + * + * @param key The key to be found + * @param pattern The pattern where looking for the key + * @return true, if {@code key} is found inside {@code pattern}, false otherwise */ private boolean basicMatch( String key, String pattern ) { @@ -472,6 +474,9 @@ public class ExtendedBaseRules /** * Finds an exact ancester match for given pattern + * + * @param parentPattern The input pattern + * @return A list of {@code Rule} related to the input pattern */ private List findExactAncesterMatch( String parentPattern ) {