Skip to content

Updated Readme with Linter Options for Encapsulation Checks (OaM) #123

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

Open
WolframPfeifer wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Updated Readme with Linter Options for Encapsulation Checks (OaM) #123

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
dc974a1
added some annotations such that debug output with System.out.println…
WolframPfeifer Oct 24, 2024
1168ed2
applied type annotation to array instead of component type
WolframPfeifer Nov 2, 2024
49f8c4b
added remarks about checkOaM linter option
WolframPfeifer Nov 28, 2024
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
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,14 @@ cd universe
./.ci-build.sh
````

## Supported Options

Linter options:
* `checkOaM` Enables encapsulation checks (Owner-as-Modifier). Without this option, only topology checks are performed,
so make sure to enable set this option if it should be checked that `@Any` references are not used for writing.

Linter options can be passed via `-Alint=<option>`. Note that everything except the last option given in that way is
ignored (see https://checkerframework.org/manual/#alint for more details)!

## Type checking example

Expand Down
11 changes: 11 additions & 0 deletions src/main/java/universe/jdk.astub
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,16 @@
import universe.qual.Any;

package java.io;

class PrintStream {
public void print(char @Any [] s);
public void print(@Any String s);
public void print(@Any Object obj);
public void println(char @Any [] x);
public void println(@Any String s);
public void println(@Any Object x);
}

package java.lang;

class Object {
Expand Down