/usr/share/doc/libcommons-discovery-java/api/org/apache/commons/discovery/tools/SPInterface.html is in libcommons-discovery-java-doc 0.5-2ubuntu1.
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 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_24) on Thu Feb 09 16:27:47 UTC 2012 -->
<TITLE>
SPInterface (Commons Discovery (Version 0.5-SNAPSHOT))
</TITLE>
<META NAME="date" CONTENT="2012-02-09">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="SPInterface (Commons Discovery (Version 0.5-SNAPSHOT))";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../org/apache/commons/discovery/tools/Service.html" title="class in org.apache.commons.discovery.tools"><B>PREV CLASS</B></A>
NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?org/apache/commons/discovery/tools/SPInterface.html" target="_top"><B>FRAMES</B></A>
<A HREF="SPInterface.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
org.apache.commons.discovery.tools</FONT>
<BR>
Class SPInterface<T></H2>
<PRE>
java.lang.Object
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.commons.discovery.tools.SPInterface<T></B>
</PRE>
<DL>
<DT><DT><B>Type Parameters:</B><DD><CODE>T</CODE> - The SPI type</DL>
<HR>
<DL>
<DT><PRE>public class <B>SPInterface<T></B><DT>extends java.lang.Object</DL>
</PRE>
<P>
Represents a Service Programming Interface (spi).
- SPI's name
- SPI's (provider) class
- SPI's (alternate) override property name
In addition, while there are many cases where this is NOT
usefull, for those in which it is:
- expected constructor argument types and parameters values.
<P>
<P>
<HR>
<P>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../../org/apache/commons/discovery/tools/SPInterface.html#SPInterface(java.lang.Class)">SPInterface</A></B>(java.lang.Class<<A HREF="../../../../../org/apache/commons/discovery/tools/SPInterface.html" title="type parameter in SPInterface">T</A>> provider)</CODE>
<BR>
Construct object representing Class <code>provider</code>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../../org/apache/commons/discovery/tools/SPInterface.html#SPInterface(java.lang.Class, java.lang.Class[], java.lang.Object[])">SPInterface</A></B>(java.lang.Class<<A HREF="../../../../../org/apache/commons/discovery/tools/SPInterface.html" title="type parameter in SPInterface">T</A>> provider,
java.lang.Class<?>[] constructorParamClasses,
java.lang.Object[] constructorParams)</CODE>
<BR>
Construct object representing Class <code>provider</code>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../../org/apache/commons/discovery/tools/SPInterface.html#SPInterface(java.lang.Class, java.lang.String)">SPInterface</A></B>(java.lang.Class<<A HREF="../../../../../org/apache/commons/discovery/tools/SPInterface.html" title="type parameter in SPInterface">T</A>> spi,
java.lang.String propertyName)</CODE>
<BR>
Construct object representing Class <code>provider</code>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../../org/apache/commons/discovery/tools/SPInterface.html#SPInterface(java.lang.Class, java.lang.String, java.lang.Class[], java.lang.Object[])">SPInterface</A></B>(java.lang.Class<<A HREF="../../../../../org/apache/commons/discovery/tools/SPInterface.html" title="type parameter in SPInterface">T</A>> spi,
java.lang.String propertyName,
java.lang.Class<?>[] constructorParamClasses,
java.lang.Object[] constructorParams)</CODE>
<BR>
Construct object representing Class <code>provider</code>.</TD>
</TR>
</TABLE>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/commons/discovery/tools/SPInterface.html#getPropertyName()">getPropertyName</A></B>()</CODE>
<BR>
Returns the property name to be used for finding
the name of the SPI implementation class.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.Class<<A HREF="../../../../../org/apache/commons/discovery/tools/SPInterface.html" title="type parameter in SPInterface">T</A>></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/commons/discovery/tools/SPInterface.html#getSPClass()">getSPClass</A></B>()</CODE>
<BR>
Returns the SPI class.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/commons/discovery/tools/SPInterface.html#getSPName()">getSPName</A></B>()</CODE>
<BR>
Returns the SPI class name.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">
<TR ALIGN="right" VALIGN="">
<TD NOWRAP><FONT SIZE="-1">
<CODE><S extends <A HREF="../../../../../org/apache/commons/discovery/tools/SPInterface.html" title="type parameter in SPInterface">T</A>>
<BR>
S</CODE></FONT></TD>
</TR>
</TABLE>
</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/commons/discovery/tools/SPInterface.html#newInstance(java.lang.Class)">newInstance</A></B>(java.lang.Class<S> impl)</CODE>
<BR>
Creates a new instance of the given SPI class.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">
<TR ALIGN="right" VALIGN="">
<TD NOWRAP><FONT SIZE="-1">
<CODE><T> <A HREF="../../../../../org/apache/commons/discovery/tools/SPInterface.html" title="class in org.apache.commons.discovery.tools">SPInterface</A><T></CODE></FONT></TD>
</TR>
</TABLE>
</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/commons/discovery/tools/SPInterface.html#newSPInterface(java.lang.Class)">newSPInterface</A></B>(java.lang.Class<T> provider)</CODE>
<BR>
Construct object representing Class <code>provider</code>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">
<TR ALIGN="right" VALIGN="">
<TD NOWRAP><FONT SIZE="-1">
<CODE><T> <A HREF="../../../../../org/apache/commons/discovery/tools/SPInterface.html" title="class in org.apache.commons.discovery.tools">SPInterface</A><T></CODE></FONT></TD>
</TR>
</TABLE>
</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/commons/discovery/tools/SPInterface.html#newSPInterface(java.lang.Class, java.lang.Class[], java.lang.Object[])">newSPInterface</A></B>(java.lang.Class<T> provider,
java.lang.Class<?>[] constructorParamClasses,
java.lang.Object[] constructorParams)</CODE>
<BR>
Construct object representing Class <code>provider</code>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">
<TR ALIGN="right" VALIGN="">
<TD NOWRAP><FONT SIZE="-1">
<CODE><T> <A HREF="../../../../../org/apache/commons/discovery/tools/SPInterface.html" title="class in org.apache.commons.discovery.tools">SPInterface</A><T></CODE></FONT></TD>
</TR>
</TABLE>
</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/commons/discovery/tools/SPInterface.html#newSPInterface(java.lang.Class, java.lang.String)">newSPInterface</A></B>(java.lang.Class<T> provider,
java.lang.String propertyName)</CODE>
<BR>
Construct object representing Class <code>provider</code>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">
<TR ALIGN="right" VALIGN="">
<TD NOWRAP><FONT SIZE="-1">
<CODE><T> <A HREF="../../../../../org/apache/commons/discovery/tools/SPInterface.html" title="class in org.apache.commons.discovery.tools">SPInterface</A><T></CODE></FONT></TD>
</TR>
</TABLE>
</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/commons/discovery/tools/SPInterface.html#newSPInterface(java.lang.Class, java.lang.String, java.lang.Class[], java.lang.Object[])">newSPInterface</A></B>(java.lang.Class<T> provider,
java.lang.String propertyName,
java.lang.Class<?>[] constructorParamClasses,
java.lang.Object[] constructorParams)</CODE>
<BR>
Construct object representing Class <code>provider</code>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">
<TR ALIGN="right" VALIGN="">
<TD NOWRAP><FONT SIZE="-1">
<CODE><S extends <A HREF="../../../../../org/apache/commons/discovery/tools/SPInterface.html" title="type parameter in SPInterface">T</A>>
<BR>
void</CODE></FONT></TD>
</TR>
</TABLE>
</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/commons/discovery/tools/SPInterface.html#verifyAncestory(java.lang.Class)">verifyAncestory</A></B>(java.lang.Class<S> impl)</CODE>
<BR>
Verifies the given SPI implementation is a SPI specialization.</TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
<P>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="SPInterface(java.lang.Class)"><!-- --></A><H3>
SPInterface</H3>
<PRE>
public <B>SPInterface</B>(java.lang.Class<<A HREF="../../../../../org/apache/commons/discovery/tools/SPInterface.html" title="type parameter in SPInterface">T</A>> provider)</PRE>
<DL>
<DD>Construct object representing Class <code>provider</code>.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>provider</CODE> - The SPI class</DL>
</DL>
<HR>
<A NAME="SPInterface(java.lang.Class, java.lang.String)"><!-- --></A><H3>
SPInterface</H3>
<PRE>
public <B>SPInterface</B>(java.lang.Class<<A HREF="../../../../../org/apache/commons/discovery/tools/SPInterface.html" title="type parameter in SPInterface">T</A>> spi,
java.lang.String propertyName)</PRE>
<DL>
<DD>Construct object representing Class <code>provider</code>.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>spi</CODE> - The SPI class<DD><CODE>propertyName</CODE> - when looking for the name of a class implementing
the provider class, a discovery strategy may involve looking for
(system or other) properties having either the name of the class
(provider) or the <code>propertyName</code>.</DL>
</DL>
<HR>
<A NAME="SPInterface(java.lang.Class, java.lang.Class[], java.lang.Object[])"><!-- --></A><H3>
SPInterface</H3>
<PRE>
public <B>SPInterface</B>(java.lang.Class<<A HREF="../../../../../org/apache/commons/discovery/tools/SPInterface.html" title="type parameter in SPInterface">T</A>> provider,
java.lang.Class<?>[] constructorParamClasses,
java.lang.Object[] constructorParams)</PRE>
<DL>
<DD>Construct object representing Class <code>provider</code>.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>provider</CODE> - The SPI class<DD><CODE>constructorParamClasses</CODE> - classes representing the
constructor argument types.<DD><CODE>constructorParams</CODE> - objects representing the
constructor arguments.</DL>
</DL>
<HR>
<A NAME="SPInterface(java.lang.Class, java.lang.String, java.lang.Class[], java.lang.Object[])"><!-- --></A><H3>
SPInterface</H3>
<PRE>
public <B>SPInterface</B>(java.lang.Class<<A HREF="../../../../../org/apache/commons/discovery/tools/SPInterface.html" title="type parameter in SPInterface">T</A>> spi,
java.lang.String propertyName,
java.lang.Class<?>[] constructorParamClasses,
java.lang.Object[] constructorParams)</PRE>
<DL>
<DD>Construct object representing Class <code>provider</code>.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>spi</CODE> - The SPI class<DD><CODE>propertyName</CODE> - when looking for the name of a class implementing
the provider class, a discovery strategy may involve looking for
(system or other) properties having either the name of the class
(provider) or the <code>propertyName</code>.<DD><CODE>constructorParamClasses</CODE> - classes representing the
constructor argument types.<DD><CODE>constructorParams</CODE> - objects representing the
constructor arguments.</DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="newSPInterface(java.lang.Class)"><!-- --></A><H3>
newSPInterface</H3>
<PRE>
public static <T> <A HREF="../../../../../org/apache/commons/discovery/tools/SPInterface.html" title="class in org.apache.commons.discovery.tools">SPInterface</A><T> <B>newSPInterface</B>(java.lang.Class<T> provider)</PRE>
<DL>
<DD>Construct object representing Class <code>provider</code>.
<P>
<DD><DL>
<DT><B>Type Parameters:</B><DD><CODE>T</CODE> - The SPI type<DT><B>Parameters:</B><DD><CODE>provider</CODE> - The SPI class
<DT><B>Returns:</B><DD>A new object representing Class <code>provider</code><DT><B>Since:</B></DT>
<DD>0.5</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="newSPInterface(java.lang.Class, java.lang.String)"><!-- --></A><H3>
newSPInterface</H3>
<PRE>
public static <T> <A HREF="../../../../../org/apache/commons/discovery/tools/SPInterface.html" title="class in org.apache.commons.discovery.tools">SPInterface</A><T> <B>newSPInterface</B>(java.lang.Class<T> provider,
java.lang.String propertyName)</PRE>
<DL>
<DD>Construct object representing Class <code>provider</code>.
<P>
<DD><DL>
<DT><B>Type Parameters:</B><DD><CODE>T</CODE> - The SPI type<DT><B>Parameters:</B><DD><CODE>provider</CODE> - The SPI class<DD><CODE>propertyName</CODE> - when looking for the name of a class implementing
the provider class, a discovery strategy may involve looking for
(system or other) properties having either the name of the class
(provider) or the <code>propertyName</code>.
<DT><B>Returns:</B><DD>A new object representing Class <code>provider</code><DT><B>Since:</B></DT>
<DD>0.5</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="newSPInterface(java.lang.Class, java.lang.Class[], java.lang.Object[])"><!-- --></A><H3>
newSPInterface</H3>
<PRE>
public static <T> <A HREF="../../../../../org/apache/commons/discovery/tools/SPInterface.html" title="class in org.apache.commons.discovery.tools">SPInterface</A><T> <B>newSPInterface</B>(java.lang.Class<T> provider,
java.lang.Class<?>[] constructorParamClasses,
java.lang.Object[] constructorParams)</PRE>
<DL>
<DD>Construct object representing Class <code>provider</code>.
<P>
<DD><DL>
<DT><B>Type Parameters:</B><DD><CODE>T</CODE> - The SPI type<DT><B>Parameters:</B><DD><CODE>provider</CODE> - The SPI class<DD><CODE>constructorParamClasses</CODE> - classes representing the
constructor argument types<DD><CODE>constructorParams</CODE> - objects representing the
constructor arguments
<DT><B>Returns:</B><DD>A new object representing Class <code>provider</code><DT><B>Since:</B></DT>
<DD>0.5</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="newSPInterface(java.lang.Class, java.lang.String, java.lang.Class[], java.lang.Object[])"><!-- --></A><H3>
newSPInterface</H3>
<PRE>
public static <T> <A HREF="../../../../../org/apache/commons/discovery/tools/SPInterface.html" title="class in org.apache.commons.discovery.tools">SPInterface</A><T> <B>newSPInterface</B>(java.lang.Class<T> provider,
java.lang.String propertyName,
java.lang.Class<?>[] constructorParamClasses,
java.lang.Object[] constructorParams)</PRE>
<DL>
<DD>Construct object representing Class <code>provider</code>.
<P>
<DD><DL>
<DT><B>Type Parameters:</B><DD><CODE>T</CODE> - The SPI type<DT><B>Parameters:</B><DD><CODE>provider</CODE> - The SPI class<DD><CODE>propertyName</CODE> - when looking for the name of a class implementing
the provider class, a discovery strategy may involve looking for
(system or other) properties having either the name of the class
(provider) or the <code>propertyName</code>.<DD><CODE>constructorParamClasses</CODE> - classes representing the
constructor argument types<DD><CODE>constructorParams</CODE> - objects representing the
constructor arguments
<DT><B>Returns:</B><DD>A new object representing Class <code>provider</code><DT><B>Since:</B></DT>
<DD>0.5</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="getSPName()"><!-- --></A><H3>
getSPName</H3>
<PRE>
public java.lang.String <B>getSPName</B>()</PRE>
<DL>
<DD>Returns the SPI class name.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>The SPI class name</DL>
</DD>
</DL>
<HR>
<A NAME="getSPClass()"><!-- --></A><H3>
getSPClass</H3>
<PRE>
public java.lang.Class<<A HREF="../../../../../org/apache/commons/discovery/tools/SPInterface.html" title="type parameter in SPInterface">T</A>> <B>getSPClass</B>()</PRE>
<DL>
<DD>Returns the SPI class.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>The SPI class</DL>
</DD>
</DL>
<HR>
<A NAME="getPropertyName()"><!-- --></A><H3>
getPropertyName</H3>
<PRE>
public java.lang.String <B>getPropertyName</B>()</PRE>
<DL>
<DD>Returns the property name to be used for finding
the name of the SPI implementation class.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>The property name to be used for finding
the name of the SPI implementation class</DL>
</DD>
</DL>
<HR>
<A NAME="newInstance(java.lang.Class)"><!-- --></A><H3>
newInstance</H3>
<PRE>
public <S extends <A HREF="../../../../../org/apache/commons/discovery/tools/SPInterface.html" title="type parameter in SPInterface">T</A>> S <B>newInstance</B>(java.lang.Class<S> impl)
throws <A HREF="../../../../../org/apache/commons/discovery/DiscoveryException.html" title="class in org.apache.commons.discovery">DiscoveryException</A>,
java.lang.InstantiationException,
java.lang.IllegalAccessException,
java.lang.NoSuchMethodException,
java.lang.reflect.InvocationTargetException</PRE>
<DL>
<DD>Creates a new instance of the given SPI class.
<P>
<DD><DL>
<DT><B>Type Parameters:</B><DD><CODE>S</CODE> - Any type extends T<DT><B>Parameters:</B><DD><CODE>impl</CODE> - The SPI class has to be instantiated
<DT><B>Returns:</B><DD>A new instance of the given SPI class
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/apache/commons/discovery/DiscoveryException.html" title="class in org.apache.commons.discovery">DiscoveryException</A></CODE> - if the class implementing
the SPI cannot be found, cannot be loaded and
instantiated, or if the resulting class does not implement
(or extend) the SPI
<DD><CODE>java.lang.InstantiationException</CODE> - see <CODE>Class.newInstance()</CODE>
<DD><CODE>java.lang.IllegalAccessException</CODE> - see <CODE>Class.newInstance()</CODE>
<DD><CODE>java.lang.NoSuchMethodException</CODE> - see <CODE>Class.newInstance()</CODE>
<DD><CODE>java.lang.reflect.InvocationTargetException</CODE> - see <CODE>Class.newInstance()</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="verifyAncestory(java.lang.Class)"><!-- --></A><H3>
verifyAncestory</H3>
<PRE>
public <S extends <A HREF="../../../../../org/apache/commons/discovery/tools/SPInterface.html" title="type parameter in SPInterface">T</A>> void <B>verifyAncestory</B>(java.lang.Class<S> impl)</PRE>
<DL>
<DD>Verifies the given SPI implementation is a SPI specialization.
<P>
<DD><DL>
<DT><B>Type Parameters:</B><DD><CODE>S</CODE> - Any type extends T<DT><B>Parameters:</B><DD><CODE>impl</CODE> - The SPI instantance</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../org/apache/commons/discovery/tools/Service.html" title="class in org.apache.commons.discovery.tools"><B>PREV CLASS</B></A>
NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?org/apache/commons/discovery/tools/SPInterface.html" target="_top"><B>FRAMES</B></A>
<A HREF="SPInterface.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
Copyright (c) 2002 - Apache Software Foundation
</BODY>
</HTML>
|