META-INF.apidocs.nl.hsac.fitnesse.fixture.slim.TimerFixture.json Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of hsac-fitnesse-fixtures Show documentation
Show all versions of hsac-fitnesse-fixtures Show documentation
Fixtures to assist in testing via FitNesse
{
"constructors" : [ {
"readableName" : "timer fixture",
"usage" : "| timer fixture |",
"name" : "TimerFixture",
"docString" : "",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ]
} ],
"qualifiedName" : "nl.hsac.fitnesse.fixture.slim.TimerFixture",
"publicMethods" : [ {
"readableName" : "start timer",
"usage" : "| start timer |",
"contexthelp" : "start timer",
"name" : "startTimer",
"docString" : "Starts (possibly replacing) default timer.",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "start timer",
"usage" : "| start timer | [name] | ",
"contexthelp" : "start timer <name>",
"name" : "startTimer",
"docString" : "Starts (possibly replacing) named timer.\n@param name name to timer to create.",
"annotations" : [ ],
"parameters" : [ {
"name" : "name",
"description" : "name to timer to create.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "stop timer",
"usage" : "| stop timer |",
"contexthelp" : "stop timer",
"name" : "stopTimer",
"docString" : "Stops default timer.\n@return time in milliseconds since timer was started.",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "long"
}, {
"readableName" : "stop timer",
"usage" : "| stop timer | [name] | ",
"contexthelp" : "stop timer <name>",
"name" : "stopTimer",
"docString" : "Stops named timer.\n@param name name of timer to stop.\n@return time in milliseconds since timer was started.",
"annotations" : [ ],
"parameters" : [ {
"name" : "name",
"description" : "name of timer to stop.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "long"
}, {
"readableName" : "time on timer",
"usage" : "| time on timer |",
"contexthelp" : "time on timer",
"name" : "timeOnTimer",
"docString" : "@return time in milliseconds since timer was started.",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "long"
}, {
"readableName" : "time on timer",
"usage" : "| time on timer | [name] | ",
"contexthelp" : "time on timer <name>",
"name" : "timeOnTimer",
"docString" : "@param name name of timer to get time from.\n@return time in milliseconds since timer was started.",
"annotations" : [ ],
"parameters" : [ {
"name" : "name",
"description" : "name of timer to get time from.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "long"
}, {
"readableName" : "pause timer",
"usage" : "| pause timer |",
"contexthelp" : "pause timer",
"name" : "pauseTimer",
"docString" : "Pauses default timer (stopping measurement), can be resumed later.\n@return time in milliseconds since timer was started.",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "long"
}, {
"readableName" : "pause timer",
"usage" : "| pause timer | [name] | ",
"contexthelp" : "pause timer <name>",
"name" : "pauseTimer",
"docString" : "Pauses named timer (stopping measurement), can be resumed later.\n@param name name of timer to pause.\n@return time in milliseconds since timer was started.",
"annotations" : [ ],
"parameters" : [ {
"name" : "name",
"description" : "name of timer to pause.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "long"
}, {
"readableName" : "resume timer",
"usage" : "| resume timer |",
"contexthelp" : "resume timer",
"name" : "resumeTimer",
"docString" : "Resumes default timer (after it was paused).",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "resume timer",
"usage" : "| resume timer | [name] | ",
"contexthelp" : "resume timer <name>",
"name" : "resumeTimer",
"docString" : "Resumes named timer (after it was paused).\n@param name name of timer to resume.",
"annotations" : [ ],
"parameters" : [ {
"name" : "name",
"description" : "name of timer to resume.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "all timer times",
"usage" : "| all timer times |",
"contexthelp" : "all timer times",
"name" : "allTimerTimes",
"docString" : "@return all running timers and their current times (in ms).",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "Map<Long>"
}, {
"readableName" : "stop all timers",
"usage" : "| stop all timers |",
"contexthelp" : "stop all timers",
"name" : "stopAllTimers",
"docString" : "Stops all running timers.\n@return all stopped timers and their current times (in ms).",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "Map<Long>"
}, {
"readableName" : "current system time",
"usage" : "| current system time |",
"contexthelp" : "current system time",
"name" : "currentSystemTime",
"docString" : "@return current system time.",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "current system time as",
"usage" : "| current system time as | [format] | ",
"contexthelp" : "current system time as <format>",
"name" : "currentSystemTimeAs",
"docString" : "@param format to return time (and possibly date) in.\n@return current system time formatted according to format.",
"annotations" : [ ],
"parameters" : [ {
"name" : "format",
"description" : "to return time (and possibly date) in.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "current system time as in",
"usage" : "| current system time as | [format] | in | [languageTag] | ",
"contexthelp" : "current system time as <format> in <languageTag>",
"name" : "currentSystemTimeAsIn",
"docString" : "@param format to return time (and possibly date) in.\n@param languageTag language to use when formatting.\n@return current system time formatted according to format.",
"annotations" : [ ],
"parameters" : [ {
"name" : "format",
"description" : "to return time (and possibly date) in.",
"type" : "String"
}, {
"name" : "languageTag",
"description" : "language to use when formatting.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "set global value to",
"usage" : "| set global value | [symbolName] | to | [value] | ",
"contexthelp" : "set global value <symbolName> to <value>",
"name" : "setGlobalValueTo",
"docString" : "Stores a (global) value so it can be accessed by other fixtures/pages.\n@param symbolName name to store value under.\n@param value value to store.",
"annotations" : [ ],
"parameters" : [ {
"name" : "symbolName",
"description" : "name to store value under.",
"type" : "String"
}, {
"name" : "value",
"description" : "value to store.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "global value",
"usage" : "| global value | [symbolName] | ",
"contexthelp" : "global value <symbolName>",
"name" : "globalValue",
"docString" : "Retrieves a (global) value, which was previously stored using #setGlobalValueTo().\n@param symbolName name value was stored under.",
"annotations" : [ ],
"parameters" : [ {
"name" : "symbolName",
"description" : "name value was stored under.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "wait seconds",
"usage" : "| wait seconds | [i] | ",
"contexthelp" : "wait seconds <i>",
"name" : "waitSeconds",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "i",
"type" : "int"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "wait milliseconds",
"usage" : "| wait milliseconds | [i] | ",
"contexthelp" : "wait milliseconds <i>",
"name" : "waitMilliseconds",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "i",
"type" : "int"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "set repeat interval to milliseconds",
"usage" : "| set repeat interval to milliseconds | [milliseconds] | ",
"contexthelp" : "set repeat interval to milliseconds <milliseconds>",
"name" : "setRepeatIntervalToMilliseconds",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "milliseconds",
"type" : "int"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "repeat interval",
"usage" : "| repeat interval |",
"contexthelp" : "repeat interval",
"name" : "repeatInterval",
"docString" : "",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "long"
}, {
"readableName" : "repeat at most times",
"usage" : "| repeat at most times | [maxCount] | ",
"contexthelp" : "repeat at most times <maxCount>",
"name" : "repeatAtMostTimes",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "maxCount",
"type" : "int"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "repeat at most times",
"usage" : "| repeat at most times |",
"contexthelp" : "repeat at most times",
"name" : "repeatAtMostTimes",
"docString" : "",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "int"
}, {
"readableName" : "repeat count",
"usage" : "| repeat count |",
"contexthelp" : "repeat count",
"name" : "repeatCount",
"docString" : "",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "int"
}, {
"readableName" : "time spent repeating",
"usage" : "| time spent repeating |",
"contexthelp" : "time spent repeating",
"name" : "timeSpentRepeating",
"docString" : "",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "long"
} ],
"typeName" : "nl.hsac.fitnesse.fixture.slim.TimerFixture",
"name" : "TimerFixture",
"annotations" : [ ]
}© 2015 - 2024 Weber Informatics LLC | Privacy Policy