Package cloud.commandframework.annotations

Interface StringProcessor

All Known Implementing Classes:
PatternReplacingStringProcessor, PropertyReplacingStringProcessor, StringProcessor.NoOpStringProcessor
Functional Interface:
This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
@FunctionalInterface public interface StringProcessor
Processor that intercepts all cloud annotation strings.
Since:
1.7.0

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static final class 
    StringProcessor.NoOpStringProcessor
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static @NonNull StringProcessor
    noOp()
    Returns a string processor that simply returns the input string.
    @NonNull String
    processString(@NonNull String input)
    Processes the input string and returns the processed result.

  • Method Details

    • noOp

      static @NonNull StringProcessor noOp()
      Returns a string processor that simply returns the input string.
      Returns:
      no-op string processor

    • processString

      @NonNull String processString(@NonNull String input)
      Processes the input string and returns the processed result.

      This should always return a non-null result. If the input string isn't applicable to the processor implementation, the original string should be returned.

      Parameters:
      input - the input string
      Returns:
      the processed string