Property Detail

• @groovy.transform.Field final java.lang.String CHAR_EMPTY

• @groovy.transform.Field final java.lang.String CHAR_FILLED

• @groovy.transform.Field final java.lang.String CHAR_HAS_CHILD

• @groovy.transform.Field final java.lang.String CHAR_LAST

• @groovy.transform.Field final java.lang.String CHAR_SIBLING

• @groovy.transform.Field final java.util.List HEADER

• @groovy.transform.Field final java.lang.String SEPARATOR

Method Detail

• java.lang.Object _elementName(java.lang.Object obj)

  !!! Private method, DO NOT USE !!!

• java.lang.Object _formatMs(java.lang.Object time)

  !!! Private method, DO NOT USE !!!

• java.lang.Object _formatPct(java.lang.Object number, boolean pad = false)

  !!! Private method, DO NOT USE !!!

• java.lang.Object _renderPct(java.lang.Object time, java.lang.Object ratio)

  !!! Private method, DO NOT USE !!!

• java.util.Map _stopwatch()

  !!! Private method, DO NOT USE !!!

  Returns:

  the Stopwatch object which stores the internal configuration in api.global.__stopwatch

• java.lang.Object getStop()

  Groovy getter to enable the Stopwatch.stop syntax (without parentheses). Calls the stop() method.

• void javadoc()

  The Stopwatch library can be used to measure performance of code blocks within a single formula element or across multiple elements. It relies on System.nanoTime() for measuring the duration of the time blocks. Its main advantage in contrary to the standard trace in the Debug mode is that it can measure whole run time of multiple code blocks within a single formula element and not only specific Pricefx API calls and elements' total run time.

  To measure performance of your code using Stopwatch, you can use two methods. Either enclose your code with start(String), lap(String) and stop() calls or use the measure(String, Closure) function with a closure whose performance will be measured.

  The Stopwatch supports measuring of nested code blocks, e.g. performance of code within a for-loop.

  Example for start(), lap() and stop(): *

      def Stopwatch = libs.StopwatchLib.Stopwatch // make a shortcut to the library
  
      Stopwatch.start "Element A"
      Stopwatch.start "Block 1"  // creates a nested time block within Element A
      Stopwatch.start "Block 1.1"  // creates a nested time block within Block 1
      // ... your measured code
      Stopwatch.lap "Block 1.2"  // ends measuring of Block 1.1 and starts Block 1.2
      // ... your measured code
      Stopwatch.stop   // ends measuring of Block 1.2
      Stopwatch.start "Block 2"  // creates a nested time block within Element A
      // ... your measured code
      Stopwatch.stop   // ends measuring of Block 2
      Stopwatch.stop   // ends measuring of Element A
  
      Stopwatch.trace
      

  Example for measure():

      def Stopwatch = libs.StopwatchLib.Stopwatch // make a shortcut to the library
  
      Stopwatch.measure "Element A", {
        Stopwatch.measure "Block 1", {
          Stopwatch.measure "Block 1.1", {
            // ... your measured code
          }
          Stopwatch.measure "Block 1.2", {
            // ... your measured code
          }
        }
        Stopwatch.measure "Block 2", {
          // ... your measured code
        }
      }
  
      Stopwatch.trace
      

  The library supports four kinds of reports: via api.trace, via ResultMatrix, println or custom report. All you need to do is to call one of the following methods after the last stop() or measure() method.
  • trace() prints the results using api.trace (three columns will be printed)
  • toResultMatrix() inserts the results into a ResultMatrix (with three columns) and returns it
  • print() prints the results to the system console using println for each line
  • toList() returns the results in a List which contains a List with three elements (columns)
  An example result looks like this:

   STOPWATCH REPORT | % to Overall              | % to Parent
   Element A        | ▓▓▓▓▓▓▓▓▓▓ 610 ms (100 %) | ▓▓▓▓▓▓▓▓▓▓ 610 ms (100 %)
   ├─ Block 1       | ▓▓▓▓▓░░░░░ 305 ms (50 %)  | ▓▓▓▓▓░░░░░ 305 ms (50 %)
   │  ├─ Block 1.1  | ▓▓▓░░░░░░░ 200 ms (33 %)  | ▓▓▓▓▓▓▓░░░ 200 ms (66 %)
   │  └─ Block 1.2  | ▓▓░░░░░░░░ 101 ms (17 %)  | ▓▓▓░░░░░░░ 101 ms (33 %)
   └─ Block 2       | ▓▓▓▓▓░░░░░ 299 ms (49 %)  | ▓▓▓▓▓░░░░░ 299 ms (49 %)
   

  The first column contains the name of the measured time block with depicted hierarchy of nesting. The second column displays each time block's duration ratio to the root (1st level) time block. The third column displays each time block's duration ratio to its immediate parent time block.

• void lap(java.lang.String blockName)

  Stops measuring the previous time block and starts a new one. Essentially it just calls stop() and start(blockName).

  For an example see the start(String) method.

  Parameters:

  blockName - the name of the time block to measure

• static void main(java.lang.String[] args)

  Implicit main method for Groovy Scripts

• void measure(java.lang.String blockName, groovy.lang.Closure closure)

  Starts measuring a time block with the given name. The Stopwatch will measure the time duration of the given closure. You can nest the calls to the measure(String, Closure) method.

  An alternative is to enclose your code with start(String) and stop() methods.

  Example:

      def Stopwatch = libs.StopwatchLib.Stopwatch // make a shortcut to the library
  
      Stopwatch.measure "Element A", {
        Stopwatch.measure "Block 1", {
          Stopwatch.measure "Block 1.1", {
            // ... your measured code
          }
          Stopwatch.measure "Block 1.2", {
            // ... your measured code
          }
        }
        Stopwatch.measure "Block 2", {
          // ... your measured code
        }
      }
  
      Stopwatch.trace
      

  Parameters:

  blockName - the name of the time block to measure

  closure - the closure to measure

  See Also:

  start(String)

  stop()

• void start(java.lang.Object elementName)

  Calls the method start(String) while converting the given Object to a String. It expects the given Object to be a formula element object, thus you should call it in the following way:

    start(this)
   

  Parameters:

  elementName - the formula element Object

• void start(java.lang.String blockName)

  Starts measuring a time block with the given name. The Stopwatch will measure the time duration until the method stop() is called.

  You can nest time blocks by calling start(String) one after each other. Each time block must end with a corresponding call to stop().

  Instead of calling

  start("A"), stop(), start("B"), stop()

  you can also call

  start("A"), lap("B"), stop()

  Example:

      def Stopwatch = libs.StopwatchLib.Stopwatch // make a shortcut to the library
  
      Stopwatch.start "Element A"
      Stopwatch.start "Block 1"  // creates a nested time block within Element A
      Stopwatch.start "Block 1.1"  // creates a nested time block within Block 1
      // ... your measured code
      Stopwatch.lap "Block 1.2"  // ends measuring of Block 1.1 and starts Block 1.2
      // ... your measured code
      Stopwatch.stop   // ends measuring of Block 1.2
      Stopwatch.start "Block 2"  // creates a nested time block within Element A
      // ... your measured code
      Stopwatch.stop   // ends measuring of Block 2
      Stopwatch.stop   // ends measuring of Element A
  
      Stopwatch.trace
      

  You can also use a more readable syntax with method measure(String, Closure) instead

  Parameters:

  blockName - the name of the time block to measure

  See Also:

  stop()

  lap(String)

  measure(String, Closure)

• void stop()

  Stops measuring the time of the time block started with start(String). This method should always come in pair with a prior corresponding call to the start(String) method, or after a lap(String) method is called.

  See Also:

  start(String)

  lap(String)

• java.util.List toList(boolean verbose = false, java.lang.String blockName = null)

  Creates a time report and returns it in a List of Lists. The inner list has always three elements (columns). If you provide the blockName parameter, the report will be created only for the specified time block and its children.

  The result looks like this:

   [
    [ "STOPWATCH REPORT", "% to Overall", "% to Parent],
    [ "Element A",        "▓▓▓▓▓▓▓▓▓▓ 610 ms (100 %)",  "▓▓▓▓▓▓▓▓▓▓ 610 ms (100 %)" ]
    [ "├─ Block 1",       "▓▓▓▓▓░░░░░ 305 ms (50 %)",   "▓▓▓▓▓░░░░░ 305 ms (50 %)" ]
    [ "│  ├─ Block 1.1",  "▓▓▓░░░░░░░ 200 ms (33 %)",   "▓▓▓▓▓▓▓░░░ 200 ms (66 %) ]
    [ "│  └─ Block 1.2",  "▓▓░░░░░░░░ 101 ms (17 %)",   "▓▓▓░░░░░░░ 101 ms (33 %) ]
    [ "└─ Block 2",       "▓▓▓▓▓░░░░░ 299 ms (49 %)",   "▓▓▓▓▓░░░░░ 299 ms (49 %) ]
   ]
   

  The first column contains the name of the measured time block with depicted hierarchy of nesting. The second column displays each time block's duration ratio to the root (1st level) time block. The third column displays each time block's duration ratio to its immediate parent time block.

  If verbose is true, each branch will also show an information about the child block's duration ratio to its parent. See toString(boolean) for how this looks like.

  Parameters:

  verbose - if true, the branches will also contain information of each block's duration ratio to each of its hierarchical parent.

  blockName - optionally provide the name of the block to report, otherwise the report will be created for all

  Returns:

  the report in a List of Lists

• net.pricefx.server.dto.calculation.ResultMatrix toResultMatrix(boolean verbose = false, java.lang.String blockName = null)

  Creates a time report and puts it into a ResultMatrix. If you provide the blockName parameter, the report will be created only for the specified time block and its children. The result is visually the same as calling the toString(boolean, String) method.

  Parameters:

  verbose - if true, the branches will also contain information of each block's duration ratio to each of its hierarchical parent.

  blockName - optionally provide the name of the block to report, otherwise the report will be created for all

  Returns:

  the ResultMatrix with the report

  See Also:

  toString(boolean, String)

• java.lang.String toString(boolean verbose = false, java.lang.String blockName = null)

  Creates a time report and returns it in a formatted String. If you provide the blockName parameter, the report will be created only for the specified time block and its children. The result is visually the same as calling the toString(boolean, String) method.

  The result looks like this:

    STOPWATCH REPORT | % to Overall              | % to Parent
    Element A        | ▓▓▓▓▓▓▓▓▓▓ 610 ms (100 %) | ▓▓▓▓▓▓▓▓▓▓ 610 ms (100 %)
    ├─ Block 1       | ▓▓▓▓▓░░░░░ 305 ms (50 %)  | ▓▓▓▓▓░░░░░ 305 ms (50 %)
    │  ├─ Block 1.1  | ▓▓▓░░░░░░░ 200 ms (33 %)  | ▓▓▓▓▓▓▓░░░ 200 ms (66 %)
    │  └─ Block 1.2  | ▓▓░░░░░░░░ 101 ms (17 %)  | ▓▓▓░░░░░░░ 101 ms (33 %)
    └─ Block 2       | ▓▓▓▓▓░░░░░ 299 ms (49 %)  | ▓▓▓▓▓░░░░░ 299 ms (49 %)
   

  The first column contains the name of the measured time block with depicted hierarchy of nesting. The second column displays each time block's duration ratio to the root (1st level) time block. The third column displays each time block's duration ratio to its immediate parent time block.

  If verbose is true, each branch will also show an information about the child block's duration ratio to its parent, like this:

    STOPWATCH REPORT            | % to Overall              | % to Parent
    Element A                   | ▓▓▓▓▓▓▓▓▓▓ 610 ms (100 %) | ▓▓▓▓▓▓▓▓▓▓ 610 ms (100 %)
    ├─(50 %) Block 1            | ▓▓▓▓▓░░░░░ 305 ms (50 %)  | ▓▓▓▓▓░░░░░ 305 ms (50 %)
    │ (33 %) ├─(50 %) Block 1.1 | ▓▓▓░░░░░░░ 200 ms (33 %)  | ▓▓▓▓▓▓▓░░░ 200 ms (66 %)
    │ (33 %) └─(17 %) Block 1.2 | ▓▓░░░░░░░░ 101 ms (17 %)  | ▓▓▓░░░░░░░ 101 ms (33 %)
    └─(49 %) Block 2            | ▓▓▓▓▓░░░░░ 299 ms (49 %)  | ▓▓▓▓▓░░░░░ 299 ms (49 %)
   

  Parameters:

  verbose - if true, the branches will also contain information of each block's duration ratio to each of its hierarchical parent.

  blockName - optionally provide the name of the block to report, otherwise the report will be created for all

  Returns:

  the report as a formatted String

• void trace(boolean verbose = false, java.lang.String blockName = null)

  Creates a time report and prints it using api.trace. If you provide the blockName parameter, the report will be created only for the specified time block and its children. The result is visually the same as calling the toString(boolean, String) method.

  Parameters:

  verbose - if true, the branches will also contain information of each block's duration ratio to each of its hierarchical parent.

  blockName - optionally provide the name of the block to report, otherwise the report will be created for all

  See Also:

  toString(boolean, String)