Package edu.umd.cs.findbugs.ba.obl
Class MatchMethodEntry
- java.lang.Object
-
- 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.
-
-
Field Summary
Fields Modifier and Type Field Description private ObligationPolicyDatabaseActionType
action
private ObligationPolicyDatabaseEntryType
entryType
private boolean
isStatic
private StringMatcher
methodName
private Obligation[]
obligations
private TypeMatcher
receiverType
private StringMatcher
signature
-
Constructor Summary
Constructors Constructor Description MatchMethodEntry(XMethod xmethod, ObligationPolicyDatabaseActionType action, ObligationPolicyDatabaseEntryType entryType, Obligation... obligations)
Constructor.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.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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.java.util.Collection<Obligation>
getAllObligations()
ObligationPolicyDatabaseEntryType
getEntryType()
Get the type of entry (STRONG or WEAK).java.lang.String
toString()
-
-
-
Field Detail
-
receiverType
private final TypeMatcher receiverType
-
methodName
private final StringMatcher methodName
-
signature
private final StringMatcher signature
-
isStatic
private final boolean isStatic
-
action
private final ObligationPolicyDatabaseActionType action
-
obligations
private final Obligation[] obligations
-
entryType
private final ObligationPolicyDatabaseEntryType entryType
-
-
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 XMethodaction
- ActionType (ADD or DEL, depending on whether obligation is added or deleted)entryType
- entry typeobligations
- 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 methodsignature
- StringMatcher to match signature of called methodisStatic
- true if matched method must be static, false otherwiseaction
- ActionType (ADD or DEL, depending on whether obligation is added or deleted)entryType
- entry typeobligations
- Obligation to be added or deleted
-
-
Method Detail
-
getAllObligations
public java.util.Collection<Obligation> getAllObligations()
- Specified by:
getAllObligations
in interfaceObligationPolicyDatabaseEntry
-
getEntryType
public ObligationPolicyDatabaseEntryType getEntryType()
Description copied from interface:ObligationPolicyDatabaseEntry
Get the type of entry (STRONG or WEAK).- Specified by:
getEntryType
in interfaceObligationPolicyDatabaseEntry
-
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 interfaceObligationPolicyDatabaseEntry
- Parameters:
receiverType
- receiver type of called methodmethodName
- name of called methodsignature
- signature of called methodisStatic
- true if called method is static, false otherwiseactionList
- 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 classjava.lang.Object
-
-