mirror of
https://github.com/dmulloy2/ProtocolLib.git
synced 2024-11-28 13:45:22 +01:00
307 lines
12 KiB
HTML
307 lines
12 KiB
HTML
|
<!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 (version 1.7.0_21) on Tue May 14 01:28:32 CEST 2013 -->
|
||
|
|
<title>Report.ReportBuilder</title>
|
||
|
|
<meta name="date" content="2013-05-14">
|
||
|
|
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
<script type="text/javascript"><!--
|
||
|
|
if (location.href.indexOf('is-external=true') == -1) {
|
||
|
|
parent.document.title="Report.ReportBuilder";
|
||
|
|
}
|
||
|
|
//-->
|
||
|
|
</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="class-use/Report.ReportBuilder.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-files/index-1.html">Index</a></li>
|
||
|
|
<li><a href="../../../../help-doc.html">Help</a></li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
<div class="subNav">
|
||
|
|
<ul class="navList">
|
||
|
|
<li><a href="../../../../com/comphenix/protocol/error/Report.html" title="class in com.comphenix.protocol.error"><span class="strong">Prev Class</span></a></li>
|
||
|
|
<li><a href="../../../../com/comphenix/protocol/error/ReportType.html" title="class in com.comphenix.protocol.error"><span class="strong">Next Class</span></a></li>
|
||
|
|
</ul>
|
||
|
|
<ul class="navList">
|
||
|
|
<li><a href="../../../../index.html?com/comphenix/protocol/error/Report.ReportBuilder.html" target="_top">Frames</a></li>
|
||
|
|
<li><a href="Report.ReportBuilder.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>Constr | </li>
|
||
|
|
<li><a href="#method_summary">Method</a></li>
|
||
|
|
</ul>
|
||
|
|
<ul class="subNavList">
|
||
|
|
<li>Detail: </li>
|
||
|
|
<li>Field | </li>
|
||
|
|
<li>Constr | </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">com.comphenix.protocol.error</div>
|
||
|
|
<h2 title="Class Report.ReportBuilder" class="title">Class Report.ReportBuilder</h2>
|
||
|
|
</div>
|
||
|
|
<div class="contentContainer">
|
||
|
|
<ul class="inheritance">
|
||
|
|
<li>java.lang.Object</li>
|
||
|
|
<li>
|
||
|
|
<ul class="inheritance">
|
||
|
|
<li>com.comphenix.protocol.error.Report.ReportBuilder</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<div class="description">
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<dl>
|
||
|
|
<dt>Enclosing class:</dt>
|
||
|
|
<dd><a href="../../../../com/comphenix/protocol/error/Report.html" title="class in com.comphenix.protocol.error">Report</a></dd>
|
||
|
|
</dl>
|
||
|
|
<hr>
|
||
|
|
<br>
|
||
|
|
<pre>public static class <span class="strong">Report.ReportBuilder</span>
|
||
|
|
extends java.lang.Object</pre>
|
||
|
|
<div class="block">Must be constructed through the factory method in Report.</div>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
<div class="summary">
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList"><a name="method_summary">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<h3>Method Summary</h3>
|
||
|
|
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
|
||
|
|
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
|
||
|
|
<tr>
|
||
|
|
<th class="colFirst" scope="col">Modifier and Type</th>
|
||
|
|
<th class="colLast" scope="col">Method and Description</th>
|
||
|
|
</tr>
|
||
|
|
<tr class="altColor">
|
||
|
|
<td class="colFirst"><code><a href="../../../../com/comphenix/protocol/error/Report.html" title="class in com.comphenix.protocol.error">Report</a></code></td>
|
||
|
|
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/error/Report.ReportBuilder.html#build()">build</a></strong>()</code>
|
||
|
|
<div class="block">Construct a new report with the provided input.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="rowColor">
|
||
|
|
<td class="colFirst"><code><a href="../../../../com/comphenix/protocol/error/Report.ReportBuilder.html" title="class in com.comphenix.protocol.error">Report.ReportBuilder</a></code></td>
|
||
|
|
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/error/Report.ReportBuilder.html#callerParam(java.lang.Object...)">callerParam</a></strong>(java.lang.Object... callerParameters)</code>
|
||
|
|
<div class="block">Set the parameters in the caller method.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="altColor">
|
||
|
|
<td class="colFirst"><code><a href="../../../../com/comphenix/protocol/error/Report.ReportBuilder.html" title="class in com.comphenix.protocol.error">Report.ReportBuilder</a></code></td>
|
||
|
|
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/error/Report.ReportBuilder.html#error(java.lang.Throwable)">error</a></strong>(java.lang.Throwable exception)</code>
|
||
|
|
<div class="block">Set the current exception that occured.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="rowColor">
|
||
|
|
<td class="colFirst"><code><a href="../../../../com/comphenix/protocol/error/Report.ReportBuilder.html" title="class in com.comphenix.protocol.error">Report.ReportBuilder</a></code></td>
|
||
|
|
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/error/Report.ReportBuilder.html#messageParam(java.lang.Object...)">messageParam</a></strong>(java.lang.Object... messageParameters)</code>
|
||
|
|
<div class="block">Set the message parameters that are used to construct a message text.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="altColor">
|
||
|
|
<td class="colFirst"><code><a href="../../../../com/comphenix/protocol/error/Report.ReportBuilder.html" title="class in com.comphenix.protocol.error">Report.ReportBuilder</a></code></td>
|
||
|
|
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/error/Report.ReportBuilder.html#type(com.comphenix.protocol.error.ReportType)">type</a></strong>(<a href="../../../../com/comphenix/protocol/error/ReportType.html" title="class in com.comphenix.protocol.error">ReportType</a> type)</code>
|
||
|
|
<div class="block">Set the current report type.</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.Object</h3>
|
||
|
|
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
|
||
|
|
</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="type(com.comphenix.protocol.error.ReportType)">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>type</h4>
|
||
|
|
<pre>public <a href="../../../../com/comphenix/protocol/error/Report.ReportBuilder.html" title="class in com.comphenix.protocol.error">Report.ReportBuilder</a> type(<a href="../../../../com/comphenix/protocol/error/ReportType.html" title="class in com.comphenix.protocol.error">ReportType</a> type)</pre>
|
||
|
|
<div class="block">Set the current report type. Cannot be NULL.</div>
|
||
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - - report type.</dd>
|
||
|
|
<dt><span class="strong">Returns:</span></dt><dd>This builder, for chaining.</dd></dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="error(java.lang.Throwable)">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>error</h4>
|
||
|
|
<pre>public <a href="../../../../com/comphenix/protocol/error/Report.ReportBuilder.html" title="class in com.comphenix.protocol.error">Report.ReportBuilder</a> error(@Nullable
|
||
|
|
java.lang.Throwable exception)</pre>
|
||
|
|
<div class="block">Set the current exception that occured.</div>
|
||
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>exception</code> - - exception that occured.</dd>
|
||
|
|
<dt><span class="strong">Returns:</span></dt><dd>This builder, for chaining.</dd></dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="messageParam(java.lang.Object...)">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>messageParam</h4>
|
||
|
|
<pre>public <a href="../../../../com/comphenix/protocol/error/Report.ReportBuilder.html" title="class in com.comphenix.protocol.error">Report.ReportBuilder</a> messageParam(@Nullable
|
||
|
|
java.lang.Object... messageParameters)</pre>
|
||
|
|
<div class="block">Set the message parameters that are used to construct a message text.</div>
|
||
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>messageParameters</code> - - parameters for the report type.</dd>
|
||
|
|
<dt><span class="strong">Returns:</span></dt><dd>This builder, for chaining.</dd></dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="callerParam(java.lang.Object...)">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>callerParam</h4>
|
||
|
|
<pre>public <a href="../../../../com/comphenix/protocol/error/Report.ReportBuilder.html" title="class in com.comphenix.protocol.error">Report.ReportBuilder</a> callerParam(@Nullable
|
||
|
|
java.lang.Object... callerParameters)</pre>
|
||
|
|
<div class="block">Set the parameters in the caller method. This is optional.</div>
|
||
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>callerParameters</code> - - parameters of the caller method.</dd>
|
||
|
|
<dt><span class="strong">Returns:</span></dt><dd>This builder, for chaining.</dd></dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="build()">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockListLast">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>build</h4>
|
||
|
|
<pre>public <a href="../../../../com/comphenix/protocol/error/Report.html" title="class in com.comphenix.protocol.error">Report</a> build()</pre>
|
||
|
|
<div class="block">Construct a new report with the provided input.</div>
|
||
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>A new report.</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><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="class-use/Report.ReportBuilder.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-files/index-1.html">Index</a></li>
|
||
|
|
<li><a href="../../../../help-doc.html">Help</a></li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
<div class="subNav">
|
||
|
|
<ul class="navList">
|
||
|
|
<li><a href="../../../../com/comphenix/protocol/error/Report.html" title="class in com.comphenix.protocol.error"><span class="strong">Prev Class</span></a></li>
|
||
|
|
<li><a href="../../../../com/comphenix/protocol/error/ReportType.html" title="class in com.comphenix.protocol.error"><span class="strong">Next Class</span></a></li>
|
||
|
|
</ul>
|
||
|
|
<ul class="navList">
|
||
|
|
<li><a href="../../../../index.html?com/comphenix/protocol/error/Report.ReportBuilder.html" target="_top">Frames</a></li>
|
||
|
|
<li><a href="Report.ReportBuilder.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>Constr | </li>
|
||
|
|
<li><a href="#method_summary">Method</a></li>
|
||
|
|
</ul>
|
||
|
|
<ul class="subNavList">
|
||
|
|
<li>Detail: </li>
|
||
|
|
<li>Field | </li>
|
||
|
|
<li>Constr | </li>
|
||
|
|
<li><a href="#method_detail">Method</a></li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
<a name="skip-navbar_bottom">
|
||
|
|
<!-- -->
|
||
|
|
</a></div>
|
||
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||
|
|
</body>
|
||
|
|
</html>
|