KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > edu > umd > cs > findbugs > ba > bcp > MatchResult


1 /*
2  * Bytecode Analysis Framework
3  * Copyright (C) 2003,2004 University of Maryland
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2.1 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public
16  * License along with this library; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18  */
19
20 package edu.umd.cs.findbugs.ba.bcp;
21
22 /**
23  * The result of matching a single PatternElement against a single instruction.
24  * Specifies the PatternElement and the (possibly updated) BindingSet.
25  * The reason we need this class is because some kinds of PatternElements,
26  * such as MatchAny, may use it to indicate that a child PatternElement was
27  * the one that actually matched the instruction.
28  *
29  * @author David Hovemeyer
30  * @see PatternElement
31  * @see BindingSet
32  */
33 public class MatchResult {
34     private PatternElement patternElement;
35     private BindingSet bindingSet;
36
37     /**
38      * Constructor.
39      *
40      * @param patternElement the PatternElement that matched the instruction
41      * @param bindingSet the possibly updated BindingSet
42      */
43     public MatchResult(PatternElement patternElement, BindingSet bindingSet) {
44         this.patternElement = patternElement;
45         this.bindingSet = bindingSet;
46     }
47
48     /**
49      * Get the PatternElement.
50      */
51     public PatternElement getPatternElement() {
52         return patternElement;
53     }
54
55     /**
56      * Get the BindingSet.
57      */
58     public BindingSet getBindingSet() {
59         return bindingSet;
60     }
61
62 }
63
64 // vim:ts=4
65
Popular Tags