mirror of https://github.com/reiseburo/whoas
325 lines
14 KiB
HTML
325 lines
14 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
<!-- **************************************************************** -->
|
|
<!-- * PLEASE KEEP COMPLICATED EXPRESSIONS OUT OF THESE TEMPLATES, * -->
|
|
<!-- * i.e. only iterate & print data where possible. Thanks, Jez. * -->
|
|
<!-- **************************************************************** -->
|
|
|
|
<html>
|
|
<head>
|
|
<!-- Generated by groovydoc (2.4.0) on Tue Mar 24 11:06:14 EDT 2015 -->
|
|
<title>WhoasFactory (whoas 0.1.5 API)</title>
|
|
<meta name="date" content="2015-03-24">
|
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
<link href="../../../../groovy.ico" type="image/x-icon" rel="shortcut icon">
|
|
<link href="../../../../groovy.ico" type="image/x-icon" rel="icon">
|
|
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
|
|
|
|
<body class="center">
|
|
<script type="text/javascript"><!--
|
|
if (location.href.indexOf('is-external=true') == -1) {
|
|
parent.document.title="WhoasFactory (whoas 0.1.5 API)";
|
|
}
|
|
//-->
|
|
</script>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
<div class="topNav"><a name="navbar_top">
|
|
<!-- -->
|
|
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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="../../../../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">
|
|
<div>
|
|
<ul class="navList">
|
|
<li><a href="../../../../index.html?com/github/lookout/whoas/WhoasFactory" target="_top">Frames</a></li>
|
|
<li><a href="WhoasFactory.html" target="_top">No Frames</a></li>
|
|
</ul>
|
|
</div>
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>Summary: </li>
|
|
Nested Field <li><a href="#property_summary">Property</a></li> Constructor <li><a href="#method_summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li> | Detail: </li>
|
|
Field <li><a href="#prop_detail">Property</a></li> Constructor <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">Package: <strong>com.github.lookout.whoas</strong></div>
|
|
|
|
<h2 title="[Groovy] Class WhoasFactory" class="title">[Groovy] Class WhoasFactory</h2>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<ul class="inheritance">
|
|
<li><ul class="inheritance"></ul></li><li>com.github.lookout.whoas.WhoasFactory
|
|
</ul>
|
|
<div class="description">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
|
|
|
|
|
|
<p> This factory will allow clients of whoas to build
|
|
different queues like in memory, persistent etc and runners
|
|
like sequential.
|
|
</p>
|
|
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="summary">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- =========== NESTED CLASS SUMMARY =========== -->
|
|
|
|
|
|
<!-- =========== ENUM CONSTANT SUMMARY =========== -->
|
|
|
|
<!-- =========== FIELD SUMMARY =========== -->
|
|
|
|
|
|
<!-- =========== PROPERTY SUMMARY =========== -->
|
|
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="property_summary"><!-- --></a>
|
|
<h3>Properties Summary</h3>
|
|
<ul class="blockList">
|
|
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Properties Summary table, listing nested classes, and an explanation">
|
|
<caption><span>Properties</span><span class="tabEnd"> </span></caption>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Type</th>
|
|
<th class="colLast" scope="col">Name and description</th>
|
|
</tr>
|
|
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code><strong><a href='../../../../com/github/lookout/whoas/WhoasQueueConfig.html'>WhoasQueueConfig</a></strong></code> </td>
|
|
<td class="colLast"><code><a href="#queueConfig"></a>queueConfig</code><br>Queue configuration</td>
|
|
</tr>
|
|
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code><strong>java.lang.String</strong></code> </td>
|
|
<td class="colLast"><code><a href="#runnerType"></a>runnerType</code><br>Type of runner to create in whoas.</td>
|
|
</tr>
|
|
|
|
</table>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
<!-- =========== ELEMENT SUMMARY =========== -->
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
<ul class="blockList">
|
|
|
|
<li class="blockList"><a name="method_summary"><!-- --></a>
|
|
<h3>Methods Summary</h3>
|
|
<ul class="blockList">
|
|
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Methods Summary table">
|
|
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Type</th>
|
|
<th class="colLast" scope="col">Name and description</th>
|
|
</tr>
|
|
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code><a href='../../../../com/github/lookout/whoas/AbstractHookQueue.html'>AbstractHookQueue</a></strong></code></td>
|
|
<td class="colLast"><code><strong><a href="#buildQueue()">buildQueue</a></strong>()</code><br>Allocate and return the queue based on stored queue type.</td>
|
|
</tr>
|
|
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code><a href='../../../../com/github/lookout/whoas/AbstractHookRunner.html'>AbstractHookRunner</a></strong></code></td>
|
|
<td class="colLast"><code><strong><a href="#buildRunner(com.github.lookout.whoas.AbstractHookQueue)">buildRunner</a></strong>(<a href='../../../../com/github/lookout/whoas/AbstractHookQueue.html'>AbstractHookQueue</a> hookQueue)</code><br>Allocate and return runner based on stored runner type</td>
|
|
</tr>
|
|
|
|
</table>
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="blockList"><a name="method_summary"><!-- --></a>
|
|
<h3>Inherited Methods Summary</h3>
|
|
<ul class="blockList">
|
|
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Inherited Methods Summary table">
|
|
<caption><span>Inherited Methods</span><span class="tabEnd"> </span></caption>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Methods inherited from class</th>
|
|
<th class="colLast" scope="col">Name</th>
|
|
</tr>
|
|
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>class java.lang.Object</strong></code></td>
|
|
<td class="colLast"><code>java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()</code></td>
|
|
</tr>
|
|
</table>
|
|
</ul>
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="details">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
|
|
|
|
|
|
|
|
|
|
<!-- =========== PROPERTY DETAIL =========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="prop_detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Property Detail</h3>
|
|
|
|
<a name="queueConfig"><!-- --></a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>@com.fasterxml.jackson.annotation.JsonProperty(value = "queue")
|
|
<a href='../../../../com/github/lookout/whoas/WhoasQueueConfig.html'>WhoasQueueConfig</a> <strong>queueConfig</strong></h4>
|
|
<p> Queue configuration
|
|
</p>
|
|
</li>
|
|
</ul>
|
|
|
|
<a name="runnerType"><!-- --></a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>@com.fasterxml.jackson.annotation.JsonProperty
|
|
java.lang.String <strong>runnerType</strong></h4>
|
|
<p> Type of runner to create in whoas.
|
|
|
|
Default runner in whoas is SequentialHookRunner
|
|
</p>
|
|
</li>
|
|
</ul>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!-- =========== METHOD DETAIL =========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="method_detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Detail</h3>
|
|
|
|
<a name="buildQueue()"><!-- --></a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4><a href='../../../../com/github/lookout/whoas/AbstractHookQueue.html'>AbstractHookQueue</a> <strong>buildQueue</strong>()</h4>
|
|
<p> Allocate and return the queue based on stored queue type.
|
|
|
|
If the queue cannot be created, then this throws
|
|
ClassNotFoundException - if the class is not found
|
|
IllegalAccessException - if the class or its nullary constructor is not accessible.
|
|
InstantiationException - if this Class represents an abstract class, an interface,
|
|
an array class, a primitive type, or void
|
|
or if the class has no nullary constructor
|
|
or if the instantiation fails for some other reason.
|
|
<DL><DT><B>Returns:</B></DT><DD>allocated queue</DD></DL></p>
|
|
</li>
|
|
</ul>
|
|
|
|
<a name="buildRunner(com.github.lookout.whoas.AbstractHookQueue)"><!-- --></a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4><a href='../../../../com/github/lookout/whoas/AbstractHookRunner.html'>AbstractHookRunner</a> <strong>buildRunner</strong>(<a href='../../../../com/github/lookout/whoas/AbstractHookQueue.html'>AbstractHookQueue</a> hookQueue)</h4>
|
|
<p> Allocate and return runner based on stored runner type
|
|
|
|
If the runner cannot be created, then this throws
|
|
ClassNotFoundException - if the class is not found
|
|
IllegalAccessException - if the class or its nullary constructor is not accessible.
|
|
InstantiationException - if this Class represents an abstract class, an interface,
|
|
an array class, a primitive type, or void
|
|
or if the class has no nullary constructor
|
|
or if the instantiation fails for some other reason. <DL><DT><B>Parameters:</B></DT><DD><code>hookQueue</code> - queue to associate with allocated runner</DD></DL><DL><DT><B>Returns:</B></DT><DD></DD></DL></p>
|
|
</li>
|
|
</ul>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
|
<div class="bottomNav"><a name="navbar_bottom">
|
|
<!-- -->
|
|
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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="../../../../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">
|
|
<div>
|
|
<ul class="navList">
|
|
<li><a href="../../../../index.html?com/github/lookout/whoas/WhoasFactory" target="_top">Frames</a></li>
|
|
<li><a href="WhoasFactory.html" target="_top">No Frames</a></li>
|
|
</ul>
|
|
</div>
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>Summary: </li>
|
|
Nested Field <li><a href="#property_summary">Property</a></li> Constructor <li><a href="#method_summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li> | Detail: </li>
|
|
Field <li><a href="#prop_detail">Property</a></li> Constructor <li><a href="#method_detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<p>Groovy Documentation</p>
|
|
<a name="skip-navbar_bottom">
|
|
<!-- -->
|
|
</a>
|
|
</div>
|
|
</div>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
</body>
|
|
</html>
|