smartrics.rest.fitnesse.fixture.support

Class Tools

java.lang.Object

smartrics.rest.fitnesse.fixture.support.Tools

public final class Tools
extends Object

Misc tool methods for string/xml/xpath manipulation.

Author:

smartrics

Method Summary

Modifier and Type	Method and Description
static String	convertEntryToString(String name, String value, String nvSep)
static String	convertMapToString(Map<String,String> map, String nvSep, String entrySep) converts a map to string
static Map<String,String>	convertStringToMap(String expStr, String nvSep, String entrySep, boolean cleanTags) parses a map from a string.
static NodeList	extractXPath(Map<String,String> ns, String xpathExpression, String content)
static Object	extractXPath(Map<String,String> ns, String xpathExpression, String content, QName returnType)
static Object	extractXPath(Map<String,String> ns, String xpathExpression, String content, QName returnType, String charset) extract the XPath from the content.
static NodeList	extractXPath(Map<String,String> ns, String xpathExpression, String content, String encoding)
static Object	extractXPath(String xpathExpression, String content, QName returnType)
static Object	extractXPath(String xpathExpression, String content, QName returnType, String encoding)
static String	fromHtml(String text)
static String	fromJSONtoXML(String json)
static String	fromSimpleTag(String somethingWithinATag)
static InputStream	getInputStreamFromString(String string, String encoding) Yet another stream 2 string function.
static String	getStringFromInputStream(InputStream is) Yet another stream 2 string function.
static String	getStringFromInputStream(InputStream is, String encoding) Yet another stream 2 string function.
static boolean	isValidJson(String presumeblyJson) this method uses @link JSONObject to parse the string and return true if parse succeeds.
static boolean	isValidXPath(Map<String,String> ns, String xpathExpression)
static String	makeContentForRightCell(String expected, RestDataTypeAdapter typeAdapter, CellFormatter<?> formatter, int minLenForToggle)
static String	makeContentForWrongCell(String expected, RestDataTypeAdapter typeAdapter, CellFormatter<?> formatter, int minLenForToggle)
static String	makeToggleCollapseable(String message, String content)
static boolean	regex(String text, String expr)
static String	toCode(String c)
static XPathExpression	toExpression(Map<String,String> ns, String xpathExpression)
static String	toHtml(String text) Substitutions <pre> and </pre>""<&lt;\n<br /> (space)&nbsp;-----(5 hyphens)<hr /> static String toHtmlLabel(String string) static String toHtmlLink(String href, String text) static String wrapInDiv(String body) static String xPathResultToXmlString(Object result) If the result is neither a NodeList or a Node it will simply return the #toString(). Methods inherited from class java.lang.Object clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait Method Detail extractXPath public static NodeList extractXPath(Map<String,String> ns, String xpathExpression, String content) Parameters: ns - the name space xpathExpression - the expression content - the content Returns: the list of nodes matching the supplied XPath. extractXPath public static NodeList extractXPath(Map<String,String> ns, String xpathExpression, String content, String encoding) Parameters: ns - the namespaces map xpathExpression - the xpath content - the content encoding - the charset Returns: the list of nodes matching the supplied XPath. extractXPath public static Object extractXPath(String xpathExpression, String content, QName returnType) Parameters: xpathExpression - the xpath content - the content returnType - the result type Returns: the list of nodes matching the supplied XPath. extractXPath public static Object extractXPath(String xpathExpression, String content, QName returnType, String encoding) Parameters: xpathExpression - the xpath content - the content returnType - the result type encoding - the encoding/charset Returns: the list of nodes mathching the supplied XPath. extractXPath public static Object extractXPath(Map<String,String> ns, String xpathExpression, String content, QName returnType) Parameters: ns - the namespaces map xpathExpression - the XPath expression content - the content returnType - the return type Returns: the list of nodes mathching the supplied XPath. extractXPath public static Object extractXPath(Map<String,String> ns, String xpathExpression, String content, QName returnType, String charset) extract the XPath from the content. the return value type is passed in input using one of the XPathConstants. See also XPathExpression.evaluate(Object item, QName returnType) ; Parameters: ns - the namespaces map xpathExpression - the XPath expression content - the content returnType - the return type charset - the charset Returns: the result xPathResultToXmlString public static String xPathResultToXmlString(Object result) If the result is neither a NodeList or a Node it will simply return the #toString(). Parameters: result - the result of an XPath expression (a NodeList or a Node). Returns: the serialised as xml result of an xpath expression evaluation. isValidXPath public static boolean isValidXPath(Map<String,String> ns, String xpathExpression) Parameters: ns - the namespaces map xpathExpression - the XPath Returns: true if the expression is valid toExpression public static XPathExpression toExpression(Map<String,String> ns, String xpathExpression) Parameters: ns - the namespaces map xpathExpression - the XPath Returns: the parsed string as XPathExpression isValidJson public static boolean isValidJson(String presumeblyJson) this method uses @link JSONObject to parse the string and return true if parse succeeds. Parameters: presumeblyJson - string with some json (possibly). Returns: true if json is valid fromJSONtoXML public static String fromJSONtoXML(String json) Parameters: json - the json string Returns: the string as xml. getStringFromInputStream public static String getStringFromInputStream(InputStream is) Yet another stream 2 string function. Parameters: is - the stream Returns: the string. getStringFromInputStream public static String getStringFromInputStream(InputStream is, String encoding) Yet another stream 2 string function. Parameters: is - the stream encoding - the encoding of the bytes in the stream Returns: the string. getInputStreamFromString public static InputStream getInputStreamFromString(String string, String encoding) Yet another stream 2 string function. Parameters: string - the string encoding - the encoding of the bytes in the stream Returns: the input stream. convertMapToString public static String convertMapToString(Map<String,String> map, String nvSep, String entrySep) converts a map to string Parameters: map - the map to convert nvSep - the nvp separator entrySep - the separator of each entry Returns: the serialised map. convertEntryToString public static String convertEntryToString(String name, String value, String nvSep) Parameters: name - the name value - the value nvSep - the separator Returns: the kvp as a string <name><sep><value>. regex public static boolean regex(String text, String expr) Parameters: text - the text expr - the regex Returns: true if regex matches text. convertStringToMap public static Map<String,String> convertStringToMap(String expStr, String nvSep, String entrySep, boolean cleanTags) parses a map from a string. Parameters: expStr - the string with the serialised map. nvSep - the separator for keys and values. entrySep - the separator for entries in the map. cleanTags - if true the value is cleaned from any present html tag. Returns: the parsed map. makeToggleCollapseable public static String makeToggleCollapseable(String message, String content) Parameters: message - the message to be included in the collapsable section header. content - the content collapsed. Returns: a string with the html/js code to implement a collapsable section in fitnesse. toHtml public static String toHtml(String text) Substitutions <pre> and </pre> "" < &lt; \n <br /> (space) &nbsp; ----- (5 hyphens) <hr /> Parameters: text - some text. Returns: the html. toCode public static String toCode(String c) Parameters: c - some text Returns: the text within <code> tags. fromSimpleTag public static String fromSimpleTag(String somethingWithinATag) Parameters: somethingWithinATag - some text enclosed in some html tag. Returns: the text within the tag. fromHtml public static String fromHtml(String text) Parameters: text - some html Returns: the text stripped out of all tags. toHtmlLabel public static String toHtmlLabel(String string) Parameters: string - a string Returns: the string htmlified as a fitnesse label. toHtmlLink public static String toHtmlLink(String href, String text) Parameters: href - a string ending up in the anchor href. text - a string within anchors. Returns: the string htmlified as a html link. makeContentForWrongCell public static String makeContentForWrongCell(String expected, RestDataTypeAdapter typeAdapter, CellFormatter<?> formatter, int minLenForToggle) Parameters: expected - the expected value typeAdapter - the body adapter for the cell formatter - the formatter minLenForToggle - the value determining whether the content should be rendered as a collapseable section. Returns: the formatted content for a cell with a wrong expectation makeContentForRightCell public static String makeContentForRightCell(String expected, RestDataTypeAdapter typeAdapter, CellFormatter<?> formatter, int minLenForToggle) Parameters: expected - the expected value typeAdapter - the body type adaptor formatter - the formatter the value determining whether the content should be rendered as a collapseable section. minLenForToggle - the value determining whether the content should be rendered as a collapseable section. Returns: the formatted content for a cell with a right expectation wrapInDiv public static String wrapInDiv(String body) Skip navigation links Overview Package Class Use Tree Deprecated Index Help Prev Class Next Class Frames No Frames All Classes Summary: Nested | Field | Constr | Method Detail: Field | Constr | Method Copyright © 2017 smartrics. All rights reserved.