Interface IProfiler

  • All Known Implementing Classes:
    Profiler

    public interface IProfiler
    A profiler stores execution information, such as time and memory consumption. The application has to call the start()/stop() for information on specific items being collected.
    • Field Detail

      • TYPE_ROOT

        static final java.lang.String TYPE_ROOT
        The dummy root type (not used for ordering).
        See Also:
        Constant Field Values
      • TYPE_OBJECT

        static final java.lang.String TYPE_OBJECT
        The object-type type.
        See Also:
        Constant Field Values
      • TYPE_OBJECTEVENT

        static final java.lang.String TYPE_OBJECTEVENT
        The object event type (see objectevent_xxx for possible items).
        See Also:
        Constant Field Values
      • TYPE_NODEEVENT

        static final java.lang.String TYPE_NODEEVENT
        The rete-node event type (see nodeevent_xxx for possible items).
        See Also:
        Constant Field Values
      • OBJECTEVENT_ADDED

        static final java.lang.String OBJECTEVENT_ADDED
        The object added event item.
        See Also:
        Constant Field Values
      • OBJECTEVENT_REMOVED

        static final java.lang.String OBJECTEVENT_REMOVED
        The object removed event item.
        See Also:
        Constant Field Values
      • OBJECTEVENT_MODIFIED

        static final java.lang.String OBJECTEVENT_MODIFIED
        The object modified event item.
        See Also:
        Constant Field Values
      • NODEEVENT_OBJECTADDED

        static final java.lang.String NODEEVENT_OBJECTADDED
        The node object added event item.
        See Also:
        Constant Field Values
      • NODEEVENT_OBJECTREMOVED

        static final java.lang.String NODEEVENT_OBJECTREMOVED
        The node object removed event item.
        See Also:
        Constant Field Values
      • NODEEVENT_OBJECTMODIFIED

        static final java.lang.String NODEEVENT_OBJECTMODIFIED
        The node object modified event item.
        See Also:
        Constant Field Values
      • NODEEVENT_TUPLEADDED

        static final java.lang.String NODEEVENT_TUPLEADDED
        The node tuple added event item.
        See Also:
        Constant Field Values
      • NODEEVENT_TUPLEREMOVED

        static final java.lang.String NODEEVENT_TUPLEREMOVED
        The node tuple removed event item.
        See Also:
        Constant Field Values
      • NODEEVENT_TUPLEMODIFIED

        static final java.lang.String NODEEVENT_TUPLEMODIFIED
        The node tuple modified event item.
        See Also:
        Constant Field Values
    • Method Detail

      • start

        void start​(java.lang.String type,
                   java.lang.Object item)
        Start profiling an item. Nesting (i.e. calling start() several times before calling corresponding stops) is allowed.
        Parameters:
        type - A constant representing the event or activity type being profiled (e.g. object added).
        item - The element corresponding to the activity (e.g. the object type).
      • stop

        void stop​(java.lang.String type,
                  java.lang.Object item)
        Stop profiling the current item. Calls to stop() have match the last unstopped call to start(), with respect to the supplied types and items.
        Parameters:
        type - A constant representing the event or activity type being profiled (e.g. object added).
        item - The element corresponding to the activity (e.g. the object type).
      • getProfilingInfos

        IProfiler.ProfilingInfo[] getProfilingInfos​(int start)
        Get the current profiling infos from the given start index.
        Parameters:
        start - The start index (use 0 for all profiling infos).