Class TriggeredByBuilder


  • public class TriggeredByBuilder
    extends java.lang.Object
    Builder which can be used to store some relevant information in triggered by field of a build. Information can be stored as a number of name = value pairs. The map of name = value pairs will then be provided to jetbrains.buildServer.serverSide.TriggeredByProcessor extension to convert to a text which should be shown in the UI. The builder is not thread safe.
    • Constructor Detail

      • TriggeredByBuilder

        public TriggeredByBuilder​(@NotNull
                                  User userWhoTriggeredBuild)
        Use this constructor if build is triggered manually by a user.
        Parameters:
        userWhoTriggeredBuild - user triggered build
      • TriggeredByBuilder

        public TriggeredByBuilder()
        Use this constructor if build is not triggered by a user.
    • Method Detail

      • addParameter

        public void addParameter​(@NotNull
                                 java.lang.String paramName,
                                 @NotNull
                                 java.lang.String paramValue)
                          throws java.lang.IllegalArgumentException
        Adds new parameter to the map.
        Parameters:
        paramName - name of the parameter
        paramValue - value of the parameter
        Throws:
        java.lang.IllegalArgumentException - in case if length of serialized map of parameters exceeds max length MAX_LENGTH
      • addParameters

        public void addParameters​(@NotNull
                                  java.util.Map<java.lang.String,​java.lang.String> params)
                           throws java.lang.IllegalArgumentException
        Adds new parameters to the map.
        Parameters:
        params - parameters to add
        Throws:
        java.lang.IllegalArgumentException - in case if length of serialized map of parameters exceeds max length MAX_LENGTH
      • reset

        public void reset()
        Clears all added parameters.
      • toString

        public java.lang.String toString()
        Transforms map to a string. The order of parameters is preserved.
        Overrides:
        toString in class java.lang.Object
        Returns:
        see above