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

Short summary of command execution process #5

Open
Paul2708 opened this issue Apr 4, 2020 · 1 comment
Open

Short summary of command execution process #5

Paul2708 opened this issue Apr 4, 2020 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@Paul2708
Copy link

Paul2708 commented Apr 4, 2020

Suggestion
Extend the wiki by a section that summaries the command execution process.
You already mentioned some exceptions and their reasoning that will be thrown in Exception handling.

I think that a general overview of the command execution process will help to understand the interceptors and the exception handling. A single step could contain the following information:

  • execution order
  • errors that could be thrown in this step
  • impact on the general command execution
  • relation to command method (annotations, etc.)

Example

  1. Command interceptors by method annotations:
    Intercept the command before executing it. If you want to cancel the command execution, throw an exception (and handle it properly).
  2. Argument parsing:
    Parse arguments and check if the given arguments match the expected one.
  3. Mapping:
    Map every argument to its parameter type.
  4. ...
@JohnnyJayJay
Copy link
Member

A detailed description of the mapping process in the wiki and the javadocs is being worked on, along many other additional wiki articles.

@JohnnyJayJay JohnnyJayJay added the documentation Improvements or additions to documentation label Apr 5, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants