mirror of
https://github.com/dmulloy2/ProtocolLib.git
synced 2024-12-01 07:03:41 +01:00
422 lines
16 KiB
HTML
422 lines
16 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</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";
|
|
}
|
|
//-->
|
|
</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.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/ErrorReporter.html" title="interface in com.comphenix.protocol.error"><span class="strong">Prev Class</span></a></li>
|
|
<li><a href="../../../../com/comphenix/protocol/error/Report.ReportBuilder.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.html" target="_top">Frames</a></li>
|
|
<li><a href="Report.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><a href="#nested_class_summary">Nested</a> | </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">com.comphenix.protocol.error</div>
|
|
<h2 title="Class Report" class="title">Class Report</h2>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<ul class="inheritance">
|
|
<li>java.lang.Object</li>
|
|
<li>
|
|
<ul class="inheritance">
|
|
<li>com.comphenix.protocol.error.Report</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<div class="description">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<hr>
|
|
<br>
|
|
<pre>public class <span class="strong">Report</span>
|
|
extends java.lang.Object</pre>
|
|
<div class="block">Represents a error or warning report.</div>
|
|
<dl><dt><span class="strong">Author:</span></dt>
|
|
<dd>Kristian</dd></dl>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="summary">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="nested_class_summary">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Nested Class Summary</h3>
|
|
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
|
|
<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Modifier and Type</th>
|
|
<th class="colLast" scope="col">Class and Description</th>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static class </code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/error/Report.ReportBuilder.html" title="class in com.comphenix.protocol.error">Report.ReportBuilder</a></strong></code>
|
|
<div class="block">Must be constructed through the factory method in Report.</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</li>
|
|
</ul>
|
|
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="constructor_summary">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Constructor Summary</h3>
|
|
<table class="overviewSummary" 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="colFirst" scope="col">Modifier</th>
|
|
<th class="colLast" scope="col">Constructor and Description</th>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>protected </code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/error/Report.html#Report(com.comphenix.protocol.error.ReportType, java.lang.Throwable, java.lang.Object[], java.lang.Object[])">Report</a></strong>(<a href="../../../../com/comphenix/protocol/error/ReportType.html" title="class in com.comphenix.protocol.error">ReportType</a> type,
|
|
java.lang.Throwable exception,
|
|
java.lang.Object[] messageParameters,
|
|
java.lang.Object[] callerParameters)</code>
|
|
<div class="block">Construct a new report with the given type and parameters.</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="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>java.lang.Object[]</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/error/Report.html#getCallerParameters()">getCallerParameters</a></strong>()</code>
|
|
<div class="block">Retrieve the parameters of the caller method.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>java.lang.Throwable</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/error/Report.html#getException()">getException</a></strong>()</code>
|
|
<div class="block">Retrieve the associated exception, or NULL if not found.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>java.lang.Object[]</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/error/Report.html#getMessageParameters()">getMessageParameters</a></strong>()</code>
|
|
<div class="block">Retrieve the message parameters that will be used to construc the report message.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>java.lang.String</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/error/Report.html#getReportMessage()">getReportMessage</a></strong>()</code>
|
|
<div class="block">Format the current report type with the provided message parameters.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code><a href="../../../../com/comphenix/protocol/error/ReportType.html" title="class in com.comphenix.protocol.error">ReportType</a></code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/error/Report.html#getType()">getType</a></strong>()</code>
|
|
<div class="block">Retrieve the report type.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/error/Report.html#hasCallerParameters()">hasCallerParameters</a></strong>()</code>
|
|
<div class="block">Determine if we have any caller parameters.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/error/Report.html#hasMessageParameters()">hasMessageParameters</a></strong>()</code>
|
|
<div class="block">Determine if we have any message parameters.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static <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.html#newBuilder(com.comphenix.protocol.error.ReportType)">newBuilder</a></strong>(<a href="../../../../com/comphenix/protocol/error/ReportType.html" title="class in com.comphenix.protocol.error">ReportType</a> type)</code>
|
|
<div class="block">Construct a new report builder.</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">
|
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="constructor_detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Constructor Detail</h3>
|
|
<a name="Report(com.comphenix.protocol.error.ReportType, java.lang.Throwable, java.lang.Object[], java.lang.Object[])">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>Report</h4>
|
|
<pre>protected Report(<a href="../../../../com/comphenix/protocol/error/ReportType.html" title="class in com.comphenix.protocol.error">ReportType</a> type,
|
|
@Nullable
|
|
java.lang.Throwable exception,
|
|
@Nullable
|
|
java.lang.Object[] messageParameters,
|
|
@Nullable
|
|
java.lang.Object[] callerParameters)</pre>
|
|
<div class="block">Construct a new report with the given type and parameters.</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>exception</code> - - exception that occured in the caller method.</dd><dd><code>type</code> - - the report type that will be used to construct the message.</dd><dd><code>messageParameters</code> - - parameters used to construct the report message.</dd><dd><code>callerParameters</code> - - parameters from the caller method.</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="newBuilder(com.comphenix.protocol.error.ReportType)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>newBuilder</h4>
|
|
<pre>public static <a href="../../../../com/comphenix/protocol/error/Report.ReportBuilder.html" title="class in com.comphenix.protocol.error">Report.ReportBuilder</a> newBuilder(<a href="../../../../com/comphenix/protocol/error/ReportType.html" title="class in com.comphenix.protocol.error">ReportType</a> type)</pre>
|
|
<div class="block">Construct a new report builder.</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - - the initial report type.</dd>
|
|
<dt><span class="strong">Returns:</span></dt><dd>Report builder.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getReportMessage()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getReportMessage</h4>
|
|
<pre>public java.lang.String getReportMessage()</pre>
|
|
<div class="block">Format the current report type with the provided message parameters.</div>
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>The formated report message.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getMessageParameters()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getMessageParameters</h4>
|
|
<pre>public java.lang.Object[] getMessageParameters()</pre>
|
|
<div class="block">Retrieve the message parameters that will be used to construc the report message.
|
|
<p<
|
|
This should not be confused with the method parameters of the caller method.</div>
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>Message parameters.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getCallerParameters()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getCallerParameters</h4>
|
|
<pre>public java.lang.Object[] getCallerParameters()</pre>
|
|
<div class="block">Retrieve the parameters of the caller method. Optional - may be NULL.</div>
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>Parameters or the caller method.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getType()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getType</h4>
|
|
<pre>public <a href="../../../../com/comphenix/protocol/error/ReportType.html" title="class in com.comphenix.protocol.error">ReportType</a> getType()</pre>
|
|
<div class="block">Retrieve the report type.</div>
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>Report type.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getException()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getException</h4>
|
|
<pre>public java.lang.Throwable getException()</pre>
|
|
<div class="block">Retrieve the associated exception, or NULL if not found.</div>
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>Associated exception, or NULL.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="hasMessageParameters()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>hasMessageParameters</h4>
|
|
<pre>public boolean hasMessageParameters()</pre>
|
|
<div class="block">Determine if we have any message parameters.</div>
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>TRUE if there are any message parameters, FALSE otherwise.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="hasCallerParameters()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>hasCallerParameters</h4>
|
|
<pre>public boolean hasCallerParameters()</pre>
|
|
<div class="block">Determine if we have any caller parameters.</div>
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>TRUE if there are any caller parameters, FALSE otherwise.</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.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/ErrorReporter.html" title="interface in com.comphenix.protocol.error"><span class="strong">Prev Class</span></a></li>
|
|
<li><a href="../../../../com/comphenix/protocol/error/Report.ReportBuilder.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.html" target="_top">Frames</a></li>
|
|
<li><a href="Report.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><a href="#nested_class_summary">Nested</a> | </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 ======= -->
|
|
</body>
|
|
</html>
|