Skip to content

Commit

Permalink
Add CAUTION admonitions about the use of static classes to ITypeConve…
Browse files Browse the repository at this point in the history
…rter and IModelTransformer (#1297)
  • Loading branch information
deining authored and remkop committed Jan 13, 2021
1 parent 6b99146 commit 22f8a2c
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions docs/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -1404,6 +1404,8 @@ This may also be useful for applications that need a custom type converter but w

Type converters declared with the `converter` attribute need to have a public no-argument constructor to be instantiated, unless a <<Custom Factory>> is installed to instantiate classes.

CAUTION: If your type converter is declared as nested class, make sure you mark this class as `static`, or picocli will not be able to instantiate your nested converter class without a <<Custom Factory>>.

=== Arrays, Collections, Maps
NOTE: Starting from picocli 2.0, the `type` attribute is no longer necessary for `Collection` and `Map` fields:
picocli will infer the collection element type from the generic type.
Expand Down Expand Up @@ -10186,6 +10188,7 @@ class Dynamic {

All transformers are called once, after the full command hierarchy is constructed, and before any command line arguments are parsed.

CAUTION: If your model transformer is declared as nested class, make sure you mark this class as `static`, or picocli will not be able to instantiate your transformer class without a <<Custom Factory>>.

=== Automatic Parameter Indexes
==== Automatic Indexes
Expand Down

0 comments on commit 22f8a2c

Please sign in to comment.