Package edu.umd.cs.findbugs.detect
Class MethodReturnValueStreamFactory
java.lang.Object
edu.umd.cs.findbugs.detect.MethodReturnValueStreamFactory
- All Implemented Interfaces:
StreamFactory
StreamFactory for streams that are created as the result of calling a method
on an object.
-
Constructor Summary
ConstructorDescriptionMethodReturnValueStreamFactory
(String baseClass, String methodName, String methodSig) Constructor.MethodReturnValueStreamFactory
(String baseClass, String methodName, String methodSig, String bugType) Constructor. -
Method Summary
Modifier and TypeMethodDescriptioncreateStream
(Location location, org.apache.bcel.generic.ObjectType type, org.apache.bcel.generic.ConstantPoolGen cpg, RepositoryLookupFailureCallback lookupFailureCallback) Determine if a Stream is created at given location.
-
Constructor Details
-
MethodReturnValueStreamFactory
Constructor. The Streams created will be marked as uninteresting.- Parameters:
baseClass
- base class through which the method will be called (we check instances of the base class and all subtypes)methodName
- name of the method calledmethodSig
- signature of the method called
-
MethodReturnValueStreamFactory
public MethodReturnValueStreamFactory(String baseClass, String methodName, String methodSig, String bugType) Constructor. The Streams created will be marked as interesting.- Parameters:
baseClass
- base class through which the method will be called (we check instances of the base class and all subtypes)methodName
- name of the method calledmethodSig
- signature of the method calledbugType
- the bug type that should be reported if the stream is not closed on all paths out of the method
-
-
Method Details
-
createStream
public Stream createStream(Location location, org.apache.bcel.generic.ObjectType type, org.apache.bcel.generic.ConstantPoolGen cpg, RepositoryLookupFailureCallback lookupFailureCallback) Description copied from interface:StreamFactory
Determine if a Stream is created at given location.- Specified by:
createStream
in interfaceStreamFactory
- Parameters:
location
- the Locationtype
- the ObjectType associated with the instruction at the location; the StreamResourceTracker prescreens for TypedInstructions that are associated with ObjectTypes, since they are the only instructions that could conceivably create a stream objectcpg
- the ConstantPoolGen for the methodlookupFailureCallback
- used to report missing classes in the class hierarchy- Returns:
- a Stream created at the Location, or null if no stream is created there
-