KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > edu > umd > cs > findbugs > detect > StreamFactory


1 /*
2  * FindBugs - Find bugs in Java programs
3  * Copyright (C) 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.detect;
21
22 import org.apache.bcel.generic.ConstantPoolGen;
23 import org.apache.bcel.generic.ObjectType;
24
25 import edu.umd.cs.findbugs.ba.Location;
26 import edu.umd.cs.findbugs.ba.RepositoryLookupFailureCallback;
27
28 /**
29  * An object that examines a Location and determines
30  * if a Stream is created there.
31  */
32 public interface StreamFactory {
33     /**
34      * Determine if a Stream is created at given location.
35      *
36      * @param location the Location
37      * @param type the ObjectType associated with the instruction at the location;
38      * the StreamResourceTracker prescreens for TypedInstructions
39      * that are associated with ObjectTypes, since they are
40      * the only instructions that could conceivably create a
41      * stream object
42      * @param cpg the ConstantPoolGen for the method
43      * @param lookupFailureCallback used to report missing
44      * classes in the class hierarchy
45      * @return a Stream created at the Location,
46      * or null if no stream is created there
47      */
48     public Stream createStream(Location location, ObjectType type, ConstantPoolGen cpg,
49                                RepositoryLookupFailureCallback lookupFailureCallback);
50 }
51
52 // vim:ts=3
53
Popular Tags