01: //////////////////////////////////////////////////////////////////////////////
02: // Clirr: compares two versions of a java library for binary compatibility
03: // Copyright (C) 2003 - 2005 Lars Kühne
04: //
05: // This library is free software; you can redistribute it and/or
06: // modify it under the terms of the GNU Lesser General Public
07: // License as published by the Free Software Foundation; either
08: // version 2.1 of the License, or (at your option) any later version.
09: //
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: package net.sf.clirr.core;
20:
21: import net.sf.clirr.core.spi.Scope;
22: import net.sf.clirr.core.spi.Scoped;
23:
24: /**
25: * Selects zero or more java scope values (public, protected, package,
26: * private). An instance of this class is used when comparing two versions
27: * of an application to indicate what items are of interest. When the target
28: * audience is "normal" users of the applications, only changes to items
29: * which have public or protected scope are relevant. When the audience is
30: * developers of the applications, then package-scope and private-scope
31: * changes are also of interest.
32: *
33: * @author Simon Kitching
34: */
35: public final class ScopeSelector {
36: private Scope scope = Scope.PROTECTED;
37:
38: /**
39: * Construct an instance which selects public and protected objects and
40: * ignores package and private objects. The selectXXX methods can later
41: * be used to adjust this default behaviour.
42: */
43: public ScopeSelector() {
44: }
45:
46: /**
47: * Construct an instance which selects public and protected objects and
48: * ignores package and private objects. The selectXXX methods can later
49: * be used to adjust this default behaviour.
50: */
51: public ScopeSelector(Scope scope) {
52: this .scope = scope;
53: }
54:
55: /** Specify which scope objects are of interest. */
56: public void setScope(Scope scope) {
57: this .scope = scope;
58: }
59:
60: /**
61: * Get the scope that this object is configured with.
62: */
63: public Scope getScope() {
64: return scope;
65: }
66:
67: /**
68: * Return a string which indicates what scopes this object will consider
69: * to be selected (ie relevant).
70: */
71: public String toString() {
72: return scope.getDesc();
73: }
74:
75: /**
76: * Given a scoped object, return true if this object's scope is one of the
77: * values this object is configured to match.
78: *
79: * @param scoped is the object whose scope is to be checked.
80: * @return true if the object is selected.
81: */
82: public boolean isSelected(Scoped scoped) {
83: return !scoped.getEffectiveScope().isLessVisibleThan(scope);
84: }
85:
86: /**
87: * Return true if objects of the specified scope, or more visible,
88: * are selected by this selector.
89: *
90: * @param scope is the scope being checked
91: * @return true if objects of the specified scope are selected.
92: */
93: public boolean isSelected(Scope scope) {
94: return !scope.isLessVisibleThan(this.scope);
95: }
96:
97: }
|