Package com.inductiveautomation.snap.debug

Class Breakpoint

  • All Implemented Interfaces:
    java.lang.Comparable<Breakpoint>
    public class Breakpoint
extends java.lang.Object
implements java.lang.Comparable<Breakpoint>
    Represents a debugger break point for a project file.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Breakpoint.Type  

    • Constructor Summary

      Constructors 
      Constructor Description
      Breakpoint()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int compareTo​(Breakpoint aBP)
      Standard compare implementation.
      Breakpoint createAccessWatchpoint​(java.lang.String aClsName, java.lang.String fieldId, boolean isAccess)
      Initializes a Watchpoint.
      boolean equals​(java.lang.Object anObj)
      Standard equals implementation.
      java.lang.String getDescriptor()
      Returns a descriptor string.
      WebFile getFile()
      Returns the file.
      java.lang.String getFilePath()
      Returns the file path.
      int getLine()
      Returns the line index.
      int getLineNum()
      Returns the line number.
      java.util.List<java.lang.String> getMethodArgs()
      Returns the method args (if method break point).
      java.lang.String getMethodName()
      Returns the method name (if method break point).
      java.lang.String getName()
      Returns the name.
      Breakpoint.Type getType()
      Returns the type.
      int hashCode()
      Return hash code.
      Breakpoint initClassLine​(java.lang.String aClsName, int line)
      Initializes a LineBreakpoint.
      Breakpoint initException​(java.lang.String aClsName, boolean notifyCaught, boolean notifyUncaught)
      Initializes a ExceptionIntercept.
      Breakpoint initMethod​(java.lang.String aClsName, java.lang.String aMethod, java.util.List theArgs)
      Initializes a MethodBreakpoint.
      Breakpoint initSourceLine​(WebFile aFile, int aLine)
      Initializes a breakpoint for project, FilePath and Line.
      boolean isEnabled()
      Returns whether breakpoint is enabled.
      void setEnabled​(boolean aValue)
      Sets whether breakpoint is enabled.
      protected void setFile​(WebFile aFile)
      Sets the file.
      void setLine​(int aLine)
      Sets the line number.
      java.lang.String toString()
      Standard toString implementation.

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • Breakpoint

        public Breakpoint()

    • Method Detail

      • initSourceLine

        public Breakpoint initSourceLine​(WebFile aFile,
                                 int aLine)
        Initializes a breakpoint for project, FilePath and Line.

      • initClassLine

        public Breakpoint initClassLine​(java.lang.String aClsName,
                                int line)
        Initializes a LineBreakpoint.

      • initMethod

        public Breakpoint initMethod​(java.lang.String aClsName,
                             java.lang.String aMethod,
                             java.util.List theArgs)
        Initializes a MethodBreakpoint. For example: initMethod("snap.app.App", "main", Collections.singletonList("java.lang.String[]"));

      • initException

        public Breakpoint initException​(java.lang.String aClsName,
                                boolean notifyCaught,
                                boolean notifyUncaught)
        Initializes a ExceptionIntercept.

      • createAccessWatchpoint

        public Breakpoint createAccessWatchpoint​(java.lang.String aClsName,
                                         java.lang.String fieldId,
                                         boolean isAccess)
        Initializes a Watchpoint.

      • getName

        public java.lang.String getName()
        Returns the name.

      • getFile

        public WebFile getFile()
        Returns the file.

      • setFile

        protected void setFile​(WebFile aFile)
        Sets the file.

      • getFilePath

        public java.lang.String getFilePath()
        Returns the file path.

      • getLine

        public int getLine()
        Returns the line index.

      • setLine

        public void setLine​(int aLine)
        Sets the line number.

      • getLineNum

        public int getLineNum()
        Returns the line number.

      • getMethodName

        public java.lang.String getMethodName()
        Returns the method name (if method break point).

      • getMethodArgs

        public java.util.List<java.lang.String> getMethodArgs()
        Returns the method args (if method break point).

      • isEnabled

        public boolean isEnabled()
        Returns whether breakpoint is enabled.

      • setEnabled

        public void setEnabled​(boolean aValue)
        Sets whether breakpoint is enabled.

      • getDescriptor

        public java.lang.String getDescriptor()
        Returns a descriptor string.

      • compareTo

        public int compareTo​(Breakpoint aBP)
        Standard compare implementation.
        Specified by:
        compareTo in interface java.lang.Comparable<Breakpoint>

      • hashCode

        public int hashCode()
        Return hash code.
        Overrides:
        hashCode in class java.lang.Object

      • equals

        public boolean equals​(java.lang.Object anObj)
        Standard equals implementation.
        Overrides:
        equals in class java.lang.Object

      • toString

        public java.lang.String toString()
        Standard toString implementation.
        Overrides:
        toString in class java.lang.Object