META-INF.apidocs.nl.praegus.fitnesse.slim.fixtures.SftpFixture.json Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of toolchain-fixtures Show documentation
Show all versions of toolchain-fixtures Show documentation
Extensions on existing fixtures to aid in automated testing
{
"constructors" : [ {
"readableName" : "sftp fixture",
"usage" : "| sftp fixture |",
"name" : "SftpFixture",
"docString" : "",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ]
} ],
"qualifiedName" : "nl.praegus.fitnesse.slim.fixtures.SftpFixture",
"publicMethods" : [ {
"readableName" : "set username",
"usage" : "| set username | [username] | ",
"contexthelp" : "set username <username>",
"name" : "setUsername",
"docString" : "Set the username\n@param username",
"annotations" : [ ],
"parameters" : [ {
"name" : "username",
"description" : "",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "set password",
"usage" : "| set password | [password] | ",
"contexthelp" : "set password <password>",
"name" : "setPassword",
"docString" : "Set the password\n@param password",
"annotations" : [ ],
"parameters" : [ {
"name" : "password",
"description" : "",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "set host",
"usage" : "| set host | [host] | ",
"contexthelp" : "set host <host>",
"name" : "setHost",
"docString" : "Set the host to connect to\n@param host",
"annotations" : [ ],
"parameters" : [ {
"name" : "host",
"description" : "",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "set port",
"usage" : "| set port | [port] | ",
"contexthelp" : "set port <port>",
"name" : "setPort",
"docString" : "Set the port number\n@param port",
"annotations" : [ ],
"parameters" : [ {
"name" : "port",
"description" : "",
"type" : "int"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "set private key",
"usage" : "| set private key | [privateKey] | ",
"contexthelp" : "set private key <privateKey>",
"name" : "setPrivateKey",
"docString" : "Set a private key identity\n@param privateKey The key as String\n@throws JSchException",
"annotations" : [ ],
"parameters" : [ {
"name" : "privateKey",
"description" : "The key as String",
"type" : "String"
} ],
"exceptions" : [ "com.jcraft.jsch.JSchException" ],
"returnType" : "void"
}, {
"readableName" : "set private key file with passphrase",
"usage" : "| set private key file | [privateKeyFile] | with passphrase | [passphrase] |",
"contexthelp" : "set private key file <privateKeyFile> with passphrase <passphrase>",
"name" : "setPrivateKeyFileWithPassphrase",
"docString" : "Set a private key identity, using a file and passphrase\n Usage: | set private key file | [privateKeyFile] | with passphrase | [passphrase] |\n@param privateKey The key file path\n@param passphrase The passphrase to use\n@throws JSchException",
"annotations" : [ ],
"parameters" : [ {
"name" : "privateKey",
"description" : "The key file path",
"type" : "String"
}, {
"name" : "passphrase",
"description" : "The passphrase to use",
"type" : "String"
} ],
"exceptions" : [ "com.jcraft.jsch.JSchException" ],
"returnType" : "void"
}, {
"readableName" : "download file to",
"usage" : "| download file | [remoteFile] | to | [localFile] | ",
"contexthelp" : "download file <remoteFile> to <localFile>",
"name" : "downloadFileTo",
"docString" : "Download a remote file\n@param remoteFile The file to download\n@param localFile The filename to write the downloaded file to\n@return A link to the downloaded file",
"annotations" : [ ],
"parameters" : [ {
"name" : "remoteFile",
"description" : "The file to download",
"type" : "String"
}, {
"name" : "localFile",
"description" : "The filename to write the downloaded file to",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "upload file to",
"usage" : "| upload file | [localFile] | to | [remoteFile] | ",
"contexthelp" : "upload file <localFile> to <remoteFile>",
"name" : "uploadFileTo",
"docString" : "Upload a local file to a remote location\n@param localFile The file to upload\n@param remoteFile The remote file to write to\n@return true if the file was successfully copied. False otherwise.",
"annotations" : [ ],
"parameters" : [ {
"name" : "localFile",
"description" : "The file to upload",
"type" : "String"
}, {
"name" : "remoteFile",
"description" : "The remote file to write to",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "delete file",
"usage" : "| delete file | [remoteFile] | ",
"contexthelp" : "delete file <remoteFile>",
"name" : "deleteFile",
"docString" : "Delete a remote file\n@param remoteFile\n@return true if the file was successfully deleted. False otherwise.",
"annotations" : [ ],
"parameters" : [ {
"name" : "remoteFile",
"description" : "",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "delete directory",
"usage" : "| delete directory | [remoteDir] | ",
"contexthelp" : "delete directory <remoteDir>",
"name" : "deleteDirectory",
"docString" : "Delete a renote directory\n@param remoteDir\n@return true if the directory was successfully deleted. False otherwise.",
"annotations" : [ ],
"parameters" : [ {
"name" : "remoteDir",
"description" : "",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "create directory",
"usage" : "| create directory | [remoteDir] | ",
"contexthelp" : "create directory <remoteDir>",
"name" : "createDirectory",
"docString" : "Create a renote directory\n@param remoteDir\n@return true if the directory was successfully created. False otherwise.",
"annotations" : [ ],
"parameters" : [ {
"name" : "remoteDir",
"description" : "",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "list files",
"usage" : "| list files | [remoteDir] | ",
"contexthelp" : "list files <remoteDir>",
"name" : "listFiles",
"docString" : "List the files in a renote directory\n@param remoteDir\n@return a list of file names in the specified directory",
"annotations" : [ ],
"parameters" : [ {
"name" : "remoteDir",
"description" : "",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "List<String>"
}, {
"readableName" : "text in remote file",
"usage" : "| text in remote file | [remoteFile] | ",
"contexthelp" : "text in remote file <remoteFile>",
"name" : "textInRemoteFile",
"docString" : "Get the text content of a renote file as a String\n@param remoteFile\n@return The file's contents",
"annotations" : [ ],
"parameters" : [ {
"name" : "remoteFile",
"description" : "",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "content of remote file",
"usage" : "| content of remote file | [remoteFile] | ",
"contexthelp" : "content of remote file <remoteFile>",
"name" : "contentOfRemoteFile",
"docString" : "Get the text content of a renote file as a formatted HTML String\n@param remoteFile\n@return The file's contents as formatted HTML",
"annotations" : [ ],
"parameters" : [ {
"name" : "remoteFile",
"description" : "",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "poll until file matching exists in",
"usage" : "| poll until file matching | [filePattern] | exists in | [directory] |",
"contexthelp" : "poll until file matching <filePattern> exists in <directory>",
"name" : "pollUntilFileMatchingExistsIn",
"docString" : "Poll until a file matching a given pattern exists in a given directory\n Use 'repeatAtMostTimes' and 'setRepeatInterval' to configure the repeat behaviour.\n Usage: | poll until file matching | [filePattern] | exists in | [directory] |\n@param filePattern\n@param directory\n@return The filename if a matching file was found. Null otherwise",
"annotations" : [ ],
"parameters" : [ {
"name" : "filePattern",
"description" : "",
"type" : "String"
}, {
"name" : "directory",
"description" : "",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "poll until no file matching exists in",
"usage" : "| poll until no file matching | [filePattern] | exists in | [directory] |",
"contexthelp" : "poll until no file matching <filePattern> exists in <directory>",
"name" : "pollUntilNoFileMatchingExistsIn",
"docString" : "Poll until no file matching a given pattern exists in a given directory\n Use 'repeatAtMostTimes' and 'setRepeatInterval' to configure the repeat behaviour.\n Usage: | poll until no file matching | [filePattern] | exists in | [directory] |\n@param filePattern\n@param directory\n@return true if no matching file was found. False otherwise",
"annotations" : [ ],
"parameters" : [ {
"name" : "filePattern",
"description" : "",
"type" : "String"
}, {
"name" : "directory",
"description" : "",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "poll until files matching exist in",
"usage" : "| poll until | [number] | files matching | [filePattern] | exist in | [directory] |",
"contexthelp" : "poll until <number> files matching <filePattern> exist in <directory>",
"name" : "pollUntilFilesMatchingExistIn",
"docString" : "Poll until at least n files matching a given pattern exist in a given directory\n Use 'repeatAtMostTimes' and 'setRepeatInterval' to configure the repeat behaviour.\n Usage: | poll until | [number] | files matching | [filePattern] | exist in | [directory] |\n@param number The number of files to poll for\n@param filePattern\n@param directory\n@return A list of filenames if at least [number] of matching files are found. Null otherwise",
"annotations" : [ ],
"parameters" : [ {
"name" : "number",
"description" : "The number of files to poll for",
"type" : "int"
}, {
"name" : "filePattern",
"description" : "",
"type" : "String"
}, {
"name" : "directory",
"description" : "",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "List<String>"
}, {
"readableName" : "set permissions of to",
"usage" : "| set permissions of | [remoteFile] | to | [chmodPermissions] | ",
"contexthelp" : "set permissions of <remoteFile> to <chmodPermissions>",
"name" : "setPermissionsOfTo",
"docString" : "Set the permissions of a remote file to a numerical (chmod) permission\n@param remoteFile\n@param chmodPermissions\n@return true if chmod completes with no exception, false otherwise",
"annotations" : [ ],
"parameters" : [ {
"name" : "remoteFile",
"description" : "",
"type" : "String"
}, {
"name" : "chmodPermissions",
"description" : "",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "set directory",
"usage" : "| set directory | [aDirectory] | ",
"contexthelp" : "set directory <aDirectory>",
"name" : "setDirectory",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "aDirectory",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "get directory",
"usage" : "| get directory |",
"contexthelp" : "get directory",
"name" : "getDirectory",
"docString" : "",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "create file from base 64",
"usage" : "| create file from base | [baseName] | 64 | [base64Content] | ",
"contexthelp" : "create file from base <baseName> 64 <base64Content>",
"name" : "createFileFromBase64",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "baseName",
"type" : "String"
}, {
"name" : "base64Content",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "create containing value",
"usage" : "| create containing | [filename] | value | [key] | ",
"contexthelp" : "create containing <filename> value <key>",
"name" : "createContainingValue",
"docString" : "Creates new file, containing value 'key'.\n@param filename name of file to create.\n@param key key whose value should be used to generate the file.\n@return file created.",
"annotations" : [ ],
"parameters" : [ {
"name" : "filename",
"description" : "name of file to create.",
"type" : "String"
}, {
"name" : "key",
"description" : "key whose value should be used to generate the file.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "create containing",
"usage" : "| create | [filename] | containing | [data] | ",
"contexthelp" : "create <filename> containing <data>",
"name" : "createContaining",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "filename",
"type" : "String"
}, {
"name" : "data",
"type" : "Object"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "create containing",
"usage" : "| create | [filename] | containing | [content] | ",
"contexthelp" : "create <filename> containing <content>",
"name" : "createContaining",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "filename",
"type" : "String"
}, {
"name" : "content",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "text in",
"usage" : "| text in | [filename] | ",
"contexthelp" : "text in <filename>",
"name" : "textIn",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "filename",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "take first line from",
"usage" : "| take first line from | [filename] | ",
"contexthelp" : "take first line from <filename>",
"name" : "takeFirstLineFrom",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "filename",
"type" : "String"
} ],
"exceptions" : [ "java.io.IOException" ],
"returnType" : "String"
}, {
"readableName" : "convert line endings of to windows",
"usage" : "| convert line endings of to windows | [filename] | ",
"contexthelp" : "convert line endings of to windows <filename>",
"name" : "convertLineEndingsOfToWindows",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "filename",
"type" : "String"
} ],
"exceptions" : [ "java.io.IOException" ],
"returnType" : "boolean"
}, {
"readableName" : "convert line endings of to unix",
"usage" : "| convert line endings of to unix | [filename] | ",
"contexthelp" : "convert line endings of to unix <filename>",
"name" : "convertLineEndingsOfToUnix",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "filename",
"type" : "String"
} ],
"exceptions" : [ "java.io.IOException" ],
"returnType" : "boolean"
}, {
"readableName" : "content of",
"usage" : "| content of | [filename] | ",
"contexthelp" : "content of <filename>",
"name" : "contentOf",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "filename",
"type" : "String"
} ],
"exceptions" : [ "java.io.IOException" ],
"returnType" : "String"
}, {
"readableName" : "create using",
"usage" : "| create | [filename] | using | [templateName] | ",
"contexthelp" : "create <filename> using <templateName>",
"name" : "createUsing",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "filename",
"type" : "String"
}, {
"name" : "templateName",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "copy to",
"usage" : "| copy | [sourceName] | to | [targetName] | ",
"contexthelp" : "copy <sourceName> to <targetName>",
"name" : "copyTo",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "sourceName",
"type" : "String"
}, {
"name" : "targetName",
"type" : "String"
} ],
"exceptions" : [ "java.io.IOException" ],
"returnType" : "String"
}, {
"readableName" : "size of",
"usage" : "| size of | [filename] | ",
"contexthelp" : "size of <filename>",
"name" : "sizeOf",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "filename",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "long"
}, {
"readableName" : "exists",
"usage" : "| exists | [filename] | ",
"contexthelp" : "exists <filename>",
"name" : "exists",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "filename",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "delete",
"usage" : "| delete | [filename] | ",
"contexthelp" : "delete <filename>",
"name" : "delete",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "filename",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "delete if exists",
"usage" : "| delete if exists | [filename] | ",
"contexthelp" : "delete if exists <filename>",
"name" : "deleteIfExists",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "filename",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "filename of",
"usage" : "| filename of | [filename] | ",
"contexthelp" : "filename of <filename>",
"name" : "filenameOf",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "filename",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "base name of",
"usage" : "| base name of | [filename] | ",
"contexthelp" : "base name of <filename>",
"name" : "baseNameOf",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "filename",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "extension of",
"usage" : "| extension of | [filename] | ",
"contexthelp" : "extension of <filename>",
"name" : "extensionOf",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "filename",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "poll until exists",
"usage" : "| poll until exists | [filename] | ",
"contexthelp" : "poll until exists <filename>",
"name" : "pollUntilExists",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "filename",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "poll until does not exist",
"usage" : "| poll until does not exist | [filename] | ",
"contexthelp" : "poll until does not exist <filename>",
"name" : "pollUntilDoesNotExist",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "filename",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "poll until size of exceeds",
"usage" : "| poll until size of | [filename] | exceeds | [expectedSize] | ",
"contexthelp" : "poll until size of <filename> exceeds <expectedSize>",
"name" : "pollUntilSizeOfExceeds",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "filename",
"type" : "String"
}, {
"name" : "expectedSize",
"type" : "long"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "append to",
"usage" : "| append | [extraContent] | to | [filename] | ",
"contexthelp" : "append <extraContent> to <filename>",
"name" : "appendTo",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "extraContent",
"type" : "String"
}, {
"name" : "filename",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "append to on new line",
"usage" : "| append to on new | [extraContent] | line | [filename] | ",
"contexthelp" : "append to on new <extraContent> line <filename>",
"name" : "appendToOnNewLine",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "extraContent",
"type" : "String"
}, {
"name" : "filename",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "zip as",
"usage" : "| zip | [inputfile] | as | [zipname] | ",
"contexthelp" : "zip <inputfile> as <zipname>",
"name" : "zipAs",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "inputfile",
"type" : "String"
}, {
"name" : "zipname",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "unzip as",
"usage" : "| unzip | [zipname] | as | [targetDir] | ",
"contexthelp" : "unzip <zipname> as <targetDir>",
"name" : "unzipAs",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "zipname",
"type" : "String"
}, {
"name" : "targetDir",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "number of files in zip",
"usage" : "| number of files in zip | [zipname] | ",
"contexthelp" : "number of files in zip <zipname>",
"name" : "numberOfFilesInZip",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "zipname",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "long"
}, {
"readableName" : "names of files in zip",
"usage" : "| names of files in zip | [zipname] | ",
"contexthelp" : "names of files in zip <zipname>",
"name" : "namesOfFilesInZip",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "zipname",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "ArrayList<String>"
}, {
"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.praegus.fitnesse.slim.fixtures.SftpFixture",
"name" : "SftpFixture",
"annotations" : [ ]
}© 2015 - 2024 Weber Informatics LLC | Privacy Policy