Module church.i18n.processing.exception
Package church.i18n.processing.message

Interface ContextInfoBuilder

All Superinterfaces:
NullableBuilder<ContextInfo>
All Known Implementing Classes:
ContextInfoDefaultBuilder, ContextInfoNoopBuilder
public interface ContextInfoBuilder extends NullableBuilder<ContextInfo>

  • Method Details

    • withContext

      @NotNull @NotNull ContextInfoBuilder withContext(@Nullable @Nullable Serializable value, @Nullable @Nullable ValueType valueType)
      Add contextual information to builder.
      Parameters:
      value - Contextual value.
      valueType - The type of the contextual value. E.g. number.
      Returns:
      Instance of a builder.

    • withContext

      @NotNull @NotNull ContextInfoBuilder withContext(@Nullable @Nullable Serializable value, @Nullable @Nullable String valueType)
      Add contextual information to builder.
      Parameters:
      value - Contextual value.
      valueType - The type of the contextual value. E.g. number.
      Returns:
      Instance of a builder.

    • withContext

      @NotNull @NotNull ContextInfoBuilder withContext(@Nullable @Nullable Serializable value)
      Add contextual information to builder.
      Parameters:
      value - Contextual value.
      Returns:
      Instance of a builder.

    • withContext

      @NotNull @NotNull ContextInfoBuilder withContext(@NotNull @NotNull ContextValue context)
      Add contextual information to builder.
      Parameters:
      context - Contextual information.
      Returns:
      Instance of a builder.

    • withHelp

      @NotNull @NotNull ContextInfoBuilder withHelp(@Nullable @Nullable ContextValue help)
      Add help information to builder.
      Parameters:
      help - Help information. E.g. regular expression matching correct string value.
      Returns:
      Instance of a builder.

    • withHelp

      @NotNull @NotNull ContextInfoBuilder withHelp(@Nullable @Nullable Serializable help, @Nullable @Nullable ValueType helpType)
      Add help information to builder.
      Parameters:
      help - Help information. E.g. regular expression matching correct string value.
      helpType - The type of the contextual value. E.g. string.
      Returns:
      Instance of a builder.

    • withHelp

      @NotNull @NotNull ContextInfoBuilder withHelp(@Nullable @Nullable Serializable help, @Nullable @Nullable String helpType)
      Add help information to builder.
      Parameters:
      help - Help information. E.g. regular expression matching correct string value.
      helpType - The type of the contextual value. E.g. string.
      Returns:
      Instance of a builder.

    • withHelp

      @NotNull @NotNull ContextInfoBuilder withHelp(@Nullable @Nullable Serializable help)
      Add help information to builder.
      Parameters:
      help - Help information. E.g. regular expression matching correct string value.
      Returns:
      Instance of a builder.

    • withMessage

      @NotNull @NotNull ContextInfoBuilder withMessage(@Nullable @Nullable I18nMessage message)
      Add human-readable message to contextual information.
      Parameters:
      message - Message describing problem.
      Returns:
      Instance of a builder.

    • withMessage

      @NotNull @NotNull ContextInfoBuilder withMessage(@Nullable @Nullable String code, @Nullable @Nullable Object... params)
      Add human-readable message to contextual information.
      Parameters:
      code - Code of a message from the resource bundle or free-text message.
      params - Parameters for MessageFormat if the message contains parameters.
      Returns:
      Instance of a builder.

    • withSecurityLevel

      @NotNull @NotNull ContextInfoBuilder withSecurityLevel(@Nullable @Nullable SecurityLevel securityLevel)
      Specify security level of information in the security context.
      Parameters:
      securityLevel - The security level of context information.
      Returns:
      Instance of a builder.