verspaetung/groovydoc/com/github/reiseburo/verspaetung/Main.html

309 lines
15 KiB
HTML

<!--
Copyright 2003-2015 the original author or authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<!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.3) on Sat Nov 07 12:48:42 PST 2015 -->
<title>Main (verspaetung 0.5.0 API)</title>
<meta name="date" content="2015-11-07">
<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="Main (verspaetung 0.5.0 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/reiseburo/verspaetung/Main" target="_top">Frames</a></li>
<li><a href="Main.html" target="_top">No Frames</a></li>
</ul>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
Nested&nbsp;&nbsp;&nbsp;Field&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructor&nbsp;&nbsp;&nbsp;<li><a href="#method_summary">Method</a></li>&nbsp;&nbsp;&nbsp;
</ul>
<ul class="subNavList">
<li>&nbsp;|&nbsp;Detail:&nbsp;</li>
Field&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructor&nbsp;&nbsp;&nbsp;<li><a href="#method_detail">Method</a></li>&nbsp;&nbsp;&nbsp;
</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.reiseburo.verspaetung</strong></div>
<h2 title="[Groovy] Class Main" class="title">[Groovy] Class Main</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><ul class="inheritance"></ul></li><li>com.github.reiseburo.verspaetung.Main
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<p> Main entry point for running the verspaetung application
</p>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== NESTED CLASS SUMMARY =========== -->
<!-- =========== ENUM CONSTANT SUMMARY =========== -->
<!-- =========== FIELD SUMMARY =========== -->
<!-- =========== PROPERTY SUMMARY =========== -->
<!-- =========== 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">&nbsp;</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>static&nbsp;org.apache.commons.cli.Options</strong></code></td>
<td class="colLast"><code><strong><a href="#createCLI()">createCLI</a></strong>()</code><br>Create the Options option necessary for verspaetung to have CLI options</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static&nbsp;void</strong></code></td>
<td class="colLast"><code><strong><a href="#main(java.lang.String)">main</a></strong>(java.lang.String[] args)</code><br></td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static&nbsp;org.apache.commons.cli.CommandLine</strong></code></td>
<td class="colLast"><code><strong><a href="#parseCommandLine(java.lang.String)">parseCommandLine</a></strong>(java.lang.String[] args)</code><br>Parse out all the command line options from the array of string
arguments</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static&nbsp;void</strong></code></td>
<td class="colLast"><code><strong><a href="#registerMetricFor(com.github.reiseburo.verspaetung.KafkaConsumer, ConcurrentHashMap<KafkaConsumer, ConsumerGauge>, ConcurrentHashMap<KafkaConsumer, Integer>, ConcurrentHashMap<TopicPartition, Long>)">registerMetricFor</a></strong>(<a href='../../../../com/github/reiseburo/verspaetung/KafkaConsumer.html'>KafkaConsumer</a> consumer, java.util.concurrent.ConcurrentHashMap&lt;<a href='../../../../com/github/reiseburo/verspaetung/KafkaConsumer.html' title='KafkaConsumer'>KafkaConsumer</a>, <a href='../../../../com/github/reiseburo/verspaetung/metrics/ConsumerGauge.html' title='ConsumerGauge'>ConsumerGauge</a>&gt; consumerGauges, java.util.concurrent.ConcurrentHashMap&lt;<a href='../../../../com/github/reiseburo/verspaetung/KafkaConsumer.html' title='KafkaConsumer'>KafkaConsumer</a>, java.lang.Integer&gt; consumerOffsets, java.util.concurrent.ConcurrentHashMap&lt;<a href='../../../../com/github/reiseburo/verspaetung/TopicPartition.html' title='TopicPartition'>TopicPartition</a>, java.lang.Long&gt; topicOffsets)</code><br></td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static&nbsp;boolean</strong></code></td>
<td class="colLast"><code><strong><a href="#shouldExcludeConsumer(java.lang.String, com.github.reiseburo.verspaetung.KafkaConsumer)">shouldExcludeConsumer</a></strong>(java.lang.String[] excludeGroups, <a href='../../../../com/github/reiseburo/verspaetung/KafkaConsumer.html'>KafkaConsumer</a> consumer)</code><br>Return true if we should exclude the given KafkaConsumer from reporting</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">&nbsp;</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">
<!-- =========== METHOD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="createCLI()"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4>static&nbsp;org.apache.commons.cli.Options <strong>createCLI</strong>()</h4>
<p> Create the Options option necessary for verspaetung to have CLI options
</p>
</li>
</ul>
<a name="main(java.lang.String)"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4>static&nbsp;void <strong>main</strong>(java.lang.String[] args)</h4>
<p></p>
</li>
</ul>
<a name="parseCommandLine(java.lang.String)"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4>static&nbsp;org.apache.commons.cli.CommandLine <strong>parseCommandLine</strong>(java.lang.String[] args)</h4>
<p> Parse out all the command line options from the array of string
arguments
</p>
</li>
</ul>
<a name="registerMetricFor(com.github.reiseburo.verspaetung.KafkaConsumer, ConcurrentHashMap<KafkaConsumer, ConsumerGauge>, ConcurrentHashMap<KafkaConsumer, Integer>, ConcurrentHashMap<TopicPartition, Long>)"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4>static&nbsp;void <strong>registerMetricFor</strong>(<a href='../../../../com/github/reiseburo/verspaetung/KafkaConsumer.html'>KafkaConsumer</a> consumer, java.util.concurrent.ConcurrentHashMap&lt;<a href='../../../../com/github/reiseburo/verspaetung/KafkaConsumer.html' title='KafkaConsumer'>KafkaConsumer</a>, <a href='../../../../com/github/reiseburo/verspaetung/metrics/ConsumerGauge.html' title='ConsumerGauge'>ConsumerGauge</a>&gt; consumerGauges, java.util.concurrent.ConcurrentHashMap&lt;<a href='../../../../com/github/reiseburo/verspaetung/KafkaConsumer.html' title='KafkaConsumer'>KafkaConsumer</a>, java.lang.Integer&gt; consumerOffsets, java.util.concurrent.ConcurrentHashMap&lt;<a href='../../../../com/github/reiseburo/verspaetung/TopicPartition.html' title='TopicPartition'>TopicPartition</a>, java.lang.Long&gt; topicOffsets)</h4>
<p></p>
</li>
</ul>
<a name="shouldExcludeConsumer(java.lang.String, com.github.reiseburo.verspaetung.KafkaConsumer)"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4>static&nbsp;boolean <strong>shouldExcludeConsumer</strong>(java.lang.String[] excludeGroups, <a href='../../../../com/github/reiseburo/verspaetung/KafkaConsumer.html'>KafkaConsumer</a> consumer)</h4>
<p> Return true if we should exclude the given KafkaConsumer from reporting
</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/reiseburo/verspaetung/Main" target="_top">Frames</a></li>
<li><a href="Main.html" target="_top">No Frames</a></li>
</ul>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
Nested&nbsp;&nbsp;&nbsp;Field&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructor&nbsp;&nbsp;&nbsp;<li><a href="#method_summary">Method</a></li>&nbsp;&nbsp;&nbsp;
</ul>
<ul class="subNavList">
<li>&nbsp;|&nbsp;Detail:&nbsp;</li>
Field&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructor&nbsp;&nbsp;&nbsp;<li><a href="#method_detail">Method</a></li>&nbsp;&nbsp;&nbsp;
</ul>
</div>
<p>Groovy Documentation</p>
<a name="skip-navbar_bottom">
<!-- -->
</a>
</div>
</div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>