Update docs

This commit is contained in:
Janne Valkealahti
2022-05-15 16:29:23 +01:00
parent 60e63f87ae
commit ee21619885
5 changed files with 77 additions and 0 deletions

View File

@@ -42,3 +42,12 @@ include::{snippets}/OptionSnippets.java[tag=option-registration-arityenum]
|ONE_OR_MORE
|1 / Integer MAX
|===
Annotation model only supports defining _max_ value of an arity.
====
[source, java, indent=0]
----
include::{snippets}/OptionSnippets.java[tag=option-with-annotation-arity]
----
====

View File

@@ -13,3 +13,12 @@ based on a default value.
include::{snippets}/OptionSnippets.java[tag=option-registration-default]
----
====
With an annotation model default value can be defined.
====
[source, java, indent=0]
----
include::{snippets}/OptionSnippets.java[tag=option-with-annotation-default]
----
====

View File

@@ -11,3 +11,13 @@ a command target how this behaves.
include::{snippets}/OptionSnippets.java[tag=option-registration-optional]
----
====
With an annotation model there is no direct way to define if argument is
optional, instead it's instructed to be _NULL_.
====
[source, java, indent=0]
----
include::{snippets}/OptionSnippets.java[tag=option-with-annotation-optional]
----
====

View File

@@ -25,3 +25,12 @@ as `-abc`, `-abc true` or `-abc false`.
include::{snippets}/OptionSnippets.java[tag=option-registration-shortargbooleans]
----
====
With annotation model you can define short argument directly.
====
[source, java, indent=0]
----
include::{snippets}/OptionSnippets.java[tag=option-with-annotation-shortarg]
----
====

View File

@@ -22,6 +22,46 @@ public class OptionSnippets {
// end::option-without-annotation[]
}
class Dump3 {
// tag::option-with-annotation-shortarg[]
public String example(
@ShellOption(value = { "-a" }) String arg1,
@ShellOption(value = { "-b" }) String arg2,
@ShellOption(value = { "-c" }) String arg3
) {
return "Hello " + arg1;
}
// end::option-with-annotation-shortarg[]
}
class Dump4 {
// tag::option-with-annotation-arity[]
public String example(@ShellOption(arity = 1) String arg1) {
return "Hello " + arg1;
}
// end::option-with-annotation-arity[]
}
class Dump5 {
// tag::option-with-annotation-optional[]
public String example(
@ShellOption(defaultValue = ShellOption.NULL) String arg1
) {
return "Hello " + arg1;
}
// end::option-with-annotation-optional[]
}
class Dump6 {
// tag::option-with-annotation-default[]
public String example(
@ShellOption(defaultValue = "defaultValue") String arg1
) {
return "Hello " + arg1;
}
// end::option-with-annotation-default[]
}
public void dump1() {
// tag::option-registration-longarg[]