edu.wpi.ejutr.logger
Interface EJUTRLogEntry

All Known Implementing Classes:
LogAssertion, LogMethodCall, LogObjectAddition, LogObjectRemoval

public interface EJUTRLogEntry

Interface representing entries into the log, which are then recorded. At some later point, the to_String() method will be called on objects that implement this interface, and the results will be placed directly into the JUnit test method that is generated.

Author:
bigben - bigben@wpi.edu

Field Summary
static int ASSERTION
           
static int METHOD_INVOKATION
           
static int OBJECT_ADDITION
           
static int OBJECT_REMOVAL
           
 
Method Summary
 int getLogEntryType()
          Returns the type of log entry this is.
 java.lang.String to_String()
          Returns a string representation of the log entry.
 

Field Detail

OBJECT_ADDITION

static final int OBJECT_ADDITION
See Also:
Constant Field Values

OBJECT_REMOVAL

static final int OBJECT_REMOVAL
See Also:
Constant Field Values

METHOD_INVOKATION

static final int METHOD_INVOKATION
See Also:
Constant Field Values

ASSERTION

static final int ASSERTION
See Also:
Constant Field Values
Method Detail

to_String

java.lang.String to_String()
Returns a string representation of the log entry. Ideally this will be placed directly into a file output stream. Therefore, the responsibility of each class that implements this interface is to ensure that this method returns a string utilizing proper Java/JUnit syntax.

Returns:
String representation of log entry

getLogEntryType

int getLogEntryType()
Returns the type of log entry this is.

Returns:
The type of log entry this is.