<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <!-- NewPage --> <html lang="fi"> <head> <!-- Generated by javadoc (1.8.0_201) on Mon Aug 05 12:12:05 EEST 2019 --> <title>CapabilityService (api 4.9.1 API)</title> <meta name="date" content="2019-08-05"> <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="CapabilityService (api 4.9.1 API)"; } } catch(err) { } //--> var methods = {"i0":17,"i1":18,"i2":6}; var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default 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="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>Prev Class</li> <li><a href="../../../../com/djrapitops/plan/capability/CapabilityService.CapabilityServiceHolder.html" title="class in com.djrapitops.plan.capability"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?com/djrapitops/plan/capability/CapabilityService.html" target="_top">Frames</a></li> <li><a href="CapabilityService.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>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.djrapitops.plan.capability</div> <h2 title="Interface CapabilityService" class="title">Interface CapabilityService</h2> </div> <div class="contentContainer"> <div class="description"> <ul class="blockList"> <li class="blockList"> <hr> <br> <pre>public interface <span class="typeNameLabel">CapabilityService</span></pre> <div class="block">Service for figuring out provided API capabilities. <p> <a href="../../../../com/djrapitops/plan/capability/CapabilityService.html#registerEnableListener-java.util.function.Consumer-"><code>registerEnableListener(Consumer)</code></a> to be notified of Plan reloads <a href="../../../../com/djrapitops/plan/capability/CapabilityService.html#hasCapability-java.lang.String-"><code>hasCapability(String)</code></a> to check if a capability is available. <p> See <code>Capability</code> for list of capabilities provided by the current version.</div> </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="memberSummary" 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">Interface and Description</th> </tr> <tr class="altColor"> <td class="colFirst"><code>static class </code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/djrapitops/plan/capability/CapabilityService.CapabilityServiceHolder.html" title="class in com.djrapitops.plan.capability">CapabilityService.CapabilityServiceHolder</a></span></code> </td> </tr> </table> </li> </ul> <!-- ========== 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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default 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>static <a href="../../../../com/djrapitops/plan/capability/CapabilityService.html" title="interface in com.djrapitops.plan.capability">CapabilityService</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/djrapitops/plan/capability/CapabilityService.html#getInstance--">getInstance</a></span>()</code> <div class="block">Obtain instance of CapabilityService.</div> </td> </tr> <tr id="i1" class="rowColor"> <td class="colFirst"><code>default boolean</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/djrapitops/plan/capability/CapabilityService.html#hasCapability-java.lang.String-">hasCapability</a></span>(java.lang.String capabilityName)</code> <div class="block">Check if the API on the current version provides a capability.</div> </td> </tr> <tr id="i2" class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/djrapitops/plan/capability/CapabilityService.html#registerEnableListener-java.util.function.Consumer-">registerEnableListener</a></span>(java.util.function.Consumer<java.lang.Boolean> isEnabledListener)</code> <div class="block">Register a method to be called when Plan reloads.</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="getInstance--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getInstance</h4> <pre>static <a href="../../../../com/djrapitops/plan/capability/CapabilityService.html" title="interface in com.djrapitops.plan.capability">CapabilityService</a> getInstance()</pre> <div class="block">Obtain instance of CapabilityService.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>CapabilityService implementation.</dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code>java.lang.NoClassDefFoundError</code> - If Plan is not installed and this class can not be found or if older Plan version is installed.</dd> <dd><code>java.lang.IllegalStateException</code> - If Plan is installed, but not enabled.</dd> </dl> </li> </ul> <a name="registerEnableListener-java.util.function.Consumer-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>registerEnableListener</h4> <pre>void registerEnableListener(java.util.function.Consumer<java.lang.Boolean> isEnabledListener)</pre> <div class="block">Register a method to be called when Plan reloads.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>isEnabledListener</code> - The boolean given to the method tells if Plan has enabled successfully.</dd> </dl> </li> </ul> <a name="hasCapability-java.lang.String-"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>hasCapability</h4> <pre>default boolean hasCapability(java.lang.String capabilityName)</pre> <div class="block">Check if the API on the current version provides a capability.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>capabilityName</code> - Name of a capability</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>true if the capability is available.</dd> <dt><span class="seeLabel">See Also:</span></dt> <dd><code>for different capabilityNames.</code></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> <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="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>Prev Class</li> <li><a href="../../../../com/djrapitops/plan/capability/CapabilityService.CapabilityServiceHolder.html" title="class in com.djrapitops.plan.capability"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?com/djrapitops/plan/capability/CapabilityService.html" target="_top">Frames</a></li> <li><a href="CapabilityService.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>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>