|
1 | 1 | <!DOCTYPE HTML>
|
2 |
| -<!-- NewPage --> |
3 | 2 | <html lang>
|
4 | 3 | <head>
|
5 |
| -<!-- Generated by javadoc (11.0.25) on Sat Dec 28 14:06:09 UTC 2024 --> |
6 |
| -<title>AuditEventFormatter (checkstyle 10.21.1 API)</title> |
| 4 | +<!-- Generated by javadoc (17) on Sun Jan 26 15:00:39 UTC 2025 --> |
| 5 | +<title>AuditEventFormatter (checkstyle 10.21.2 API)</title> |
| 6 | +<meta name="viewport" content="width=device-width, initial-scale=1"> |
7 | 7 | <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
8 |
| -<meta name="dc.created" content="2024-12-28"> |
| 8 | +<meta name="dc.created" content="2025-01-26"> |
| 9 | +<meta name="description" content="declaration: package: com.puppycrawl.tools.checkstyle, interface: AuditEventFormatter"> |
| 10 | +<meta name="generator" content="javadoc/ClassWriterImpl"> |
9 | 11 | <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
|
10 |
| -<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.min.css" title="Style"> |
| 12 | +<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> |
11 | 13 | <link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style">
|
12 | 14 | <script type="text/javascript" src="../../../../script.js"></script>
|
13 |
| -<script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script> |
14 |
| -<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
15 |
| -<!--[if IE]> |
16 |
| -<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
17 |
| -<![endif]--> |
18 |
| -<script type="text/javascript" src="../../../../jquery/jquery-3.7.1.min.js"></script> |
19 |
| -<script type="text/javascript" src="../../../../jquery/jquery-ui.min.js"></script> |
| 15 | +<script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> |
| 16 | +<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> |
20 | 17 | </head>
|
21 |
| -<body> |
22 |
| -<script type="text/javascript"><!-- |
23 |
| - try { |
24 |
| - if (location.href.indexOf('is-external=true') == -1) { |
25 |
| - parent.document.title="AuditEventFormatter (checkstyle 10.21.1 API)"; |
26 |
| - } |
27 |
| - } |
28 |
| - catch(err) { |
29 |
| - } |
30 |
| -//--> |
31 |
| -var data = {"i0":6}; |
32 |
| -var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
33 |
| -var altColor = "altColor"; |
34 |
| -var rowColor = "rowColor"; |
35 |
| -var tableTab = "tableTab"; |
36 |
| -var activeTableTab = "activeTableTab"; |
| 18 | +<body class="class-declaration-page"> |
| 19 | +<script type="text/javascript">var evenRowColor = "even-row-color"; |
| 20 | +var oddRowColor = "odd-row-color"; |
| 21 | +var tableTab = "table-tab"; |
| 22 | +var activeTableTab = "active-table-tab"; |
37 | 23 | var pathtoroot = "../../../../";
|
38 |
| -var useModuleDirectories = true; |
39 | 24 | loadScripts(document, 'script');</script>
|
40 | 25 | <noscript>
|
41 | 26 | <div>JavaScript is disabled on your browser.</div>
|
42 | 27 | </noscript>
|
43 |
| -<header role="banner"> |
| 28 | +<div class="flex-box"> |
| 29 | +<header role="banner" class="flex-header"> |
44 | 30 | <nav role="navigation">
|
45 |
| -<div class="fixedNav"> |
46 | 31 | <!-- ========= START OF TOP NAVBAR ======= -->
|
47 |
| -<div class="topNav"><a id="navbar.top"> |
48 |
| -<!-- --> |
49 |
| -</a> |
50 |
| -<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
51 |
| -<a id="navbar.top.firstrow"> |
52 |
| -<!-- --> |
53 |
| -</a> |
54 |
| -<ul class="navList" title="Navigation"> |
| 32 | +<div class="top-nav" id="navbar-top"> |
| 33 | +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| 34 | +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
55 | 35 | <li><a href="../../../../index.html">Overview</a></li>
|
56 | 36 | <li><a href="package-summary.html">Package</a></li>
|
57 |
| -<li class="navBarCell1Rev">Class</li> |
| 37 | +<li class="nav-bar-cell1-rev">Class</li> |
58 | 38 | <li><a href="class-use/AuditEventFormatter.html">Use</a></li>
|
59 | 39 | <li><a href="package-tree.html">Tree</a></li>
|
60 | 40 | <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
|
61 | 41 | <li><a href="../../../../index-all.html">Index</a></li>
|
62 |
| -<li><a href="../../../../help-doc.html">Help</a></li> |
| 42 | +<li><a href="../../../../help-doc.html#class">Help</a></li> |
63 | 43 | </ul>
|
64 | 44 | </div>
|
65 |
| -<div class="subNav"> |
66 |
| -<ul class="navList" id="allclasses_navbar_top"> |
67 |
| -<li><a href="../../../../allclasses.html">All Classes</a></li> |
68 |
| -</ul> |
69 |
| -<ul class="navListSearch"> |
70 |
| -<li><label for="search">SEARCH:</label> |
71 |
| -<input type="text" id="search" value="search" disabled="disabled"> |
72 |
| -<input type="reset" id="reset" value="reset" disabled="disabled"> |
73 |
| -</li> |
74 |
| -</ul> |
75 |
| -<div> |
76 |
| -<script type="text/javascript"><!-- |
77 |
| - allClassesLink = document.getElementById("allclasses_navbar_top"); |
78 |
| - if(window==top) { |
79 |
| - allClassesLink.style.display = "block"; |
80 |
| - } |
81 |
| - else { |
82 |
| - allClassesLink.style.display = "none"; |
83 |
| - } |
84 |
| - //--> |
85 |
| -</script> |
86 |
| -<noscript> |
87 |
| -<div>JavaScript is disabled on your browser.</div> |
88 |
| -</noscript> |
89 |
| -</div> |
| 45 | +<div class="sub-nav"> |
90 | 46 | <div>
|
91 |
| -<ul class="subNavList"> |
| 47 | +<ul class="sub-nav-list"> |
92 | 48 | <li>Summary: </li>
|
93 | 49 | <li>Nested | </li>
|
94 | 50 | <li>Field | </li>
|
95 | 51 | <li>Constr | </li>
|
96 |
| -<li><a href="#method.summary">Method</a></li> |
| 52 | +<li><a href="#method-summary">Method</a></li> |
97 | 53 | </ul>
|
98 |
| -<ul class="subNavList"> |
| 54 | +<ul class="sub-nav-list"> |
99 | 55 | <li>Detail: </li>
|
100 | 56 | <li>Field | </li>
|
101 | 57 | <li>Constr | </li>
|
102 |
| -<li><a href="#method.detail">Method</a></li> |
| 58 | +<li><a href="#method-detail">Method</a></li> |
103 | 59 | </ul>
|
104 | 60 | </div>
|
105 |
| -<a id="skip.navbar.top"> |
106 |
| -<!-- --> |
107 |
| -</a></div> |
108 |
| -<!-- ========= END OF TOP NAVBAR ========= --> |
| 61 | +<div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| 62 | +<input type="text" id="search-input" value="search" disabled="disabled"> |
| 63 | +<input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| 64 | +</div> |
109 | 65 | </div>
|
110 |
| -<div class="navPadding"> </div> |
111 |
| -<script type="text/javascript"><!-- |
112 |
| -$('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
113 |
| -//--> |
114 |
| -</script> |
115 |
| -</nav> |
| 66 | +<!-- ========= END OF TOP NAVBAR ========= --> |
| 67 | +<span class="skip-nav" id="skip-navbar-top"></span></nav> |
116 | 68 | </header>
|
117 |
| -<!-- ======== START OF CLASS DATA ======== --> |
| 69 | +<div class="flex-content"> |
118 | 70 | <main role="main">
|
| 71 | +<!-- ======== START OF CLASS DATA ======== --> |
119 | 72 | <div class="header">
|
120 |
| -<div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">com.puppycrawl.tools.checkstyle</a></div> |
121 |
| -<h2 title="Interface AuditEventFormatter" class="title">Interface AuditEventFormatter</h2> |
| 73 | +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">com.puppycrawl.tools.checkstyle</a></div> |
| 74 | +<h1 title="Interface AuditEventFormatter" class="title">Interface AuditEventFormatter</h1> |
122 | 75 | </div>
|
123 |
| -<div class="contentContainer"> |
124 |
| -<div class="description"> |
125 |
| -<ul class="blockList"> |
126 |
| -<li class="blockList"> |
127 |
| -<dl> |
| 76 | +<section class="class-description" id="class-description"> |
| 77 | +<dl class="notes"> |
128 | 78 | <dt>All Known Implementing Classes:</dt>
|
129 | 79 | <dd><code><a href="AuditEventDefaultFormatter.html" title="class in com.puppycrawl.tools.checkstyle">AuditEventDefaultFormatter</a></code></dd>
|
130 | 80 | </dl>
|
131 |
| -<dl> |
| 81 | +<dl class="notes"> |
132 | 82 | <dt>Functional Interface:</dt>
|
133 | 83 | <dd>This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.</dd>
|
134 | 84 | </dl>
|
135 | 85 | <hr>
|
136 |
| -<pre><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/FunctionalInterface.html?is-external=true" title="class or interface in java.lang" class="externalLink">@FunctionalInterface</a> |
137 |
| -public interface <a href="../../../../src-html/com/puppycrawl/tools/checkstyle/AuditEventFormatter.html#line.27">AuditEventFormatter</a></pre> |
| 86 | +<div class="type-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/FunctionalInterface.html" title="class or interface in java.lang" class="external-link">@FunctionalInterface</a> |
| 87 | +</span><span class="modifiers">public interface </span><span class="element-name"><a href="../../../../src-html/com/puppycrawl/tools/checkstyle/AuditEventFormatter.html#line-27">AuditEventFormatter</a></span></div> |
138 | 88 | <div class="block">Represents the formatter interface for log message.</div>
|
139 |
| -</li> |
140 |
| -</ul> |
141 |
| -</div> |
142 |
| -<div class="summary"> |
143 |
| -<ul class="blockList"> |
144 |
| -<li class="blockList"> |
| 89 | +</section> |
| 90 | +<section class="summary"> |
| 91 | +<ul class="summary-list"> |
145 | 92 | <!-- ========== METHOD SUMMARY =========== -->
|
146 |
| -<section> |
147 |
| -<ul class="blockList"> |
148 |
| -<li class="blockList"><a id="method.summary"> |
149 |
| -<!-- --> |
150 |
| -</a> |
151 |
| -<h3>Method Summary</h3> |
152 |
| -<table class="memberSummary"> |
153 |
| -<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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
154 |
| -<tr> |
155 |
| -<th class="colFirst" scope="col">Modifier and Type</th> |
156 |
| -<th class="colSecond" scope="col">Method</th> |
157 |
| -<th class="colLast" scope="col">Description</th> |
158 |
| -</tr> |
159 |
| -<tr id="i0" class="altColor"> |
160 |
| -<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
161 |
| -<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#format(com.puppycrawl.tools.checkstyle.api.AuditEvent)">format</a></span>​(<a href="api/AuditEvent.html" title="class in com.puppycrawl.tools.checkstyle.api">AuditEvent</a> event)</code></th> |
162 |
| -<td class="colLast"> |
| 93 | +<li> |
| 94 | +<section class="method-summary" id="method-summary"> |
| 95 | +<h2>Method Summary</h2> |
| 96 | +<div id="method-summary-table"> |
| 97 | +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div> |
| 98 | +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> |
| 99 | +<div class="summary-table three-column-summary"> |
| 100 | +<div class="table-header col-first">Modifier and Type</div> |
| 101 | +<div class="table-header col-second">Method</div> |
| 102 | +<div class="table-header col-last">Description</div> |
| 103 | +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| 104 | +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#format(com.puppycrawl.tools.checkstyle.api.AuditEvent)" class="member-name-link">format</a><wbr>(<a href="api/AuditEvent.html" title="class in com.puppycrawl.tools.checkstyle.api">AuditEvent</a> event)</code></div> |
| 105 | +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
163 | 106 | <div class="block">Formats an event message.</div>
|
164 |
| -</td> |
165 |
| -</tr> |
166 |
| -</table> |
167 |
| -</li> |
168 |
| -</ul> |
| 107 | +</div> |
| 108 | +</div> |
| 109 | +</div> |
| 110 | +</div> |
169 | 111 | </section>
|
170 | 112 | </li>
|
171 | 113 | </ul>
|
172 |
| -</div> |
173 |
| -<div class="details"> |
174 |
| -<ul class="blockList"> |
175 |
| -<li class="blockList"> |
| 114 | +</section> |
| 115 | +<section class="details"> |
| 116 | +<ul class="details-list"> |
176 | 117 | <!-- ============ METHOD DETAIL ========== -->
|
177 |
| -<section> |
178 |
| -<ul class="blockList"> |
179 |
| -<li class="blockList"><a id="method.detail"> |
180 |
| -<!-- --> |
181 |
| -</a> |
182 |
| -<h3>Method Detail</h3> |
183 |
| -<a id="format(com.puppycrawl.tools.checkstyle.api.AuditEvent)"> |
184 |
| -<!-- --> |
185 |
| -</a> |
186 |
| -<ul class="blockListLast"> |
187 |
| -<li class="blockList"> |
188 |
| -<h4>format</h4> |
189 |
| -<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> <a href="../../../../src-html/com/puppycrawl/tools/checkstyle/AuditEventFormatter.html#line.36">format</a>​(<a href="api/AuditEvent.html" title="class in com.puppycrawl.tools.checkstyle.api">AuditEvent</a> event)</pre> |
| 118 | +<li> |
| 119 | +<section class="method-details" id="method-detail"> |
| 120 | +<h2>Method Details</h2> |
| 121 | +<ul class="member-list"> |
| 122 | +<li> |
| 123 | +<section class="detail" id="format(com.puppycrawl.tools.checkstyle.api.AuditEvent)"> |
| 124 | +<h3>format</h3> |
| 125 | +<div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../src-html/com/puppycrawl/tools/checkstyle/AuditEventFormatter.html#line-36">format</a></span><wbr><span class="parameters">(<a href="api/AuditEvent.html" title="class in com.puppycrawl.tools.checkstyle.api">AuditEvent</a> event)</span></div> |
190 | 126 | <div class="block">Formats an event message.</div>
|
191 |
| -<dl> |
192 |
| -<dt><span class="paramLabel">Parameters:</span></dt> |
| 127 | +<dl class="notes"> |
| 128 | +<dt>Parameters:</dt> |
193 | 129 | <dd><code>event</code> - audit event.</dd>
|
194 |
| -<dt><span class="returnLabel">Returns:</span></dt> |
| 130 | +<dt>Returns:</dt> |
195 | 131 | <dd>string representation of event message.</dd>
|
196 | 132 | </dl>
|
197 |
| -</li> |
198 |
| -</ul> |
| 133 | +</section> |
199 | 134 | </li>
|
200 | 135 | </ul>
|
201 | 136 | </section>
|
202 | 137 | </li>
|
203 | 138 | </ul>
|
204 |
| -</div> |
205 |
| -</div> |
206 |
| -</main> |
| 139 | +</section> |
207 | 140 | <!-- ========= END OF CLASS DATA ========= -->
|
| 141 | +</main> |
208 | 142 | <footer role="contentinfo">
|
209 |
| -<nav role="navigation"> |
210 |
| -<!-- ======= START OF BOTTOM NAVBAR ====== --> |
211 |
| -<div class="bottomNav"><a id="navbar.bottom"> |
212 |
| -<!-- --> |
213 |
| -</a> |
214 |
| -<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
215 |
| -<a id="navbar.bottom.firstrow"> |
216 |
| -<!-- --> |
217 |
| -</a> |
218 |
| -<ul class="navList" title="Navigation"> |
219 |
| -<li><a href="../../../../index.html">Overview</a></li> |
220 |
| -<li><a href="package-summary.html">Package</a></li> |
221 |
| -<li class="navBarCell1Rev">Class</li> |
222 |
| -<li><a href="class-use/AuditEventFormatter.html">Use</a></li> |
223 |
| -<li><a href="package-tree.html">Tree</a></li> |
224 |
| -<li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
225 |
| -<li><a href="../../../../index-all.html">Index</a></li> |
226 |
| -<li><a href="../../../../help-doc.html">Help</a></li> |
227 |
| -</ul> |
228 |
| -</div> |
229 |
| -<div class="subNav"> |
230 |
| -<ul class="navList" id="allclasses_navbar_bottom"> |
231 |
| -<li><a href="../../../../allclasses.html">All Classes</a></li> |
232 |
| -</ul> |
233 |
| -<div> |
234 |
| -<script type="text/javascript"><!-- |
235 |
| - allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
236 |
| - if(window==top) { |
237 |
| - allClassesLink.style.display = "block"; |
238 |
| - } |
239 |
| - else { |
240 |
| - allClassesLink.style.display = "none"; |
241 |
| - } |
242 |
| - //--> |
243 |
| -</script> |
244 |
| -<noscript> |
245 |
| -<div>JavaScript is disabled on your browser.</div> |
246 |
| -</noscript> |
| 143 | +<hr> |
| 144 | +<p class="legal-copy"><small>Copyright © 2001–2025. All rights reserved.</small></p> |
| 145 | +</footer> |
247 | 146 | </div>
|
248 |
| -<div> |
249 |
| -<ul class="subNavList"> |
250 |
| -<li>Summary: </li> |
251 |
| -<li>Nested | </li> |
252 |
| -<li>Field | </li> |
253 |
| -<li>Constr | </li> |
254 |
| -<li><a href="#method.summary">Method</a></li> |
255 |
| -</ul> |
256 |
| -<ul class="subNavList"> |
257 |
| -<li>Detail: </li> |
258 |
| -<li>Field | </li> |
259 |
| -<li>Constr | </li> |
260 |
| -<li><a href="#method.detail">Method</a></li> |
261 |
| -</ul> |
262 | 147 | </div>
|
263 |
| -<a id="skip.navbar.bottom"> |
264 |
| -<!-- --> |
265 |
| -</a></div> |
266 |
| -<!-- ======== END OF BOTTOM NAVBAR ======= --> |
267 |
| -</nav> |
268 |
| -<p class="legalCopy"><small>Copyright © 2001–2024. All rights reserved.</small></p> |
269 |
| -</footer> |
270 | 148 | </body>
|
271 | 149 | </html>
|
0 commit comments