FindBugs™ 1.3.9

edu.umd.cs.findbugs.ba.obl
Class MatchMethodEntry

java.lang.Object
  extended by edu.umd.cs.findbugs.ba.obl.MatchMethodEntry
All Implemented Interfaces:
ObligationPolicyDatabaseEntry

public class MatchMethodEntry
extends java.lang.Object
implements ObligationPolicyDatabaseEntry

An ObligationPolicyDatabaseEntry which creates or deletes an obligation based on a call to a specified method.

Author:
David Hovemeyer

Constructor Summary
MatchMethodEntry(MethodDescriptor method, ObligationPolicyDatabaseActionType action, ObligationPolicyDatabaseEntryType entryType, Obligation... obligations)
           
MatchMethodEntry(TypeMatcher receiverType, StringMatcher methodName, StringMatcher signature, boolean isStatic, ObligationPolicyDatabaseActionType action, ObligationPolicyDatabaseEntryType entryType, Obligation... obligations)
          Constructor.
MatchMethodEntry(XMethod xmethod, ObligationPolicyDatabaseActionType action, ObligationPolicyDatabaseEntryType entryType, Obligation... obligations)
          Constructor.
 
Method Summary
 boolean getActions(org.apache.bcel.generic.ReferenceType receiverType, java.lang.String methodName, java.lang.String signature, boolean isStatic, java.util.Collection<ObligationPolicyDatabaseAction> actionList)
          Get the ObligationPolicyDatabaseActions that should be applied when the method described by the parameters is called.
 ObligationPolicyDatabaseEntryType getEntryType()
          Get the type of entry (STRONG or WEAK).
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

MatchMethodEntry

public MatchMethodEntry(XMethod xmethod,
                        ObligationPolicyDatabaseActionType action,
                        ObligationPolicyDatabaseEntryType entryType,
                        Obligation... obligations)
Constructor. Creates an entry which matches the given XMethod.

Parameters:
xmethod - an XMethod
action - ActionType (ADD or DEL, depending on whether obligation is added or deleted)
entryType - entry type
obligations - Obligation to be added or deleted

MatchMethodEntry

public MatchMethodEntry(MethodDescriptor method,
                        ObligationPolicyDatabaseActionType action,
                        ObligationPolicyDatabaseEntryType entryType,
                        Obligation... obligations)

MatchMethodEntry

public MatchMethodEntry(TypeMatcher receiverType,
                        StringMatcher methodName,
                        StringMatcher signature,
                        boolean isStatic,
                        ObligationPolicyDatabaseActionType action,
                        ObligationPolicyDatabaseEntryType entryType,
                        Obligation... obligations)
Constructor.

Parameters:
receiverType - TypeMatcher to match the receiver type (or class containing static method)
methodName - StringMatcher to match name of called method
signature - StringMatcher to match signature of called method
isStatic - true if matched method must be static, false otherwise
action - ActionType (ADD or DEL, depending on whether obligation is added or deleted)
entryType - entry type
obligations - Obligation to be added or deleted
Method Detail

getEntryType

public ObligationPolicyDatabaseEntryType getEntryType()
Description copied from interface: ObligationPolicyDatabaseEntry
Get the type of entry (STRONG or WEAK).

Specified by:
getEntryType in interface ObligationPolicyDatabaseEntry

getActions

public boolean getActions(org.apache.bcel.generic.ReferenceType receiverType,
                          java.lang.String methodName,
                          java.lang.String signature,
                          boolean isStatic,
                          java.util.Collection<ObligationPolicyDatabaseAction> actionList)
Description copied from interface: ObligationPolicyDatabaseEntry
Get the ObligationPolicyDatabaseActions that should be applied when the method described by the parameters is called.

Specified by:
getActions in interface ObligationPolicyDatabaseEntry
Parameters:
receiverType - receiver type of called method
methodName - name of called method
signature - signature of called method
isStatic - true if called method is static, false otherwise
actionList - List of ObligationPolicyDatabaseActions to be applied when a called method is matched by this entry
Returns:
true if one or more actions were added, false if no actions were added

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

FindBugs™ 1.3.9

FindBugs™ is licenced under the LGPL. Copyright © 2006 University of Maryland.