META-INF.apidocs.nl.hsac.fitnesse.fixture.slim.ListFixture.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" : "list fixture",
"usage" : "| list fixture |",
"name" : "ListFixture",
"docString" : "",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ]
} ],
"qualifiedName" : "nl.hsac.fitnesse.fixture.slim.ListFixture",
"publicMethods" : [ {
"readableName" : "display lists numbered",
"usage" : "| display lists numbered |",
"contexthelp" : "display lists numbered",
"name" : "displayListsNumbered",
"docString" : "Configures Slim to show lists as HTML numbered list (instead of comma separated between square brackets\n (i.e. '[' and ']').",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "display lists standard",
"usage" : "| display lists standard |",
"contexthelp" : "display lists standard",
"name" : "displayListsStandard",
"docString" : "Configures Slim to use standard coverters, i.e. go back to comma separated.",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "add",
"usage" : "| add | [value] | ",
"contexthelp" : "add <value>",
"name" : "add",
"docString" : "Adds new element to end of list.\n@param value value to add.",
"annotations" : [ ],
"parameters" : [ {
"name" : "value",
"description" : "value to add.",
"type" : "Object"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "set value at",
"usage" : "| set value | [value] | at | [index] | ",
"contexthelp" : "set value <value> at <index>",
"name" : "setValueAt",
"docString" : "Sets value of element at index (0-based). If the current list has less elements it is extended to\n have exactly index elements.\n@param value value to store.\n@param index 0-based index to add element.",
"annotations" : [ ],
"parameters" : [ {
"name" : "value",
"description" : "value to store.",
"type" : "Object"
}, {
"name" : "index",
"description" : "0-based index to add element.",
"type" : "int"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "value at",
"usage" : "| value at | [index] | ",
"contexthelp" : "value at <index>",
"name" : "valueAt",
"docString" : "Retrieves element at index (0-based).\n@param index 0-based index of element to retrieve value of.\n@return element at specified index.\n@throws SlimFixtureException if the list does not have at least index elements.",
"annotations" : [ ],
"parameters" : [ {
"name" : "index",
"description" : "0-based index of element to retrieve value of.",
"type" : "int"
} ],
"exceptions" : [ ],
"returnType" : "Object"
}, {
"readableName" : "index of",
"usage" : "| index of | [element] | ",
"contexthelp" : "index of <element>",
"name" : "indexOf",
"docString" : "Returns index of element.\n@param element element to get index of.\n@return index (0 based).",
"annotations" : [ ],
"parameters" : [ {
"name" : "element",
"description" : "element to get index of.",
"type" : "Object"
} ],
"exceptions" : [ ],
"returnType" : "int"
}, {
"readableName" : "element is present",
"usage" : "| element is present | [element] | ",
"contexthelp" : "element is present <element>",
"name" : "elementIsPresent",
"docString" : "Checks whether element is present in list.\n@param element element that should be present.\n@return true if element is present.",
"annotations" : [ ],
"parameters" : [ {
"name" : "element",
"description" : "element that should be present.",
"type" : "Object"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "copy list",
"usage" : "| copy list |",
"contexthelp" : "copy list",
"name" : "copyList",
"docString" : "@return new list containing current values.",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "ArrayList<Object>"
}, {
"readableName" : "copy values from",
"usage" : "| copy values from | [source] | ",
"contexthelp" : "copy values from <source>",
"name" : "copyValuesFrom",
"docString" : "Adds values to current list.\n@param source list whose values are to be copied.",
"annotations" : [ ],
"parameters" : [ {
"name" : "source",
"description" : "list whose values are to be copied.",
"type" : "Collection<Object>"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "size",
"usage" : "| size |",
"contexthelp" : "size",
"name" : "size",
"docString" : "@return number of elements in list.",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "int"
}, {
"readableName" : "add to",
"usage" : "| add | [value] | to | [aList] | ",
"contexthelp" : "add <value> to <aList>",
"name" : "addTo",
"docString" : "Adds new element to end of list.\n@param value value to add.\n@param aList list to add to.",
"annotations" : [ ],
"parameters" : [ {
"name" : "value",
"description" : "value to add.",
"type" : "Object"
}, {
"name" : "aList",
"description" : "list to add to.",
"type" : "List"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "set value at in",
"usage" : "| set value | [value] | at | [index] | in | [aList] | ",
"contexthelp" : "set value <value> at <index> in <aList>",
"name" : "setValueAtIn",
"docString" : "Sets value of element at index (0-based). If the current list has less elements it is extended to\n have exactly index elements.\n@param value value to store.\n@param index 0-based index to add element.\n@param aList list to set element in.",
"annotations" : [ ],
"parameters" : [ {
"name" : "value",
"description" : "value to store.",
"type" : "Object"
}, {
"name" : "index",
"description" : "0-based index to add element.",
"type" : "int"
}, {
"name" : "aList",
"description" : "list to set element in.",
"type" : "List"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "value at in",
"usage" : "| value at | [index] | in | [aList] | ",
"contexthelp" : "value at <index> in <aList>",
"name" : "valueAtIn",
"docString" : "Retrieves element at index (0-based).\n@param index 0-based index of element to retrieve value of.\n@param aList list to get element value from.\n@return element at specified index.\n@throws SlimFixtureException if the list does not have at least index elements.",
"annotations" : [ ],
"parameters" : [ {
"name" : "index",
"description" : "0-based index of element to retrieve value of.",
"type" : "int"
}, {
"name" : "aList",
"description" : "list to get element value from.",
"type" : "List"
} ],
"exceptions" : [ ],
"returnType" : "Object"
}, {
"readableName" : "index of in",
"usage" : "| index of | [element] | in | [aList] | ",
"contexthelp" : "index of <element> in <aList>",
"name" : "indexOfIn",
"docString" : "Returns index of element.\n@param element element to get index of.\n@param aList list to get element value from.\n@return index (0 based).",
"annotations" : [ ],
"parameters" : [ {
"name" : "element",
"description" : "element to get index of.",
"type" : "Object"
}, {
"name" : "aList",
"description" : "list to get element value from.",
"type" : "List"
} ],
"exceptions" : [ ],
"returnType" : "int"
}, {
"readableName" : "element is present in",
"usage" : "| element is present | [element] | in | [aList] | ",
"contexthelp" : "element is present <element> in <aList>",
"name" : "elementIsPresentIn",
"docString" : "Checks whether element is present in list.\n@param element element that should be present.\n@param aList list to get element value from.\n@return true if element is present.",
"annotations" : [ ],
"parameters" : [ {
"name" : "element",
"description" : "element that should be present.",
"type" : "Object"
}, {
"name" : "aList",
"description" : "list to get element value from.",
"type" : "List"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "copy values from to",
"usage" : "| copy values from | [source] | to | [target] | ",
"contexthelp" : "copy values from <source> to <target>",
"name" : "copyValuesFromTo",
"docString" : "Adds values to list.\n@param source list whose values are to be copied.\n@param target list to get element value from.",
"annotations" : [ ],
"parameters" : [ {
"name" : "source",
"description" : "list whose values are to be copied.",
"type" : "Collection<Object>"
}, {
"name" : "target",
"description" : "list to get element value from.",
"type" : "List<Object>"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "copy list",
"usage" : "| copy list | [aList] | ",
"contexthelp" : "copy list <aList>",
"name" : "copyList",
"docString" : "@param aList list to copy.\n@return new list containing list's values.",
"annotations" : [ ],
"parameters" : [ {
"name" : "aList",
"description" : "list to copy.",
"type" : "List"
} ],
"exceptions" : [ ],
"returnType" : "ArrayList<Object>"
}, {
"readableName" : "size of",
"usage" : "| size of | [aList] | ",
"contexthelp" : "size of <aList>",
"name" : "sizeOf",
"docString" : "@param aList list to get size of.\n@return number of elements in list.",
"annotations" : [ ],
"parameters" : [ {
"name" : "aList",
"description" : "list to get size of.",
"type" : "List"
} ],
"exceptions" : [ ],
"returnType" : "int"
}, {
"readableName" : "reset",
"usage" : "| reset |",
"contexthelp" : "reset",
"name" : "reset",
"docString" : "Called before next row is executed. (Clears all current values.)",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "set",
"usage" : "| set | index, value, |",
"contexthelp" : "set index, value,",
"name" : "set",
"docString" : "Sets a value.\n@param index index (0-based) to set value for.\n@param value value to be stored.",
"annotations" : [ ],
"parameters" : [ {
"name" : "index",
"description" : "index (0-based) to set value for.",
"type" : "int"
}, {
"name" : "value",
"description" : "value to be stored.",
"type" : "Object"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "get",
"usage" : "| get | [headerName] | ",
"contexthelp" : "get <headerName>",
"name" : "get",
"docString" : "Retrieves value for output column.\n@param headerName header of output column (without trailing '?').\n@return new list containing current values.",
"annotations" : [ ],
"parameters" : [ {
"name" : "headerName",
"description" : "header of output column (without trailing '?').",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "ArrayList<Object>"
}, {
"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.ListFixture",
"name" : "ListFixture",
"annotations" : [ ]
}© 2015 - 2024 Weber Informatics LLC | Privacy Policy