META-INF.apidocs.nl.hsac.fitnesse.fixture.slim.StringFixture.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" : "string fixture",
"usage" : "| string fixture |",
"name" : "StringFixture",
"docString" : "",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ]
} ],
"qualifiedName" : "nl.hsac.fitnesse.fixture.slim.StringFixture",
"publicMethods" : [ {
"readableName" : "value of",
"usage" : "| value of | [value] | ",
"contexthelp" : "value of <value>",
"name" : "valueOf",
"docString" : "Returns value.\n@param value value to return\n@return value",
"annotations" : [ ],
"parameters" : [ {
"name" : "value",
"description" : "value to return",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "length of",
"usage" : "| length of | [value] | ",
"contexthelp" : "length of <value>",
"name" : "lengthOf",
"docString" : "Determines length of string.\n@param value value to determine length of\n@return length of value",
"annotations" : [ ],
"parameters" : [ {
"name" : "value",
"description" : "value to determine length of",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "int"
}, {
"readableName" : "value differs from",
"usage" : "| value differs | [value1] | from | [value2] | ",
"contexthelp" : "value differs <value1> from <value2>",
"name" : "valueDiffersFrom",
"docString" : "Compares two Strings, returning false if they are equal.
\n\n nulls are handled without exceptions. Two null\n references are considered to be equal. The comparison is case sensitive.
\n@see org.apache.commons.lang3.StringUtils#equals(CharSequence, CharSequence)\n@param value1 the first String, may be null\n@param value2 the second String, may be null\n@return false if the Strings are equal, or both null",
"annotations" : [ ],
"parameters" : [ {
"name" : "value1",
"description" : "the first String, may be null",
"type" : "String"
}, {
"name" : "value2",
"description" : "the second String, may be null",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "value equals",
"usage" : "| value | [value1] | equals | [value2] | ",
"contexthelp" : "value <value1> equals <value2>",
"name" : "valueEquals",
"docString" : "Compares two Strings, returning true if they are equal.
\n\n nulls are handled without exceptions. Two null\n references are considered to be equal. The comparison is case sensitive.
\n@see org.apache.commons.lang3.StringUtils#equals(CharSequence, CharSequence)\n@param value1 the first String, may be null\n@param value2 the second String, may be null\n@return true if the Strings are equal, or both null",
"annotations" : [ ],
"parameters" : [ {
"name" : "value1",
"description" : "the first String, may be null",
"type" : "String"
}, {
"name" : "value2",
"description" : "the second String, may be null",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "text contains",
"usage" : "| text | [value] | contains | [expectedSubstring] | ",
"contexthelp" : "text <value> contains <expectedSubstring>",
"name" : "textContains",
"docString" : "Checks whether values contains a specific sub string.\n@param value value to find substring in.\n@param expectedSubstring text that is expected to occur in value.\n@return true if value contained the expected substring.",
"annotations" : [ ],
"parameters" : [ {
"name" : "value",
"description" : "value to find substring in.",
"type" : "String"
}, {
"name" : "expectedSubstring",
"description" : "text that is expected to occur in value.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "convert to upper case",
"usage" : "| convert to upper case | [value] | ",
"contexthelp" : "convert to upper case <value>",
"name" : "convertToUpperCase",
"docString" : "Converts the value to upper case.\n@param value value to put in upper case.\n@return value in capital letters.",
"annotations" : [ ],
"parameters" : [ {
"name" : "value",
"description" : "value to put in upper case.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "convert to lower case",
"usage" : "| convert to lower case | [value] | ",
"contexthelp" : "convert to lower case <value>",
"name" : "convertToLowerCase",
"docString" : "Converts the value to lower case.\n@param value value to put in lower case.\n@return value with all capital letters replaced by normal letters.",
"annotations" : [ ],
"parameters" : [ {
"name" : "value",
"description" : "value to put in lower case.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "convert to int",
"usage" : "| convert to int | [value] | ",
"contexthelp" : "convert to int <value>",
"name" : "convertToInt",
"docString" : "Determines integer value of String (so relative checks can be done).\n@param value string to convert to integer.\n@return integer value.",
"annotations" : [ ],
"parameters" : [ {
"name" : "value",
"description" : "string to convert to integer.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "Integer"
}, {
"readableName" : "convert to double",
"usage" : "| convert to double | [value] | ",
"contexthelp" : "convert to double <value>",
"name" : "convertToDouble",
"docString" : "Determines double value of String (so relative checks can be done).\n@param value string to convert to double.\n@return double value.",
"annotations" : [ ],
"parameters" : [ {
"name" : "value",
"description" : "string to convert to double.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "Double"
}, {
"readableName" : "remove whitespace",
"usage" : "| remove whitespace | [value] | ",
"contexthelp" : "remove whitespace <value>",
"name" : "removeWhitespace",
"docString" : "Removes all (sequences of) whitespace.\n@param value value to clean up.\n@return value without whitespace.",
"annotations" : [ ],
"parameters" : [ {
"name" : "value",
"description" : "value to clean up.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "normalize whitespace",
"usage" : "| normalize whitespace | [value] | ",
"contexthelp" : "normalize whitespace <value>",
"name" : "normalizeWhitespace",
"docString" : "Trims value and replaces all (sequences of) whitespace to a single space.\n@param value value to clean up.\n@return trimmed value with all whitespace converted to single space.",
"annotations" : [ ],
"parameters" : [ {
"name" : "value",
"description" : "value to clean up.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "replace all in with",
"usage" : "| replace all | [regEx] | in | [value] | with | [replace] | ",
"contexthelp" : "replace all <regEx> in <value> with <replace>",
"name" : "replaceAllInWith",
"docString" : "Replaces all occurrences of the regular expression in the value with the replacement value.\n@param regEx regular expression to match.\n@param value value to replace in.\n@param replace replacement pattern.\n@return result.",
"annotations" : [ ],
"parameters" : [ {
"name" : "regEx",
"description" : "regular expression to match.",
"type" : "String"
}, {
"name" : "value",
"description" : "value to replace in.",
"type" : "String"
}, {
"name" : "replace",
"description" : "replacement pattern.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "extract int from using group",
"usage" : "| extract int from | [value] | using | [regEx] | group | [groupIndex] | ",
"contexthelp" : "extract int from <value> using <regEx> group <groupIndex>",
"name" : "extractIntFromUsingGroup",
"docString" : "Extracts a whole number for a string using a regular expression.\n@param value input string.\n@param regEx regular expression to match against value.\n@param groupIndex index of group in regular expression containing the number.\n@return extracted number.",
"annotations" : [ ],
"parameters" : [ {
"name" : "value",
"description" : "input string.",
"type" : "String"
}, {
"name" : "regEx",
"description" : "regular expression to match against value.",
"type" : "String"
}, {
"name" : "groupIndex",
"description" : "index of group in regular expression containing the number.",
"type" : "int"
} ],
"exceptions" : [ ],
"returnType" : "Integer"
}, {
"readableName" : "convert line endings to windows",
"usage" : "| convert line endings to windows | [input] | ",
"contexthelp" : "convert line endings to windows <input>",
"name" : "convertLineEndingsToWindows",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "input",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "convert line endings to unix",
"usage" : "| convert line endings to unix | [input] | ",
"contexthelp" : "convert line endings to unix <input>",
"name" : "convertLineEndingsToUnix",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "input",
"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.StringFixture",
"name" : "StringFixture",
"annotations" : [ ]
}© 2015 - 2024 Weber Informatics LLC | Privacy Policy