ef191e66f3
- Essentially this commit registeres on default `--help` and `-h` options to every command and execution short circuits in presense of help options to help command. - Add Supplier<CommandRegistration.Builder> as a bean which can be autowired registration beans. - Make this common bean customisable via CommandRegistrationCustomizer. - Change StandardMethodTargetRegistrar to use supplier so that annotated commands gets common customizations. - Change sample commands to use supplier. - Add new group, spring.shell.help to config props. - Docs changes - Fixes #582 - Fixes #585
41 lines
1.2 KiB
Plaintext
41 lines
1.2 KiB
Plaintext
==== Programmatic Model
|
|
ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs]
|
|
|
|
In the programmatic model, `CommandRegistration` can be defined as a `@Bean`
|
|
and it will be automatically registered.
|
|
|
|
====
|
|
[source, java, indent=0]
|
|
----
|
|
include::{snippets}/CommandRegistrationBeanSnippets.java[tag=plain]
|
|
----
|
|
====
|
|
|
|
If all your commands have something in common, an instance of
|
|
a _Supplier<CommandRegistration.Builder>_ is created which can
|
|
be autowired. Default implementation of this supplier returns
|
|
a new builder so you don't need to worry about its internal state.
|
|
|
|
IMPORTANT: Commands registered programmatically automatically
|
|
add _help options_ mentioned in <<commands-helpoptions>>.
|
|
|
|
If bean of this supplier type is defined then auto-configuration
|
|
will back off giving you an option to redefine default functionality.
|
|
|
|
====
|
|
[source, java, indent=0]
|
|
----
|
|
include::{snippets}/CommandRegistrationBeanSnippets.java[tag=fromsupplier]
|
|
----
|
|
====
|
|
|
|
`CommandRegistrationCustomizer` beans can be defined if you want to centrally
|
|
modify builder instance given you by supplier mentioned above.
|
|
|
|
====
|
|
[source, java, indent=0]
|
|
----
|
|
include::{snippets}/CommandRegistrationBeanSnippets.java[tag=customizer]
|
|
----
|
|
====
|