StreamEscape (SpotBugs 4.3.0 API)

java.lang.Object
- 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

Fields
Modifier and Type Field Description

Stream source

Location target

Constructor Summary

Constructors
Constructor Description

StreamEscape(Stream source, Location target)
Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`compareTo(StreamEscape other)`
`boolean`	`equals(java.lang.Object o)`
`int`	`hashCode()`
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, 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>
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object