Skip to content

feat: Add convenience formatting caption methods. #741

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat: Add convenience formatting caption methods. #741

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 48 additions & 0 deletions cloud-core/src/main/java/org/incendo/cloud/context/CommandContext.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,54 @@ public CommandContext(
);
}

/**
* Formats a {@code caption} using the given {@code formatter} and {@code recipient}.
*
* @param <T> the message type produced by the formatter
* @param formatter the formatter
* @param recipient the recipient of the message.
* @param caption the caption key
* @param variables the variables to use during formatting
* @return the formatted caption
*/
public <T> @NonNull T formatCaption(
final @NonNull CaptionFormatter<C, T> formatter,
final @NonNull C recipient,
final @NonNull Caption caption,
final @NonNull CaptionVariable @NonNull... variables
) {
return formatter.formatCaption(
caption,
recipient,
this.captionRegistry.caption(caption, recipient),
variables
);
}

/**
* Formats a {@code caption} using the given {@code formatter} and {@code recipient}.
*
* @param <T> the message type produced by the formatter
* @param formatter the formatter
* @param recipient the recipient of the message.
* @param caption the caption key
* @param variables the variables to use during formatting
* @return the formatted caption
*/
public <T> @NonNull T formatCaption(
final @NonNull CaptionFormatter<C, T> formatter,
final @NonNull C recipient,
final @NonNull Caption caption,
final @NonNull List<@NonNull CaptionVariable> variables
) {
return formatter.formatCaption(
caption,
recipient,
this.captionRegistry.caption(caption, recipient),
variables
);
}

/**
* Returns the sender that executed the command.
*
Expand Down