javatools.administrative

Class CallStack

java.lang.Object

javatools.administrative.CallStack

public class CallStack
extends Object

Copyright 2016 Fabian M. Suchanek Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. This class represents the current position of a program, i.e. the stack of methods that have been called together with the line numbers.
Example:

   public class Blah {
     public m2() { 
       System.out.println(new CallStack());   // (1)
       System.out.println(CallStack.here());  // (2)
     }
  
     public m1() { 
       m2(); 
     }
  
     public static void main(String[] args) { 
       m1(); 
     }
   }
   -->
      Blah.main(12)->Blah.m1(8)->Blah.m2(2)  // Call Stack at (1)
      Blah.m2(3)                             // Method and line number at (2)

Field Summary

Fields

Modifier and Type	Field and Description
protected Stack<StackTraceElement>	callstack Holds the call stack

Constructor Summary

Constructors

Constructor and Description
CallStack() Constructs a call stack from the current program position (without the constructor call)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o) Returns TRUE if the two call stacks have the same elements
Stack<StackTraceElement>	getCallstack() Returns the callstack
static StackTraceElement	here() Gives the calling position
static void	main(String[] args) Test routine
CallStack	ret() Pops the top level of this callstack, returns this callstack
StackTraceElement	top() Gives the calling position as a StackTraceElement
String	toString() Returns "method(line)->method(line)->..."
static String	toString(StackTraceElement e) Returns a nice String for a Stacktraceelement

Methods inherited from class java.lang.Object

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

Field Detail

callstack

protected Stack<StackTraceElement> callstack

Holds the call stack

Constructor Detail

CallStack

public CallStack()

Constructs a call stack from the current program position (without the constructor call)

Method Detail

equals

public boolean equals(Object o)

Returns TRUE if the two call stacks have the same elements

Overrides:

equals in class Object

toString

public static String toString(StackTraceElement e)

Returns a nice String for a Stacktraceelement

toString

public String toString()

Returns "method(line)->method(line)->..."

Overrides:

toString in class Object

top

public StackTraceElement top()

Gives the calling position as a StackTraceElement

here

public static StackTraceElement here()

Gives the calling position

getCallstack

public Stack<StackTraceElement> getCallstack()

Returns the callstack

ret

public CallStack ret()

Pops the top level of this callstack, returns this callstack

main

public static void main(String[] args)

Test routine