# Finds flow between two methods

> import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import RunRecipe from '@site/src/components/RunRecipe';

# Finds flow between two methods

**org.openrewrite.analysis.search.FindFlowBetweenMethods**

_Takes two patterns for the start/end methods to find flow between._

## Recipe source

[GitHub: FindFlowBetweenMethods.java](https://github.com/openrewrite/rewrite-analysis/blob/main/src/main/java/org/openrewrite/analysis/search/FindFlowBetweenMethods.java),
[Issue Tracker](https://github.com/openrewrite/rewrite-analysis/issues),
[Maven Central](https://central.sonatype.com/artifact/org.openrewrite.meta/rewrite-analysis/)

This recipe is available under the [Apache License Version 2.0](https://www.apache.org/licenses/LICENSE-2.0).

## Options

| Type | Name | Description | Example |
| --- | --- | --- | --- |
| `String` | startMethodPattern | A method pattern that is used to find matching the start point's method invocations. | `java.util.List add(..)` |
| `Boolean` | startMatchOverrides | *Optional*. When enabled, find methods that are overrides of the method pattern. |  |
| `String` | endMethodPattern | A method pattern that is used to find matching the end point's method invocations. | `java.util.List add(..)` |
| `Boolean` | endMatchOverrides | *Optional*. When enabled, find methods that are overrides of the method pattern. |  |
| `String` | target | The part of the method flow should traverse to Valid options: `Select`, `Arguments`, `Both` |  |
| `String` | flow | When enabled, show the data or taint flow of the method invocation. Valid options: `Data`, `Taint` |  |

## Example

###### Parameters
| Parameter | Value |
| --- | --- |
|startMethodPattern|`java.util.LinkedList <constructor>()`|
|startMatchOverrides|`true`|
|endMethodPattern|`java.util.LinkedList remove()`|
|endMatchOverrides|`true`|
|target|`Select`|
|flow|`Taint`|

<Tabs groupId="beforeAfter">
<TabItem value="java" label="java">

###### Before
```java

class Test {
    void test() {
        LinkedList<Integer> l = new LinkedList<>();
        l.add(5);
        System.out.println(l);
        l.remove();
    }
}
```

###### After
```java

class Test {
    void test() {
        LinkedList<Integer> l = /*~~(source)~~>*/new LinkedList<>();
        /*~~>*/l.add(5);
        System.out.println(/*~~>*/l);
        /*~~(sink)~~>*/l.remove();
    }
}
```

</TabItem>
<TabItem value="diff" label="Diff" >

```diff
@@ -4,4 +4,4 @@
class Test {
    void test() {
-       LinkedList<Integer> l = new LinkedList<>();
-       l.add(5);
-       System.out.println(l);
-       l.remove();
+       LinkedList<Integer> l = /*~~(source)~~>*/new LinkedList<>();
+       /*~~>*/l.add(5);
+       System.out.println(/*~~>*/l);
+       /*~~(sink)~~>*/l.remove();
    }
```
</TabItem>
</Tabs>

## Usage

This recipe has required configuration parameters. Recipes with required configuration parameters cannot be activated directly (unless you are running them via the Moderne CLI). To activate this recipe you must create a new recipe which fills in the required parameters. In your `rewrite.yml` create a new recipe with a unique name. For example: `com.yourorg.FindFlowBetweenMethodsExample`.
Here's how you can define and customize such a recipe within your rewrite.yml:
```yaml title="rewrite.yml"
---
type: specs.openrewrite.org/v1beta/recipe
name: com.yourorg.FindFlowBetweenMethodsExample
displayName: Finds flow between two methods example
recipeList:
  - org.openrewrite.analysis.search.FindFlowBetweenMethods:
      startMethodPattern: java.util.List add(..)
      endMethodPattern: java.util.List add(..)
      target: null
      flow: null
```

<RunRecipe
  recipeName="org.openrewrite.analysis.search.FindFlowBetweenMethods"
  displayName="Finds flow between two methods"
  groupId="org.openrewrite.meta"
  artifactId="rewrite-analysis"
  versionKey="VERSION_ORG_OPENREWRITE_META_REWRITE_ANALYSIS"
  requiresConfiguration
  cliOptions={' --recipe-option "startMethodPattern=java.util.List add(..)" --recipe-option "endMethodPattern=java.util.List add(..)" --recipe-option "target=null" --recipe-option "flow=null"'}
  hasDataTables
/>

## See how this recipe works across multiple open-source repositories

<RecipeCallout link="https://app.moderne.io/recipes/org.openrewrite.analysis.search.FindFlowBetweenMethods" />

The community edition of the Moderne platform enables you to easily run recipes across thousands of open-source repositories.

Please [contact Moderne](https://moderne.io/product) for more information about safely running the recipes on your own codebase in a private SaaS.
## Data Tables

<Tabs groupId="data-tables">
<TabItem value="org.openrewrite.table.SourcesFileResults" label="SourcesFileResults">

### Source files that had results
**org.openrewrite.table.SourcesFileResults**

_Source files that were modified by the recipe run._

| Column Name | Description |
| ----------- | ----------- |
| Source path before the run | The source path of the file before the run. `null` when a source file was created during the run. |
| Source path after the run | A recipe may modify the source path. This is the path after the run. `null` when a source file was deleted during the run. |
| Parent of the recipe that made changes | In a hierarchical recipe, the parent of the recipe that made a change. Empty if this is the root of a hierarchy or if the recipe is not hierarchical at all. |
| Recipe that made changes | The specific recipe that made a change. |
| Estimated time saving | An estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds. |
| Cycle | The recipe cycle in which the change was made. |

</TabItem>

<TabItem value="org.openrewrite.table.SearchResults" label="SearchResults">

### Source files that had search results
**org.openrewrite.table.SearchResults**

_Search results that were found during the recipe run._

| Column Name | Description |
| ----------- | ----------- |
| Source path of search result before the run | The source path of the file with the search result markers present. |
| Source path of search result after run the run | A recipe may modify the source path. This is the path after the run. `null` when a source file was deleted during the run. |
| Result | The trimmed printed tree of the LST element that the marker is attached to. |
| Description | The content of the description of the marker. |
| Recipe that added the search marker | The specific recipe that added the Search marker. |

</TabItem>

<TabItem value="org.openrewrite.table.SourcesFileErrors" label="SourcesFileErrors">

### Source files that errored on a recipe
**org.openrewrite.table.SourcesFileErrors**

_The details of all errors produced by a recipe run._

| Column Name | Description |
| ----------- | ----------- |
| Source path | The file that failed to parse. |
| Recipe that made changes | The specific recipe that made a change. |
| Stack trace | The stack trace of the failure. |

</TabItem>

<TabItem value="org.openrewrite.table.RecipeRunStats" label="RecipeRunStats">

### Recipe performance
**org.openrewrite.table.RecipeRunStats**

_Statistics used in analyzing the performance of recipes._

| Column Name | Description |
| ----------- | ----------- |
| The recipe | The recipe whose stats are being measured both individually and cumulatively. |
| Source file count | The number of source files the recipe ran over. |
| Source file changed count | The number of source files which were changed in the recipe run. Includes files created, deleted, and edited. |
| Cumulative scanning time (ns) | The total time spent across the scanning phase of this recipe. |
| Max scanning time (ns) | The max time scanning any one source file. |
| Cumulative edit time (ns) | The total time spent across the editing phase of this recipe. |
| Max edit time (ns) | The max time editing any one source file. |

</TabItem>

</Tabs>