META-INF.apidocs.nl.hsac.fitnesse.fixture.slim.MapFixture.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" : "map fixture",
"usage" : "| map fixture |",
"name" : "MapFixture",
"docString" : "Creates new, having an empty current values collection.",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ]
}, {
"readableName" : "map fixture",
"usage" : "| map fixture | [map] |",
"name" : "MapFixture",
"docString" : "Creates new, using the elements of the supplied map as current values.\n@param map map to obtain current elements from.",
"annotations" : [ ],
"parameters" : [ {
"name" : "map",
"description" : "map to obtain current elements from.",
"type" : "Map<Object>"
} ],
"exceptions" : [ ]
} ],
"qualifiedName" : "nl.hsac.fitnesse.fixture.slim.MapFixture",
"publicMethods" : [ {
"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 map containing current values.",
"annotations" : [ ],
"parameters" : [ {
"name" : "headerName",
"description" : "header of output column (without trailing '?').",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "Map<Object>"
}, {
"readableName" : "copy map",
"usage" : "| copy map |",
"contexthelp" : "copy map",
"name" : "copyMap",
"docString" : "@return a copy of the current map.",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "Map<Object>"
}, {
"readableName" : "set int value for in",
"usage" : "| set int value | [value] | for | [name] | in | [map] | ",
"contexthelp" : "set int value <value> for <name> in <map>",
"name" : "setIntValueForIn",
"docString" : "Stores integer value in map.\n@param value value to be passed.\n@param name name to use this value for.\n@param map map to store value in.",
"annotations" : [ ],
"parameters" : [ {
"name" : "value",
"description" : "value to be passed.",
"type" : "int"
}, {
"name" : "name",
"description" : "name to use this value for.",
"type" : "String"
}, {
"name" : "map",
"description" : "map to store value in.",
"type" : "Map<Object>"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "set double value for in",
"usage" : "| set double value | [value] | for | [name] | in | [map] | ",
"contexthelp" : "set double value <value> for <name> in <map>",
"name" : "setDoubleValueForIn",
"docString" : "Stores double value in map.\n@param value value to be passed.\n@param name name to use this value for.\n@param map map to store value in.",
"annotations" : [ ],
"parameters" : [ {
"name" : "value",
"description" : "value to be passed.",
"type" : "double"
}, {
"name" : "name",
"description" : "name to use this value for.",
"type" : "String"
}, {
"name" : "map",
"description" : "map to store value in.",
"type" : "Map<Object>"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "set boolean value for in",
"usage" : "| set boolean value | [value] | for | [name] | in | [map] | ",
"contexthelp" : "set boolean value <value> for <name> in <map>",
"name" : "setBooleanValueForIn",
"docString" : "Stores boolean value in map.\n@param value value to be passed.\n@param name name to use this value for.\n@param map map to store value in.",
"annotations" : [ ],
"parameters" : [ {
"name" : "value",
"description" : "value to be passed.",
"type" : "boolean"
}, {
"name" : "name",
"description" : "name to use this value for.",
"type" : "String"
}, {
"name" : "map",
"description" : "map to store value in.",
"type" : "Map<Object>"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "set value for in",
"usage" : "| set value | [value] | for | [name] | in | [map] | ",
"contexthelp" : "set value <value> for <name> in <map>",
"name" : "setValueForIn",
"docString" : "Stores value in map.\n@param value value to be passed.\n@param name name to use this value for.\n@param map map to store value in.",
"annotations" : [ ],
"parameters" : [ {
"name" : "value",
"description" : "value to be passed.",
"type" : "Object"
}, {
"name" : "name",
"description" : "name to use this value for.",
"type" : "String"
}, {
"name" : "map",
"description" : "map to store value in.",
"type" : "Map<Object>"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "add value to in",
"usage" : "| add value | [value] | to | [name] | in | [map] | ",
"contexthelp" : "add value <value> to <name> in <map>",
"name" : "addValueToIn",
"docString" : "Adds value to a list map.\n@param value value to be passed.\n@param name name to use this value for.\n@param map map to store value in.",
"annotations" : [ ],
"parameters" : [ {
"name" : "value",
"description" : "value to be passed.",
"type" : "Object"
}, {
"name" : "name",
"description" : "name to use this value for.",
"type" : "String"
}, {
"name" : "map",
"description" : "map to store value in.",
"type" : "Map<Object>"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "copy values from to",
"usage" : "| copy values from | [otherMap] | to | [map] | ",
"contexthelp" : "copy values from <otherMap> to <map>",
"name" : "copyValuesFromTo",
"docString" : "Adds all values in the supplied map to the current values.\n@param otherMap to obtain values from.\n@param map map to store value in.",
"annotations" : [ ],
"parameters" : [ {
"name" : "otherMap",
"description" : "to obtain values from.",
"type" : "Map<Object>"
}, {
"name" : "map",
"description" : "map to store value in.",
"type" : "Map<Object>"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "set values for in",
"usage" : "| set values | [values] | for | [name] | in | [map] | ",
"contexthelp" : "set values <values> for <name> in <map>",
"name" : "setValuesForIn",
"docString" : "Stores list of values in map.\n@param values comma separated list of values.\n@param name name to use this list for.\n@param map map to store values in.",
"annotations" : [ ],
"parameters" : [ {
"name" : "values",
"description" : "comma separated list of values.",
"type" : "String"
}, {
"name" : "name",
"description" : "name to use this list for.",
"type" : "String"
}, {
"name" : "map",
"description" : "map to store values in.",
"type" : "Map<Object>"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "value in",
"usage" : "| value | [name] | in | [map] | ",
"contexthelp" : "value <name> in <map>",
"name" : "valueIn",
"docString" : "Gets value from map.\n@param name name of (possibly nested) property to get value from.\n@param map map to get value from.\n@return value found, if it could be found, null otherwise.",
"annotations" : [ ],
"parameters" : [ {
"name" : "name",
"description" : "name of (possibly nested) property to get value from.",
"type" : "String"
}, {
"name" : "map",
"description" : "map to get value from.",
"type" : "Map<Object>"
} ],
"exceptions" : [ ],
"returnType" : "Object"
}, {
"readableName" : "size",
"usage" : "| size |",
"contexthelp" : "size",
"name" : "size",
"docString" : "@return number of elements in map.",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "int"
}, {
"readableName" : "size of",
"usage" : "| size of | [val] | ",
"contexthelp" : "size of <val>",
"name" : "sizeOf",
"docString" : "@param val map or expression to count elements in.\n@return number of elements in map or list.",
"annotations" : [ ],
"parameters" : [ {
"name" : "val",
"description" : "map or expression to count elements in.",
"type" : "Object"
} ],
"exceptions" : [ ],
"returnType" : "int"
}, {
"readableName" : "size of in",
"usage" : "| size of | [expr] | in | [map] | ",
"contexthelp" : "size of <expr> in <map>",
"name" : "sizeOfIn",
"docString" : "Determines size of either (Map or Collection) value in the map.\n@param expr expression indicating which (possibly nested) value in the map to determine size of.\n@param map map to find value in.\n@return size of value.\n@throws SlimFixtureException if the value found is not a Map or Collection.",
"annotations" : [ ],
"parameters" : [ {
"name" : "expr",
"description" : "expression indicating which (possibly nested) value in the map to determine size of.",
"type" : "String"
}, {
"name" : "map",
"description" : "map to find value in.",
"type" : "Map<Object>"
} ],
"exceptions" : [ ],
"returnType" : "int"
}, {
"readableName" : "all keys",
"usage" : "| all keys |",
"contexthelp" : "all keys",
"name" : "allKeys",
"docString" : "@return all values in the map.",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "ArrayList<String>"
}, {
"readableName" : "all values",
"usage" : "| all values |",
"contexthelp" : "all values",
"name" : "allValues",
"docString" : "@return all values in the map.",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "ArrayList<Object>"
}, {
"readableName" : "content equals",
"usage" : "| content equals | [other] | ",
"contexthelp" : "content equals <other>",
"name" : "contentEquals",
"docString" : "Determines whether current map matches other.\n@param other other map to check.\n@return true if both maps are equal.",
"annotations" : [ ],
"parameters" : [ {
"name" : "other",
"description" : "other map to check.",
"type" : "Object"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "content of equals",
"usage" : "| content of | [one] | equals | [two] | ",
"contexthelp" : "content of <one> equals <two>",
"name" : "contentOfEquals",
"docString" : "Determines whether map one's content matches two.\n@param one map the check content of.\n@param two other map to check.\n@return true if both maps are equal.",
"annotations" : [ ],
"parameters" : [ {
"name" : "one",
"description" : "map the check content of.",
"type" : "Map<Object>"
}, {
"name" : "two",
"description" : "other map to check.",
"type" : "Object"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "set int value for",
"usage" : "| set int value | [value] | for | [name] | ",
"contexthelp" : "set int value <value> for <name>",
"name" : "setIntValueFor",
"docString" : "Stores integer value.\n@param value value to be passed.\n@param name name to use this value for.",
"annotations" : [ ],
"parameters" : [ {
"name" : "value",
"description" : "value to be passed.",
"type" : "int"
}, {
"name" : "name",
"description" : "name to use this value for.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "set double value for",
"usage" : "| set double value | [value] | for | [name] | ",
"contexthelp" : "set double value <value> for <name>",
"name" : "setDoubleValueFor",
"docString" : "Stores double value.\n@param value value to be passed.\n@param name name to use this value for.",
"annotations" : [ ],
"parameters" : [ {
"name" : "value",
"description" : "value to be passed.",
"type" : "double"
}, {
"name" : "name",
"description" : "name to use this value for.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "set boolean value for",
"usage" : "| set boolean value | [value] | for | [name] | ",
"contexthelp" : "set boolean value <value> for <name>",
"name" : "setBooleanValueFor",
"docString" : "Stores boolean value.\n@param value value to be passed.\n@param name name to use this value for.",
"annotations" : [ ],
"parameters" : [ {
"name" : "value",
"description" : "value to be passed.",
"type" : "boolean"
}, {
"name" : "name",
"description" : "name to use this value for.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "set value for",
"usage" : "| set value | [value] | for | [name] | ",
"contexthelp" : "set value <value> for <name>",
"name" : "setValueFor",
"docString" : "Stores value.\n@param value value to be stored.\n@param name name to use this value for.",
"annotations" : [ ],
"parameters" : [ {
"name" : "value",
"description" : "value to be stored.",
"type" : "Object"
}, {
"name" : "name",
"description" : "name to use this value for.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "add value to",
"usage" : "| add value | [value] | to | [name] | ",
"contexthelp" : "add value <value> to <name>",
"name" : "addValueTo",
"docString" : "Adds value to (end of) a list.\n@param value value to be stored.\n@param name name of list to extend.",
"annotations" : [ ],
"parameters" : [ {
"name" : "value",
"description" : "value to be stored.",
"type" : "Object"
}, {
"name" : "name",
"description" : "name of list to extend.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "copy values from",
"usage" : "| copy values from | [map] | ",
"contexthelp" : "copy values from <map>",
"name" : "copyValuesFrom",
"docString" : "Adds all values in the supplied map to the current values.\n@param map to obtain values from.",
"annotations" : [ ],
"parameters" : [ {
"name" : "map",
"description" : "to obtain values from.",
"type" : "Map<Object>"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "set values for",
"usage" : "| set values | [values] | for | [name] | ",
"contexthelp" : "set values <values> for <name>",
"name" : "setValuesFor",
"docString" : "Stores list of values in map.\n@param values comma separated list of values.\n@param name name to use this list for.",
"annotations" : [ ],
"parameters" : [ {
"name" : "values",
"description" : "comma separated list of values.",
"type" : "String"
}, {
"name" : "name",
"description" : "name to use this list for.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "set content of as value for",
"usage" : "| set content of as value | [file] | for | [key] | ",
"contexthelp" : "set content of as value <file> for <key>",
"name" : "setContentOfAsValueFor",
"docString" : "@param file file's whose content should be set as byte[]\n@param key key whose value should be set.",
"annotations" : [ ],
"parameters" : [ {
"name" : "file",
"description" : "file's whose content should be set as byte[]",
"type" : "String"
}, {
"name" : "key",
"description" : "key whose value should be set.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "set base 64 encoded content of as value for",
"usage" : "| set base 64 encoded content of as value | [file] | for | [key] | ",
"contexthelp" : "set base 64 encoded content of as value <file> for <key>",
"name" : "setBase64EncodedContentOfAsValueFor",
"docString" : "@param file file's whose content should be base64 encoded\n@param key key whose value should be set.",
"annotations" : [ ],
"parameters" : [ {
"name" : "file",
"description" : "file's whose content should be base64 encoded",
"type" : "String"
}, {
"name" : "key",
"description" : "key whose value should be set.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "clear value",
"usage" : "| clear value | [name] | ",
"contexthelp" : "clear value <name>",
"name" : "clearValue",
"docString" : "Clears a values previously set.\n@param name value to remove.\n@return true if value was present.",
"annotations" : [ ],
"parameters" : [ {
"name" : "name",
"description" : "value to remove.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "clear values",
"usage" : "| clear values |",
"contexthelp" : "clear values",
"name" : "clearValues",
"docString" : "Clears all values previously set.",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "value",
"usage" : "| value | [name] | ",
"contexthelp" : "value <name>",
"name" : "value",
"docString" : "Retrieves value of element at a specified key.\n@param name key to get value of (nested values may be retrieved by separating the keys with '.').\n@return value stored.",
"annotations" : [ ],
"parameters" : [ {
"name" : "name",
"description" : "key to get value of (nested values may be retrieved by separating the keys with '.').",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "Object"
}, {
"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 | key, value, |",
"contexthelp" : "set key, value,",
"name" : "set",
"docString" : "Sets a value.\n@param key (possibly nested) key to set value for.\n@param value value to be stored.",
"annotations" : [ ],
"parameters" : [ {
"name" : "key",
"description" : "(possibly nested) key to set value for.",
"type" : "String"
}, {
"name" : "value",
"description" : "value to be stored.",
"type" : "Object"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "expand periods in names to nested maps",
"usage" : "| expand periods in names to nested maps | [expand] | ",
"contexthelp" : "expand periods in names to nested maps <expand>",
"name" : "expandPeriodsInNamesToNestedMaps",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "expand",
"type" : "boolean"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "expands periods in names to nested maps",
"usage" : "| expands periods in names to nested maps |",
"contexthelp" : "expands periods in names to nested maps",
"name" : "expandsPeriodsInNamesToNestedMaps",
"docString" : "",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "get map helper",
"usage" : "| get map helper |",
"contexthelp" : "get map helper",
"name" : "getMapHelper",
"docString" : "@return helper to assist getting/setting (nested) values in a map.",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "MapHelper"
}, {
"readableName" : "set map helper",
"usage" : "| set map helper | [mapHelper] | ",
"contexthelp" : "set map helper <mapHelper>",
"name" : "setMapHelper",
"docString" : "@param mapHelper helper to assist getting/setting (nested) values in a map.",
"annotations" : [ ],
"parameters" : [ {
"name" : "mapHelper",
"description" : "helper to assist getting/setting (nested) values in a map.",
"type" : "MapHelper"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"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.MapFixture",
"name" : "MapFixture",
"annotations" : [ ]
}© 2015 - 2024 Weber Informatics LLC | Privacy Policy