Package org.wso2.carbon.utils

Class DiagnosticLog.DiagnosticLogBuilder

  • Enclosing class:
    DiagnosticLog
    public static class DiagnosticLog.DiagnosticLogBuilder
extends Object
    Builder class for DiagnosticLog. This class follows the Builder design pattern, providing a way to construct a DiagnosticLog object step by step.

    • Constructor Detail

      • DiagnosticLogBuilder

        public DiagnosticLogBuilder​(String componentId,
                            String actionId)

    • Method Detail

      • resultMessage

        public DiagnosticLog.DiagnosticLogBuilder resultMessage​(String resultMessage)
        Sets the result message of the DiagnosticLog.
        Parameters:
        resultMessage - the action ID to be set.
        Returns:
        the current DiagnosticLogBuilder instance.

      • inputParam

        public DiagnosticLog.DiagnosticLogBuilder inputParam​(String key,
                                                     Object value)
        Adds a new key-value pair to the input map of the DiagnosticLog. If the input map has not been initialized yet, this method will initialize it.
        Parameters:
        key - the key to be added to the input map.
        value - the value to be associated with the key in the input map.
        Returns:
        the current DiagnosticLogBuilder instance.

      • configParam

        public DiagnosticLog.DiagnosticLogBuilder configParam​(String key,
                                                      Object value)
        Adds a new key-value pair to the configurations map of the DiagnosticLog. If the configurations map has not been initialized yet, this method will initialize it.
        Parameters:
        key - the key to be added to the configurations map.
        value - the value to be associated with the key in the configurations map.
        Returns:
        the current DiagnosticLogBuilder instance.

      • inputParams

        public DiagnosticLog.DiagnosticLogBuilder inputParams​(Map<String,​?> input)
        Adds all entries from the provided map to the input map of the DiagnosticLog. If the input map has not been initialized yet, this method will initialize it.
        Parameters:
        input - the map containing entries to be added to the input map.
        Returns:
        the current DiagnosticLogBuilder instance.

      • configParams

        public DiagnosticLog.DiagnosticLogBuilder configParams​(Map<String,​?> configurations)
        Adds all entries from the provided map to the configurations map of the DiagnosticLog. If the configurations map has not been initialized yet, this method will initialize it.
        Parameters:
        configurations - the map containing entries to be added to the configurations map.
        Returns:
        the current DiagnosticLogBuilder instance.

      • build

        public DiagnosticLog build()
        Constructs a DiagnosticLog object using the set parameters.
        Returns:
        a new DiagnosticLog object.