You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@juneau.apache.org by ja...@apache.org on 2016/09/19 15:05:00 UTC
[09/51] [partial] incubator-juneau-website git commit: Add Maven
Generated Site to home page.
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/081b41e6/content/apidocs/org/apache/juneau/client/ResponsePattern.html
----------------------------------------------------------------------
diff --git a/content/apidocs/org/apache/juneau/client/ResponsePattern.html b/content/apidocs/org/apache/juneau/client/ResponsePattern.html
deleted file mode 100644
index 89d85ec..0000000
--- a/content/apidocs/org/apache/juneau/client/ResponsePattern.html
+++ /dev/null
@@ -1,403 +0,0 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
-<!-- NewPage -->
-<html lang="en">
-<head>
-<!-- Generated by javadoc -->
-<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<title>ResponsePattern (Apache Juneau (incubating) 6.0.0-incubating-SNAPSHOT)</title>
-<link rel="stylesheet" type="text/css" href="../../../../javadoc.css" title="Style">
-<script type="text/javascript" src="../../../../script.js"></script>
-</head>
-<body>
-<script type="text/javascript"><!--
- try {
- if (location.href.indexOf('is-external=true') == -1) {
- parent.document.title="ResponsePattern (Apache Juneau (incubating) 6.0.0-incubating-SNAPSHOT)";
- }
- }
- catch(err) {
- }
-//-->
-var methods = {"i0":10,"i1":10,"i2":10};
-var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
-var altColor = "altColor";
-var rowColor = "rowColor";
-var tableTab = "tableTab";
-var activeTableTab = "activeTableTab";
-</script>
-<noscript>
-<div>JavaScript is disabled on your browser.</div>
-</noscript>
-<!-- ========= START OF TOP NAVBAR ======= -->
-<div class="topNav"><a name="navbar.top">
-<!-- -->
-</a>
-<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
-<a name="navbar.top.firstrow">
-<!-- -->
-</a>
-<ul class="navList" title="Navigation">
-<li><a href="../../../../overview-summary.html">Overview</a></li>
-<li><a href="package-summary.html">Package</a></li>
-<li class="navBarCell1Rev">Class</li>
-<li><a href="class-use/ResponsePattern.html">Use</a></li>
-<li><a href="package-tree.html">Tree</a></li>
-<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
-<li><a href="../../../../index-all.html">Index</a></li>
-<li><a href="../../../../help-doc.html">Help</a></li>
-</ul>
-</div>
-<div class="subNav">
-<ul class="navList">
-<li><a href="../../../../org/apache/juneau/client/NameValuePairs.html" title="class in org.apache.juneau.client"><span class="typeNameLink">Prev Class</span></a></li>
-<li><a href="../../../../org/apache/juneau/client/RestCall.html" title="class in org.apache.juneau.client"><span class="typeNameLink">Next Class</span></a></li>
-</ul>
-<ul class="navList">
-<li><a href="../../../../index.html?org/apache/juneau/client/ResponsePattern.html" target="_top">Frames</a></li>
-<li><a href="ResponsePattern.html" target="_top">No Frames</a></li>
-</ul>
-<ul class="navList" id="allclasses_navbar_top">
-<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
-</ul>
-<div>
-<script type="text/javascript"><!--
- allClassesLink = document.getElementById("allclasses_navbar_top");
- if(window==top) {
- allClassesLink.style.display = "block";
- }
- else {
- allClassesLink.style.display = "none";
- }
- //-->
-</script>
-</div>
-<div>
-<ul class="subNavList">
-<li>Summary: </li>
-<li>Nested | </li>
-<li>Field | </li>
-<li><a href="#constructor.summary">Constr</a> | </li>
-<li><a href="#method.summary">Method</a></li>
-</ul>
-<ul class="subNavList">
-<li>Detail: </li>
-<li>Field | </li>
-<li><a href="#constructor.detail">Constr</a> | </li>
-<li><a href="#method.detail">Method</a></li>
-</ul>
-</div>
-<a name="skip.navbar.top">
-<!-- -->
-</a></div>
-<!-- ========= END OF TOP NAVBAR ========= -->
-<!-- ======== START OF CLASS DATA ======== -->
-<div class="header">
-<div class="subTitle">org.apache.juneau.client</div>
-<h2 title="Class ResponsePattern" class="title">Class ResponsePattern</h2>
-</div>
-<div class="contentContainer">
-<ul class="inheritance">
-<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
-<li>
-<ul class="inheritance">
-<li>org.apache.juneau.client.ResponsePattern</li>
-</ul>
-</li>
-</ul>
-<div class="description">
-<ul class="blockList">
-<li class="blockList">
-<hr>
-<br>
-<pre>public abstract class <a href="../../../../src-html/org/apache/juneau/client/ResponsePattern.html#line.82">ResponsePattern</a>
-extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
-<div class="block">Used to find regular expression matches in REST responses made through <a href="../../../../org/apache/juneau/client/RestCall.html" title="class in org.apache.juneau.client"><code>RestCall</code></a>.
- <p>
- Response patterns are applied to REST calls through the <a href="../../../../org/apache/juneau/client/RestCall.html#addResponsePattern-org.apache.juneau.client.ResponsePattern-"><code>RestCall.addResponsePattern(ResponsePattern)</code></a> method.
- <p>
- <h6 class='topic'>Example</h6>
- This example shows how to use a response pattern finder to find and capture patterns for <js>"x=number"</js> and <js>"y=string"</js>
- from a response body.
- <p>
- <p class='bcode'>
- <jk>final</jk> List<Number> xList = <jk>new</jk> ArrayList<Number>();
- <jk>final</jk> List<String> yList = <jk>new</jk> ArrayList<String>();
-
- restClient.doGet(<jsf>URL</jsf>)
- .addResponsePattern(
- <jk>new</jk> ResponsePattern(<js>"x=(\\d+)"</js>) {
- <ja>@Override</ja>
- <jk>public void</jk> onMatch(RestCall restCall, Matcher m) <jk>throws</jk> RestCallException {
- xList.add(Integer.<jsm>parseInt</jsm>(m.group(1)));
- }
- <ja>@Override</ja>
- <jk>public void</jk> onNoMatch(RestCall restCall) <jk>throws</jk> RestCallException {
- <jk>throw new</jk> RestCallException(<js>"No X's found!"</js>);
- }
- }
- )
- .addResponsePattern(
- <jk>new</jk> ResponsePattern(<js>"y=(\\S+)"</js>) {
- <ja>@Override</ja>
- <jk>public void</jk> onMatch(RestCall restCall, Matcher m) <jk>throws</jk> RestCallException {
- yList.add(m.group(1));
- }
- <ja>@Override</ja>
- <jk>public void</jk> onNoMatch(RestCall restCall) <jk>throws</jk> RestCallException {
- <jk>throw new</jk> RestCallException(<js>"No Y's found!"</js>);
- }
- }
- )
- .run();
- </p>
- <p>
- <h5 class='notes'>Important Notes:</h5>
- <ol class='notes'>
- <li><p>
- Using response patterns does not affect the functionality of any of the other methods
- used to retrieve the response such as <a href="../../../../org/apache/juneau/client/RestCall.html#getResponseAsString--"><code>RestCall.getResponseAsString()</code></a> or <a href="../../../../org/apache/juneau/client/RestCall.html#getResponse-java.lang.Class-"><code>RestCall.getResponse(Class)</code></a>.<br>
- HOWEVER, if you want to retrieve the entire text of the response from inside the match methods,
- use <a href="../../../../org/apache/juneau/client/RestCall.html#getCapturedResponse--"><code>RestCall.getCapturedResponse()</code></a> since this method will not absorb the response for those other methods.
- </p>
- <li><p>
- Response pattern methods are NOT executed if a REST exception occurs during the request.
- </p>
- <li><p>
- The <a href="../../../../org/apache/juneau/client/RestCall.html#successPattern-java.lang.String-"><code>RestCall.successPattern(String)</code></a> and <a href="../../../../org/apache/juneau/client/RestCall.html#failurePattern-java.lang.String-"><code>RestCall.failurePattern(String)</code></a> methods use instances of
- this class to throw <a href="../../../../org/apache/juneau/client/RestCallException.html" title="class in org.apache.juneau.client"><code>RestCallExceptions</code></a> when success patterns are not found or failure patterns
- are found.
- </p>
- <li><p>
- <a href="../../../../org/apache/juneau/client/ResponsePattern.html" title="class in org.apache.juneau.client"><code>ResponsePattern</code></a> objects are reusable and thread-safe.
- </p>
- </ol></div>
-<dl>
-<dt><span class="simpleTagLabel">Author:</span></dt>
-<dd>James Bognar (james.bognar@salesforce.com)</dd>
-</dl>
-</li>
-</ul>
-</div>
-<div class="summary">
-<ul class="blockList">
-<li class="blockList">
-<!-- ======== CONSTRUCTOR SUMMARY ======== -->
-<ul class="blockList">
-<li class="blockList"><a name="constructor.summary">
-<!-- -->
-</a>
-<h3>Constructor Summary</h3>
-<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
-<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
-<tr>
-<th class="colOne" scope="col">Constructor and Description</th>
-</tr>
-<tr class="altColor">
-<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/client/ResponsePattern.html#ResponsePattern-java.lang.String-">ResponsePattern</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> pattern)</code>
-<div class="block">Constructor.</div>
-</td>
-</tr>
-</table>
-</li>
-</ul>
-<!-- ========== METHOD SUMMARY =========== -->
-<ul class="blockList">
-<li class="blockList"><a name="method.summary">
-<!-- -->
-</a>
-<h3>Method Summary</h3>
-<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
-<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
-<tr>
-<th class="colFirst" scope="col">Modifier and Type</th>
-<th class="colLast" scope="col">Method and Description</th>
-</tr>
-<tr id="i0" class="altColor">
-<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
-<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/client/ResponsePattern.html#getPattern--">getPattern</a></span>()</code>
-<div class="block">Returns the pattern passed in through the constructor.</div>
-</td>
-</tr>
-<tr id="i1" class="rowColor">
-<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/client/ResponsePattern.html#onMatch-org.apache.juneau.client.RestCall-java.util.regex.Matcher-">onMatch</a></span>(<a href="../../../../org/apache/juneau/client/RestCall.html" title="class in org.apache.juneau.client">RestCall</a> rc,
- <a href="http://docs.oracle.com/javase/7/docs/api/java/util/regex/Matcher.html?is-external=true" title="class or interface in java.util.regex">Matcher</a> m)</code>
-<div class="block">Instances can override this method to handle when a regular expression pattern matches
- on the output.</div>
-</td>
-</tr>
-<tr id="i2" class="altColor">
-<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/client/ResponsePattern.html#onNoMatch-org.apache.juneau.client.RestCall-">onNoMatch</a></span>(<a href="../../../../org/apache/juneau/client/RestCall.html" title="class in org.apache.juneau.client">RestCall</a> rc)</code>
-<div class="block">Instances can override this method to handle when a regular expression pattern doesn't match on the output.</div>
-</td>
-</tr>
-</table>
-<ul class="blockList">
-<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
-<!-- -->
-</a>
-<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
-<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang
/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
-</ul>
-</li>
-</ul>
-</li>
-</ul>
-</div>
-<div class="details">
-<ul class="blockList">
-<li class="blockList">
-<!-- ========= CONSTRUCTOR DETAIL ======== -->
-<ul class="blockList">
-<li class="blockList"><a name="constructor.detail">
-<!-- -->
-</a>
-<h3>Constructor Detail</h3>
-<a name="ResponsePattern-java.lang.String-">
-<!-- -->
-</a>
-<ul class="blockListLast">
-<li class="blockList">
-<h4>ResponsePattern</h4>
-<pre>public <a href="../../../../src-html/org/apache/juneau/client/ResponsePattern.html#line.91">ResponsePattern</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> pattern)</pre>
-<div class="block">Constructor.</div>
-<dl>
-<dt><span class="paramLabel">Parameters:</span></dt>
-<dd><code>pattern</code> - Regular expression pattern.</dd>
-</dl>
-</li>
-</ul>
-</li>
-</ul>
-<!-- ============ METHOD DETAIL ========== -->
-<ul class="blockList">
-<li class="blockList"><a name="method.detail">
-<!-- -->
-</a>
-<h3>Method Detail</h3>
-<a name="getPattern--">
-<!-- -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>getPattern</h4>
-<pre>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/client/ResponsePattern.html#line.115">getPattern</a>()</pre>
-<div class="block">Returns the pattern passed in through the constructor.</div>
-<dl>
-<dt><span class="returnLabel">Returns:</span></dt>
-<dd>The pattern passed in through the constructor.</dd>
-</dl>
-</li>
-</ul>
-<a name="onMatch-org.apache.juneau.client.RestCall-java.util.regex.Matcher-">
-<!-- -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>onMatch</h4>
-<pre>public void <a href="../../../../src-html/org/apache/juneau/client/ResponsePattern.html#line.129">onMatch</a>(<a href="../../../../org/apache/juneau/client/RestCall.html" title="class in org.apache.juneau.client">RestCall</a> rc,
- <a href="http://docs.oracle.com/javase/7/docs/api/java/util/regex/Matcher.html?is-external=true" title="class or interface in java.util.regex">Matcher</a> m)
- throws <a href="../../../../org/apache/juneau/client/RestCallException.html" title="class in org.apache.juneau.client">RestCallException</a></pre>
-<div class="block">Instances can override this method to handle when a regular expression pattern matches
- on the output.
- <p>
- This method is called once for every pattern match that occurs in the response text.</div>
-<dl>
-<dt><span class="paramLabel">Parameters:</span></dt>
-<dd><code>rc</code> - The <a href="../../../../org/apache/juneau/client/RestCall.html" title="class in org.apache.juneau.client"><code>RestCall</code></a> that this pattern finder is being used on.</dd>
-<dd><code>m</code> - The regular expression <a href="http://docs.oracle.com/javase/7/docs/api/java/util/regex/Matcher.html?is-external=true" title="class or interface in java.util.regex"><code>Matcher</code></a>. Can be used to retrieve group matches in the pattern.</dd>
-<dt><span class="throwsLabel">Throws:</span></dt>
-<dd><code><a href="../../../../org/apache/juneau/client/RestCallException.html" title="class in org.apache.juneau.client">RestCallException</a></code> - Instances can throw an exception if a failure condition is detected.</dd>
-</dl>
-</li>
-</ul>
-<a name="onNoMatch-org.apache.juneau.client.RestCall-">
-<!-- -->
-</a>
-<ul class="blockListLast">
-<li class="blockList">
-<h4>onNoMatch</h4>
-<pre>public void <a href="../../../../src-html/org/apache/juneau/client/ResponsePattern.html#line.137">onNoMatch</a>(<a href="../../../../org/apache/juneau/client/RestCall.html" title="class in org.apache.juneau.client">RestCall</a> rc)
- throws <a href="../../../../org/apache/juneau/client/RestCallException.html" title="class in org.apache.juneau.client">RestCallException</a></pre>
-<div class="block">Instances can override this method to handle when a regular expression pattern doesn't match on the output.</div>
-<dl>
-<dt><span class="paramLabel">Parameters:</span></dt>
-<dd><code>rc</code> - The <a href="../../../../org/apache/juneau/client/RestCall.html" title="class in org.apache.juneau.client"><code>RestCall</code></a> that this pattern finder is being used on.</dd>
-<dt><span class="throwsLabel">Throws:</span></dt>
-<dd><code><a href="../../../../org/apache/juneau/client/RestCallException.html" title="class in org.apache.juneau.client">RestCallException</a></code> - Instances can throw an exception if a failure condition is detected.</dd>
-</dl>
-</li>
-</ul>
-</li>
-</ul>
-</li>
-</ul>
-</div>
-</div>
-<!-- ========= END OF CLASS DATA ========= -->
-<!-- ======= START OF BOTTOM NAVBAR ====== -->
-<div class="bottomNav"><a name="navbar.bottom">
-<!-- -->
-</a>
-<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
-<a name="navbar.bottom.firstrow">
-<!-- -->
-</a>
-<ul class="navList" title="Navigation">
-<li><a href="../../../../overview-summary.html">Overview</a></li>
-<li><a href="package-summary.html">Package</a></li>
-<li class="navBarCell1Rev">Class</li>
-<li><a href="class-use/ResponsePattern.html">Use</a></li>
-<li><a href="package-tree.html">Tree</a></li>
-<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
-<li><a href="../../../../index-all.html">Index</a></li>
-<li><a href="../../../../help-doc.html">Help</a></li>
-</ul>
-</div>
-<div class="subNav">
-<ul class="navList">
-<li><a href="../../../../org/apache/juneau/client/NameValuePairs.html" title="class in org.apache.juneau.client"><span class="typeNameLink">Prev Class</span></a></li>
-<li><a href="../../../../org/apache/juneau/client/RestCall.html" title="class in org.apache.juneau.client"><span class="typeNameLink">Next Class</span></a></li>
-</ul>
-<ul class="navList">
-<li><a href="../../../../index.html?org/apache/juneau/client/ResponsePattern.html" target="_top">Frames</a></li>
-<li><a href="ResponsePattern.html" target="_top">No Frames</a></li>
-</ul>
-<ul class="navList" id="allclasses_navbar_bottom">
-<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
-</ul>
-<div>
-<script type="text/javascript"><!--
- allClassesLink = document.getElementById("allclasses_navbar_bottom");
- if(window==top) {
- allClassesLink.style.display = "block";
- }
- else {
- allClassesLink.style.display = "none";
- }
- //-->
-</script>
-</div>
-<div>
-<ul class="subNavList">
-<li>Summary: </li>
-<li>Nested | </li>
-<li>Field | </li>
-<li><a href="#constructor.summary">Constr</a> | </li>
-<li><a href="#method.summary">Method</a></li>
-</ul>
-<ul class="subNavList">
-<li>Detail: </li>
-<li>Field | </li>
-<li><a href="#constructor.detail">Constr</a> | </li>
-<li><a href="#method.detail">Method</a></li>
-</ul>
-</div>
-<a name="skip.navbar.bottom">
-<!-- -->
-</a></div>
-<!-- ======== END OF BOTTOM NAVBAR ======= -->
-<p class="legalCopy"><small>Copyright © 2016 <a href="http://www.apache.org/">Apache</a>. All rights reserved.</small></p>
-</body>
-</html>