edu.umd.cs.findbugs.detect
Class StreamEscape

java.lang.Object
  extended by edu.umd.cs.findbugs.detect.StreamEscape
All Implemented Interfaces:
java.lang.Comparable<StreamEscape>

public class StreamEscape
extends java.lang.Object
implements java.lang.Comparable<StreamEscape>

A StreamEscape is an object representing the escape of a Stream to a called method. The "source" is the Stream which is escaping. The "target" is the Location where the stream instance escapes.


Field Summary
 Stream source
           
 Location target
           
 
Constructor Summary
StreamEscape(Stream source, Location target)
          Constructor.
 
Method Summary
 int compareTo(StreamEscape other)
           
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

source

public final Stream source

target

public final Location target
Constructor Detail

StreamEscape

public StreamEscape(Stream source,
                    Location target)
Constructor.

Parameters:
source - Location where stream is opened
target - Location where stream escapes by being passed to a method
Method Detail

compareTo

public int compareTo(StreamEscape other)
Specified by:
compareTo in interface java.lang.Comparable<StreamEscape>

toString

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