feat: rename mandatory to required

Signed-off-by: Nico-DF <[email protected]>

Author: Nico-DF

spring-shell-core/src/main/java/org/springframework/shell/core/tui/component/StringInput.java

@@ -49,7 +49,7 @@ public class StringInput extends AbstractTextComponent<String, StringInputContex
 
 	private @Nullable Character maskCharacter;
 
-	private boolean mandatory;
+	private boolean required;
 
 	public StringInput(Terminal terminal) {
 		this(terminal, null, null, null, false);
@@ -65,12 +65,12 @@ public StringInput(Terminal terminal, @Nullable String name, @Nullable String de
 	}
 
 	public StringInput(Terminal terminal, @Nullable String name, @Nullable String defaultValue,
-      @Nullable Function<StringInputContext, List<AttributedString>> renderer, boolean mandatory) {
+      @Nullable Function<StringInputContext, List<AttributedString>> renderer, boolean required) {
 		super(terminal, name, null);
 		setRenderer(renderer != null ? renderer : new DefaultRenderer());
 		setTemplateLocation("classpath:org/springframework/shell/component/string-input-default.stg");
 		this.defaultValue = defaultValue;
-		this.mandatory = mandatory;
+		this.required = required;
 	}
 
 	/**
@@ -82,20 +82,20 @@ public void setMaskCharacter(@Nullable Character maskCharacter) {
 	}
 
 	/**
-	 * Sets a mandatory flag to check that the result is not empty
+	 * Sets a required flag to check that the result is not empty
 	 *
-	 * @param mandatory if input is required
+	 * @param required if input is required
 	 */
-	public void setMandatory(boolean mandatory) {
-		this.mandatory = mandatory;
+	public void setRequired(boolean required) {
+		this.required = required;
 	}
 
 	@Override
 	public StringInputContext getThisContext(@Nullable ComponentContext<?> context) {
 		if (context != null && currentContext == context) {
 			return currentContext;
 		}
-		currentContext = StringInputContext.of(defaultValue, maskCharacter, mandatory);
+		currentContext = StringInputContext.of(defaultValue, maskCharacter, required);
 		currentContext.setName(getName());
 		if (context != null) {
 			context.stream().forEach(e -> {
@@ -141,7 +141,7 @@ protected boolean read(BindingReader bindingReader, KeyMap<String> keyMap, Strin
 				}
 				else if (context.getDefaultValue() != null) {
 					context.setResultValue(context.getDefaultValue());
-				} else if (mandatory) {
+				} else if (required) {
 					context.setMessage("This field is mandatory", TextComponentContext.MessageLevel.ERROR);
 					break;
 				}
@@ -199,16 +199,16 @@ public interface StringInputContext extends TextComponentContext<String, StringI
 		/**
 		 * Sets flag for mandatory input.
 		 *
-		 * @param mandatory true if input is mandatory
+		 * @param required true if input is required
 		 */
-		void setMandatory(boolean mandatory);
+		void setRequired(boolean required);
 
 		/**
 		 * Returns flag if input is required.
 		 *
 		 * @return true if input is required, false otherwise
 		 */
-		boolean isMandatory();
+		boolean isRequired();
 
 		/**
 		 * Gets an empty {@link StringInputContext}.
@@ -231,8 +231,8 @@ public static StringInputContext of(@Nullable String defaultValue, @Nullable Cha
 		 *
 		 * @return path input context
 		 */
-		public static StringInputContext of(@Nullable String defaultValue, @Nullable Character maskCharacter, boolean mandatory) {
-			return new DefaultStringInputContext(defaultValue, maskCharacter, mandatory);
+		public static StringInputContext of(@Nullable String defaultValue, @Nullable Character maskCharacter, boolean required) {
+			return new DefaultStringInputContext(defaultValue, maskCharacter, required);
 		}
 
 	}
@@ -244,12 +244,12 @@ private static class DefaultStringInputContext extends BaseTextComponentContext<
 
 		private @Nullable Character maskCharacter;
 
-		private boolean mandatory;
+		private boolean required;
 
-		public DefaultStringInputContext(@Nullable String defaultValue, @Nullable Character maskCharacter, boolean mandatory) {
+		public DefaultStringInputContext(@Nullable String defaultValue, @Nullable Character maskCharacter, boolean required) {
 			this.defaultValue = defaultValue;
 			this.maskCharacter = maskCharacter;
-			this.mandatory = mandatory;
+			this.required = required;
 		}
 
 		@Override
@@ -268,8 +268,8 @@ public void setMaskCharacter(Character maskCharacter) {
 		}
 
 		@Override
-		public void setMandatory(boolean mandatory) {
-			this.mandatory = mandatory;
+		public void setRequired(boolean required) {
+			this.required = required;
 		}
 
 		@Override
@@ -293,8 +293,8 @@ public boolean hasMaskCharacter() {
 		}
 
 		@Override
-		public boolean isMandatory() {
-			return mandatory;
+		public boolean isRequired() {
+			return required;
 		}
 
 		@Override
@@ -305,7 +305,7 @@ public boolean isMandatory() {
 			attributes.put("maskedResultValue", getMaskedResultValue());
 			attributes.put("maskCharacter", getMaskCharacter());
 			attributes.put("hasMaskCharacter", hasMaskCharacter());
-			attributes.put("mandatory", isMandatory());
+			attributes.put("required", isRequired());
 			Map<String, Object> model = new HashMap<>();
 			model.put("model", attributes);
 			return model;

spring-shell-core/src/main/java/org/springframework/shell/core/tui/component/flow/BaseStringInput.java

@@ -45,7 +45,7 @@ public abstract class BaseStringInput extends BaseInput<StringInputSpec> impleme
 
 	private @Nullable Character maskCharacter;
 
-	private boolean mandatory = false;
+	private boolean required = false;
 
 	private @Nullable Function<StringInputContext, List<AttributedString>> renderer;
 
@@ -94,8 +94,8 @@ public StringInputSpec maskCharacter(Character maskCharacter) {
 	}
 
 	@Override
-	public StringInputSpec mandatory() {
-		this.mandatory = true;
+	public StringInputSpec required() {
+		this.required = true;
 		return this;
 	}
 
@@ -166,8 +166,8 @@ public StringInputSpec getThis() {
 		return maskCharacter;
 	}
 
-	public boolean isMandatory() {
-		return mandatory;
+	public boolean isRequired() {
+		return required;
 	}
 
 	public @Nullable Function<StringInputContext, List<AttributedString>> getRenderer() {

spring-shell-core/src/main/java/org/springframework/shell/core/tui/component/flow/ComponentFlow.java

@@ -468,7 +468,7 @@ else if (n.isPresent()) {
 
 		private Stream<OrderedInputOperation> stringInputsStream() {
 			return stringInputs.stream().map(input -> {
-				StringInput selector = new StringInput(terminal, input.getName(), input.getDefaultValue(), null, input.isMandatory());
+				StringInput selector = new StringInput(terminal, input.getName(), input.getDefaultValue(), null, input.isRequired());
 				Function<ComponentContext<?>, ComponentContext<?>> operation = (context) -> {
 					if (input.getResultMode() == ResultMode.ACCEPT && input.isStoreResult()
 							&& StringUtils.hasText(input.getResultValue())) {
@@ -492,7 +492,7 @@ private Stream<OrderedInputOperation> stringInputsStream() {
 						if (input.getResultMode() == ResultMode.VERIFY && StringUtils.hasText(input.getResultValue())) {
 							selector.addPreRunHandler(c -> {
 								c.setDefaultValue(input.getResultValue());
-								c.setMandatory(input.isMandatory());
+								c.setRequired(input.isRequired());
 							});
 						}
 						selector.addPostRunHandler(c -> {

spring-shell-core/src/main/java/org/springframework/shell/core/tui/component/flow/StringInputSpec.java

@@ -68,11 +68,11 @@ public interface StringInputSpec extends BaseInputSpec<StringInputSpec> {
 	StringInputSpec maskCharacter(Character maskCharacter);
 
 	/**
-	 * Sets input to mandatory
+	 * Sets input to required
 	 *
 	 * @return a builder
 	 */
-	StringInputSpec mandatory();
+	StringInputSpec required();
 
 	/**
 	 * Sets a renderer function.

spring-shell-core/src/test/java/org/springframework/shell/core/tui/component/StringInputTests.java

@@ -168,7 +168,7 @@ void testResultMandatoryInput() {
 		StringInput component1 = new StringInput(getTerminal());
 		component1.setResourceLoader(new DefaultResourceLoader());
 		component1.setTemplateExecutor(getTemplateExecutor());
-		component1.setMandatory(true);
+		component1.setRequired(true);
 
 		service.execute(() -> {
 			StringInputContext run1Context = component1.run(empty);

spring-shell-core/src/test/java/org/springframework/shell/core/tui/component/flow/ComponentFlowTests.java

@@ -56,7 +56,7 @@ void testSimpleFlow() {
 			.and()
 			.withStringInput("field3")
 			.name("Field3")
-			.mandatory()
+			.required()
 			.and()
 			.withPathInput("path1")
 			.name("Path1")

spring-shell-core/src/test/resources/org/springframework/shell/component/string-input-default.stg

@@ -15,8 +15,8 @@ info(model) ::= <%
   <if(model.maskedInput)>
     <model.maskedInput>
   <else>
-    <if(model.mandatory)>
-      <("[Mandatory]"); format="style-value">
+    <if(model.required)>
+      <("[Required]"); format="style-value">
     <endif>
     <if(model.defaultValue)>
       <("[Default "); format="style-value"><model.defaultValue; format="style-value"><("]"); format="style-value">
@@ -26,8 +26,8 @@ info(model) ::= <%
   <if(model.input)>
     <model.input>
   <else>
-    <if(model.mandatory)>
-      <("[Mandatory]"); format="style-value">
+    <if(model.required)>
+      <("[Required]"); format="style-value">
     <endif>
     <if(model.defaultValue)>
       <("[Default "); format="style-value"><model.defaultValue; format="style-value"><("]"); format="style-value">

spring-shell-docs/modules/ROOT/pages/components/ui/stringinput.adoc

@@ -41,7 +41,7 @@ The context object is `StringInputContext`. The following table lists its contex
 |`hasMaskCharacter`
 |`true` if a mask character is set. Otherwise, false.
 
-|`mandatory`
+|`required`
 |`true` if the input is required. Otherwise, false.
 
 |`model`