/usr/share/doc/libargs4j-java/api/org/kohsuke/args4j/spi/Setter.html is in libargs4j-java-doc 2.33-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html>
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Setter (args4j parent 2.33 API)</title>
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Setter (args4j parent 2.33 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<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/Setter.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-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/kohsuke/args4j/spi/RestOfArgumentsHandler.html" title="class in org.kohsuke.args4j.spi"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../org/kohsuke/args4j/spi/Setters.html" title="class in org.kohsuke.args4j.spi"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/kohsuke/args4j/spi/Setter.html" target="_top">Frames</a></li>
<li><a href="Setter.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">org.kohsuke.args4j.spi</div>
<h2 title="Interface Setter" class="title">Interface Setter<T></h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../org/kohsuke/args4j/spi/FieldSetter.html" title="class in org.kohsuke.args4j.spi">FieldSetter</a>, <a href="../../../../org/kohsuke/args4j/spi/MethodSetter.html" title="class in org.kohsuke.args4j.spi">MethodSetter</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">Setter<T></span></pre>
<div class="block">Abstraction of the value setter.
<p>
This abstracts away the difference between a field and a setter method,
which object we are setting the value to,
and/or how we handle collection fields differently.</div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Kohsuke Kawaguchi</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/kohsuke/args4j/spi/Getter.html" title="interface in org.kohsuke.args4j.spi"><code>Getter</code></a></dd>
</dl>
</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<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>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/kohsuke/args4j/spi/Setter.html#addValue-T-">addValue</a></span>(<a href="../../../../org/kohsuke/args4j/spi/Setter.html" title="type parameter in Setter">T</a> value)</code>
<div class="block">Adds/sets a value to the property of the option bean.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/reflect/AnnotatedElement.html?is-external=true" title="class or interface in java.lang.reflect">AnnotatedElement</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/kohsuke/args4j/spi/Setter.html#asAnnotatedElement--">asAnnotatedElement</a></span>()</code>
<div class="block">Returns the <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/reflect/AnnotatedElement.html?is-external=true" title="class or interface in java.lang.reflect"><code>AnnotatedElement</code></a> by which you can access annotations written on this setter.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../org/kohsuke/args4j/spi/FieldSetter.html" title="class in org.kohsuke.args4j.spi">FieldSetter</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/kohsuke/args4j/spi/Setter.html#asFieldSetter--">asFieldSetter</a></span>()</code>
<div class="block">If this setter encapsulates a field, return the direct access to that field as
<a href="../../../../org/kohsuke/args4j/spi/FieldSetter.html" title="class in org.kohsuke.args4j.spi"><code>FieldSetter</code></a>.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><<a href="../../../../org/kohsuke/args4j/spi/Setter.html" title="type parameter in Setter">T</a>></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/kohsuke/args4j/spi/Setter.html#getType--">getType</a></span>()</code>
<div class="block">Gets the type of the underlying method/field.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/kohsuke/args4j/spi/Setter.html#isMultiValued--">isMultiValued</a></span>()</code>
<div class="block">Whether this setter is intrinsically multi-valued.</div>
</td>
</tr>
</table>
</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="addValue-java.lang.Object-">
<!-- -->
</a><a name="addValue-T-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addValue</h4>
<pre>void addValue(<a href="../../../../org/kohsuke/args4j/spi/Setter.html" title="type parameter in Setter">T</a> value)
throws <a href="../../../../org/kohsuke/args4j/CmdLineException.html" title="class in org.kohsuke.args4j">CmdLineException</a></pre>
<div class="block">Adds/sets a value to the property of the option bean.
<p>
A <a href="../../../../org/kohsuke/args4j/spi/Setter.html" title="interface in org.kohsuke.args4j.spi"><code>Setter</code></a> object has an implicit knowledge about the property it's setting,
and the instance of the option bean.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/kohsuke/args4j/CmdLineException.html" title="class in org.kohsuke.args4j">CmdLineException</a></code></dd>
</dl>
</li>
</ul>
<a name="getType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getType</h4>
<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><<a href="../../../../org/kohsuke/args4j/spi/Setter.html" title="type parameter in Setter">T</a>> getType()</pre>
<div class="block">Gets the type of the underlying method/field.</div>
</li>
</ul>
<a name="isMultiValued--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isMultiValued</h4>
<pre>boolean isMultiValued()</pre>
<div class="block">Whether this setter is intrinsically multi-valued.
<p>
When parsing arguments (instead of options), intrinsically multi-valued setters consume
all the remaining arguments. So, if the setter can store multiple values,
this method should return <code>true</code>.
<p>
This characteristics of a setter doesn't affect option parsing at all; any options can be
specified multiple times. In many cases, this is a no-op--but when your shell script expands
multiple environment variables (each of which may contain options), tolerating such
redundant options can be useful.</div>
</li>
</ul>
<a name="asFieldSetter--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>asFieldSetter</h4>
<pre><a href="../../../../org/kohsuke/args4j/spi/FieldSetter.html" title="class in org.kohsuke.args4j.spi">FieldSetter</a> asFieldSetter()</pre>
<div class="block">If this setter encapsulates a field, return the direct access to that field as
<a href="../../../../org/kohsuke/args4j/spi/FieldSetter.html" title="class in org.kohsuke.args4j.spi"><code>FieldSetter</code></a>. This method serves two purposes:
<ol>
<li>This lets <a href="../../../../org/kohsuke/args4j/spi/OptionHandler.html" title="class in org.kohsuke.args4j.spi"><code>OptionHandler</code></a>s bypass the collection/array handling of fields.
This is useful if you're defining an option handler that produces array or collection
from a single argument.</li>
<li>The other is to retrieve the current value of the field (via <a href="../../../../org/kohsuke/args4j/spi/FieldSetter.html#getValueList--"><code>FieldSetter.getValueList()</code></a>).</li>
</ol></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>null</code> if this setter wraps a method.</dd>
</dl>
</li>
</ul>
<a name="asAnnotatedElement--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>asAnnotatedElement</h4>
<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/reflect/AnnotatedElement.html?is-external=true" title="class or interface in java.lang.reflect">AnnotatedElement</a> asAnnotatedElement()</pre>
<div class="block">Returns the <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/reflect/AnnotatedElement.html?is-external=true" title="class or interface in java.lang.reflect"><code>AnnotatedElement</code></a> by which you can access annotations written on this setter.
This is the same <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/reflect/AnnotatedElement.html?is-external=true" title="class or interface in java.lang.reflect"><code>AnnotatedElement</code></a> that had <a href="../../../../org/kohsuke/args4j/Option.html" title="annotation in org.kohsuke.args4j"><code>Option</code></a>/<a href="../../../../org/kohsuke/args4j/Argument.html" title="annotation in org.kohsuke.args4j"><code>Argument</code></a>.
<p>
This enables <a href="../../../../org/kohsuke/args4j/spi/OptionHandler.html" title="class in org.kohsuke.args4j.spi"><code>OptionHandler</code></a> to further tweak its behavior based on additional annotations.</div>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<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/Setter.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-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/kohsuke/args4j/spi/RestOfArgumentsHandler.html" title="class in org.kohsuke.args4j.spi"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../org/kohsuke/args4j/spi/Setters.html" title="class in org.kohsuke.args4j.spi"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/kohsuke/args4j/spi/Setter.html" target="_top">Frames</a></li>
<li><a href="Setter.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 ======= -->
<p class="legalCopy"><small>Copyright © 2003–2016 <a href="http://www.kohsuke.org/">Kohsuke Kawaguchi</a>. All rights reserved.</small></p>
</body>
</html>
|