ninja

Class APILog.Entry

java.lang.Object

ninja.APILog.Entry

Enclosing class:

APILog

public static class APILog.Entry
extends Object

Represents a log entry.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Entry(String function, String description, String result, String duration) Creates a new log entry.

Method Summary

Modifier and Type	Method and Description
String	getCSS() Helper method which returns a bootstrap css class based on the result of the call
String	getDescription() Returns a description of the call
String	getDuration() Returns the duration of the call
String	getFunction() Returns the method or function which was called.
String	getResult() Returns the outcome (one of Result.name()) of the call
String	getTod() Returns a timestamp of the call

Methods inherited from class java.lang.Object

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

Constructor Detail

Entry

protected Entry(String function,
                String description,
                String result,
                String duration)

Creates a new log entry.

Parameters:

function - name or method of the function which was invoked

description - description of the call

result - outcome of the call

duration - duration of the call

Method Detail

getFunction

public String getFunction()

Returns the method or function which was called.

Returns:

the name of the called function

getDescription

public String getDescription()

Returns a description of the call

Returns:

a short text describing the call

getResult

public String getResult()

Returns the outcome (one of Result.name()) of the call

Returns:

a string describing if the call succeeded or why it failed.

getDuration

public String getDuration()

Returns the duration of the call

Returns:

a textual representation of the duration of the call

getTod

public String getTod()

Returns a timestamp of the call

Returns:

a string representation of the timestamp when the call was invoked.

getCSS

public String getCSS()

Helper method which returns a bootstrap css class based on the result of the call

Returns:

a css class used to represent the result of the call.