Spring/spring-shell
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Support option label

Browse Source 
- This adds `label` to `CommandOption` which is then used
  in a Help instead of type.
- Fixes #424
This commit is contained in:
Janne Valkealahti
2022-06-08 07:39:44 +01:00
parent 8548828873
commit fa65a2308e
6 changed files with 113 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
spring-shell-core/src/main/java/org/springframework/shell/command/CommandOption.java
View File

@@ -87,6 +87,13 @@ public interface CommandOption {
*/
int getArityMax();
/**
* Gets a label.
*
* @return the label
*/
String getLabel();
/**
* Gets an instance of a default {@link CommandOption}.
*
@@ -96,7 +103,7 @@ public interface CommandOption {
* @return default command option
*/
public static CommandOption of(String[] longNames, Character[] shortNames, String description) {
return of(longNames, shortNames, description, null, false, null, null, null, null);
return of(longNames, shortNames, description, null, false, null, null, null, null, null);
}
/**
@@ -110,7 +117,7 @@ public interface CommandOption {
*/
public static CommandOption of(String[] longNames, Character[] shortNames, String description,
ResolvableType type) {
return of(longNames, shortNames, description, type, false, null, null, null, null);
return of(longNames, shortNames, description, type, false, null, null, null, null, null);
}
/**
@@ -125,12 +132,14 @@ public interface CommandOption {
* @param position the position value
* @param arityMin the min arity
* @param arityMax the max arity
* @param label the label
* @return default command option
*/
public static CommandOption of(String[] longNames, Character[] shortNames, String description,
ResolvableType type, boolean required, String defaultValue, Integer position, Integer arityMin, Integer arityMax) {
ResolvableType type, boolean required, String defaultValue, Integer position, Integer arityMin,
Integer arityMax, String label) {
return new DefaultCommandOption(longNames, shortNames, description, type, required, defaultValue, position,
arityMin, arityMax);
arityMin, arityMax, label);
}
/**
@@ -147,10 +156,11 @@ public interface CommandOption {
private int position;
private int arityMin;
private int arityMax;
private String label;
public DefaultCommandOption(String[] longNames, Character[] shortNames, String description,
ResolvableType type, boolean required, String defaultValue, Integer position,
Integer arityMin, Integer arityMax) {
Integer arityMin, Integer arityMax, String label) {
this.longNames = longNames != null ? longNames : new String[0];
this.shortNames = shortNames != null ? shortNames : new Character[0];
this.description = description;
@@ -160,6 +170,7 @@ public interface CommandOption {
this.position = position != null && position > -1 ? position : -1 ;
this.arityMin = arityMin != null ? arityMin : -1;
this.arityMax = arityMax != null ? arityMax : -1;
this.label = label;
}
@Override
@@ -206,5 +217,10 @@ public interface CommandOption {
public int getArityMax() {
return arityMax;
}
@Override
public String getLabel() {
return label;
}
}
}

22
spring-shell-core/src/main/java/org/springframework/shell/command/CommandRegistration.java
View File

@@ -200,6 +200,14 @@ public interface CommandRegistration {
*/
OptionSpec arity(OptionArity arity);
/**
* Define a {@code label} for an option.
*
* @param label the label
* @return option spec for chaining
*/
OptionSpec label(String label);
/**
* Return a builder for chaining.
*
@@ -519,6 +527,7 @@ public interface CommandRegistration {
private Integer position;
private Integer arityMin;
private Integer arityMax;
private String label;
DefaultOptionSpec(BaseBuilder builder) {
this.builder = builder;
@@ -611,6 +620,12 @@ public interface CommandRegistration {
return this;
}
@Override
public OptionSpec label(String label) {
this.label = label;
return this;
}
@Override
public Builder and() {
return builder;
@@ -651,6 +666,10 @@ public interface CommandRegistration {
public Integer getArityMax() {
return arityMax;
}
public String getLabel() {
return label;
}
}
static class DefaultTargetSpec implements TargetSpec {
@@ -820,7 +839,8 @@ public interface CommandRegistration {
public List<CommandOption> getOptions() {
return optionSpecs.stream()
.map(o -> CommandOption.of(o.getLongNames(), o.getShortNames(), o.getDescription(), o.getType(),
o.isRequired(), o.getDefaultValue(), o.getPosition(), o.getArityMin(), o.getArityMax()))
o.isRequired(), o.getDefaultValue(), o.getPosition(), o.getArityMin(), o.getArityMax(),
o.getLabel()))
.collect(Collectors.toList());
}