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.

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

Automata4j-API: Fix javadoc and code enhancements #4

Merged
merged 14 commits into from
Aug 13, 2023
Merged

Conversation

pavly-gerges
Copy link
Member

This PR fixes and enhances the core API code and Javadoc, here are the most valuable additions:

  • Corrected the way TransitionalManager#transit(TransitionPath, TransitionalListener) should work by using both the present state and the next state of the specified TranstionPath.
  • Added AutomataLogger a general-purpose logging utility.
  • Suppressed raw types warnings on the DeterministicManager.
  • Some code enhancements on the core API.

@pavly-gerges pavly-gerges added documentation Improvements or additions to documentation enhancement New feature or request labels Aug 13, 2023
@sonatype-lift
Copy link

sonatype-lift bot commented Aug 13, 2023

Sonatype Lift is retiring

Sonatype Lift will be retiring on Sep 12, 2023, with its analysis stopping on Aug 12, 2023. We understand that this news may come as a disappointment, and Sonatype is committed to helping you transition off it seamlessly. If you’d like to retain your data, please export your issues from the web console.
We are extremely grateful and thank you for your support over the years.

📖 Read about the impacts and timeline

@pavly-gerges pavly-gerges added the core Core API related stuff label Aug 13, 2023
transit(transitionPath.getPresentState().getInput(), new TransitionListener() {
@Override
@SuppressWarnings("all")
public <I, O> void onTransition(AutoState<I, O> presentState) {
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

56% of developers fix this issue

TypeParameterShadowing: Found aliased type parameters: I declared in transit


ℹ️ Expand to see all @sonatype-lift commands

You can reply with the following commands. For example, reply with @sonatype-lift ignoreall to leave out all findings.

Command Usage
@sonatype-lift ignore Leave out the above finding from this PR
@sonatype-lift ignoreall Leave out all the existing findings from this PR
@sonatype-lift exclude <file|issue|path|tool> Exclude specified file|issue|path|tool from Lift findings by updating your config.toml file

Note: When talking to LiftBot, you need to refresh the page to see its response.
Click here to add LiftBot to another repo.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sonatype-lift ignore

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've recorded this as ignored for this pull request.
If you change your mind, just comment @sonatype-lift unignore.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not a critical type shadowing because this is not a user code, so no operations are performed using these type parameters and they got erased to the super-type Object in compile time.

@sonatype-lift
Copy link

sonatype-lift bot commented Aug 13, 2023

🛠 Lift Auto-fix

Some of the Lift findings in this PR can be automatically fixed. You can download and apply these changes in your local project directory of your branch to review the suggestions before committing.1

# Download the patch
curl https://lift.sonatype.com/api/patch/github.com/Software-Hardware-Codesign/Automata4j/4.diff -o lift-autofixes.diff

# Apply the patch with git
git apply lift-autofixes.diff

# Review the changes
git diff

Want it all in a single command? Open a terminal in your project's directory and copy and paste the following command:

curl https://lift.sonatype.com/api/patch/github.com/Software-Hardware-Codesign/Automata4j/4.diff | git apply

Once you're satisfied, commit and push your changes in your project.

Footnotes

  1. You can preview the patch by opening the patch URL in the browser.

@pavly-gerges pavly-gerges requested review from sonatype-lift and removed request for sonatype-lift August 13, 2023 09:51
@pavly-gerges pavly-gerges changed the title Fix javadoc and code enhancements Automata4j-API: Fix javadoc and code enhancements Aug 13, 2023
@pavly-gerges pavly-gerges merged commit 1f1661a into master Aug 13, 2023
6 of 7 checks passed
@pavly-gerges pavly-gerges deleted the fix-javadoc branch August 13, 2023 09:57
This was referenced Aug 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core Core API related stuff documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant