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

Interface ProcessingMessageBuilderMethods<T extends ProcessingMessageBuilderMethods<T>>

All Known Subinterfaces:
ProcessingExceptionBuilder, ProcessingExceptionIntermediate<T>, ProcessingMessageBuilder<T>
All Known Implementing Classes:
ProcessingException, ProcessingExceptionNoopBuilder, ProcessingExceptionOptionalBuilder, ProcessingMessageAbstractBuilder, ProcessingMessageDefaultBuilder, ProcessingMessageNoopBuilder, ProcessingMessageOptionalBuilder
public interface ProcessingMessageBuilderMethods<T extends ProcessingMessageBuilderMethods<T>>

  • Method Summary

    Modifier and Type
    Method
    Description
    T
    addContextInfo(@Nullable ContextInfo... contextInfo)
    Add contextual information to the message.
    T
    addContextInfo(@Nullable List<ContextInfo> contextInfo)
    Add additional contextual information bounded to message.
    T
    withHelpUri(@NotNull String helpUri)
    Help URI associated with this message that may help receiver to find more information about the problem, better understand it and resolve it quickly.
    T
    withHelpUri(@Nullable URI helpUri)
    Help URI associated with this message that may help receiver to find more information about the problem, better understand it and resolve it quickly.
    T
    withMessageType(@NotNull MessageType messageType)
    Type of message, such as severity or message status.
    T
    withSecurityLevel(@Nullable SecurityLevel securityLevel)
    Specify security level of information in message.

  • Method Details

    • addContextInfo

      @NotNull T addContextInfo(@Nullable @Nullable List<ContextInfo> contextInfo)
      Add additional contextual information bounded to message. It appends this contextual information to all previously added contextual information.
      Parameters:
      contextInfo - Contextual information you want to provide together with the message.
      Returns:
      An instance of an ProcessingMessageBuilderMethods with appended contextual information.

    • addContextInfo

      @NotNull T addContextInfo(@Nullable @Nullable ContextInfo... contextInfo)
      Add contextual information to the message.
      Parameters:
      contextInfo - Additional contextual information appended to message.
      Returns:
      An instance of an ProcessingMessageBuilderMethods with appended contextual information.

    • withHelpUri

      @NotNull T withHelpUri(@Nullable @Nullable URI helpUri)
      Help URI associated with this message that may help receiver to find more information about the problem, better understand it and resolve it quickly. It can be reference to the documentation, KB or other article describing problem.
      Parameters:
      helpUri - Resource identifier.
      Returns:
      An instance of an ProcessingMessageBuilderMethods with appended contextual information.

    • withHelpUri

      @NotNull T withHelpUri(@NotNull @NotNull String helpUri)
      Help URI associated with this message that may help receiver to find more information about the problem, better understand it and resolve it quickly. It can be reference to the documentation, KB or other article describing problem.
      Parameters:
      helpUri - Resource identifier.
      Returns:
      An instance of an ProcessingMessageBuilderMethods with appended contextual information.

    • withSecurityLevel

      @NotNull T withSecurityLevel(@Nullable @Nullable SecurityLevel securityLevel)
      Specify security level of information in message.
      Parameters:
      securityLevel - Security level of information in message.
      Returns:
      An instance of an ProcessingMessageBuilderMethods with appended contextual information.

    • withMessageType

      @NotNull T withMessageType(@NotNull @NotNull MessageType messageType)
      Type of message, such as severity or message status. For more information see MessageStatus or MessageSeverity.
      Parameters:
      messageType - The type of this message.
      Returns:
      An instance of an ProcessingMessageBuilderMethods with appended contextual information.