Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

📖 Improve docs #729

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

📖 Improve docs #729

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 46 additions & 14 deletions docs/rules.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -199,6 +199,24 @@ when:
pattern: org.jboss.*
```

##### Java Locations

The java provider allows scoping the search down to certain source code locations. Any one of the following search locations can be used to scope down java searches:

* CONSTRUCTOR_CALL
* TYPE
* INHERITANCE
* METHOD_CALL
* ANNOTATION
* IMPLEMENTS_TYPE
* ENUM_CONSTANT
* RETURN_TYPE
* IMPORT
* VARIABLE_DECLARATION
* FIELD (declaration)
* METHOD (declaration)


##### Annotation inspection
It is possible to add a query to match against specific annotations and their elements. For instance:

Expand Down Expand Up @@ -250,22 +268,36 @@ when:
value: "http://www.example.com"
```

##### Java Locations
##### Condition patterns
The Language Server used by the Java provider is Eclipse's JDTLS. Internally, the JDTLS uses the Eclipse Java Development Toolkit,
which includes utilities for searching code in projects. In the `pattern` element of a `java.referenced` condition, we can therefore
search code using these utilities.
[The official javadocs contain all the information for building these patterns](https://help.eclipse.org/latest/index.jsp?topic=%2Forg.eclipse.jdt.doc.isv%2Freference%2Fapi%2Forg%2Feclipse%2Fjdt%2Fcore%2Fsearch%2FSearchPattern.html&anchor=createPattern(java.lang.String,int,int,int))
in the `createPattern(String, int, int, int)` section.

The java provider allows scoping the search down to certain source code locations. Any one of the following search locations can be used to scope down java searches:
Here are some examples of what can be used:

- Look for method declarations that return `java.lang.String`:
```yaml
java.referenced:
location: METHOD
pattern: '* java.lang.String'
```

- Look for a method named "method" declared on `org.konveyor.MyClass` that returns a `List` of a type that extendes `java.lang.String`:
```yaml
java.referenced:
location: METHOD
pattern: 'org.konveyor.Myclass.method(*) java.util.List<? extends java.lang.String>'
```

- Look for a class that implements `java.util.List`:
```yaml
java.referenced:
location: IMPLEMENTS_TYPE
pattern: java.util.List
```

* CONSTRUCTOR_CALL
* TYPE
* INHERITANCE
* METHOD_CALL
* ANNOTATION
* IMPLEMENTS_TYPE
* ENUM_CONSTANT
* RETURN_TYPE
* IMPORT
* VARIABLE_DECLARATION
* FIELD (declaration)
* METHOD (declaration)


##### Custom Variables
Expand Down
Loading