From 9f16ccd57e33de07f1f131e7a4bafb26d0f4ce77 Mon Sep 17 00:00:00 2001 From: Janne Valkealahti Date: Sun, 19 Feb 2023 09:32:28 +0000 Subject: [PATCH] Polish --- .../shell/command/parser/MessageResult.java | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/spring-shell-core/src/main/java/org/springframework/shell/command/parser/MessageResult.java b/spring-shell-core/src/main/java/org/springframework/shell/command/parser/MessageResult.java index a509f1e7..c3060cb4 100644 --- a/spring-shell-core/src/main/java/org/springframework/shell/command/parser/MessageResult.java +++ b/spring-shell-core/src/main/java/org/springframework/shell/command/parser/MessageResult.java @@ -16,16 +16,29 @@ package org.springframework.shell.command.parser; /** - * Encapsulating {@link ParserMessage} with its postion and {@code inserts}. + * Encapsulating {@link ParserMessage} with position and {@code inserts}. * * @author Janne Valkealahti */ public record MessageResult(ParserMessage parserMessage, int position, Object[] inserts) { + /** + * Constructs {@code MessageResult} with parser message, position and inserts. + * + * @param parserMessage the parser message + * @param position the position + * @param inserts the inserts + * @return a message result + */ public static MessageResult of(ParserMessage parserMessage, int position, Object... inserts) { return new MessageResult(parserMessage, position, inserts); } + /** + * Gets a formatted message using position and inserts. + * + * @return a formatted message + */ public String getMessage() { return parserMessage.formatMessage(position, inserts); }