2021-03-10 09:12:21 +01:00
<!DOCTYPE HTML>
< html lang = "en" >
2019-08-05 11:13:19 +02:00
< head >
2022-06-10 15:30:56 +02:00
<!-- Generated by javadoc (17) -->
2022-06-18 11:05:58 +02:00
< title > CapabilityService (Plan 5.5-SNAPSHOT API)< / title >
2021-07-24 13:27:37 +02:00
< meta name = "viewport" content = "width=device-width, initial-scale=1" >
2021-03-10 09:12:21 +01:00
< meta http-equiv = "Content-Type" content = "text/html; charset=utf-8" >
2021-07-24 13:27:37 +02:00
< meta name = "description" content = "declaration: package: com.djrapitops.plan.capability, interface: CapabilityService" >
< meta name = "generator" content = "javadoc/ClassWriterImpl" >
2019-08-05 11:13:19 +02:00
< link rel = "stylesheet" type = "text/css" href = "../../../../stylesheet.css" title = "Style" >
2021-07-24 13:27:37 +02:00
< link rel = "stylesheet" type = "text/css" href = "../../../../script-dir/jquery-ui.min.css" title = "Style" >
< link rel = "stylesheet" type = "text/css" href = "../../../../jquery-ui.overrides.css" title = "Style" >
2019-08-05 11:13:19 +02:00
< script type = "text/javascript" src = "../../../../script.js" > < / script >
2021-07-24 13:27:37 +02:00
< script type = "text/javascript" src = "../../../../script-dir/jquery-3.5.1.min.js" > < / script >
< script type = "text/javascript" src = "../../../../script-dir/jquery-ui.min.js" > < / script >
2019-08-05 11:13:19 +02:00
< / head >
2021-07-24 13:27:37 +02:00
< body class = "class-declaration-page" >
< script type = "text/javascript" > v a r e v e n R o w C o l o r = " e v e n - r o w - c o l o r " ;
var oddRowColor = "odd-row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
2021-03-10 09:12:21 +01:00
var pathtoroot = "../../../../";
loadScripts(document, 'script');< / script >
2019-08-05 11:13:19 +02:00
< noscript >
< div > JavaScript is disabled on your browser.< / div >
< / noscript >
2021-07-24 13:27:37 +02:00
< div class = "flex-box" >
< header role = "banner" class = "flex-header" >
2021-03-10 09:12:21 +01:00
< nav role = "navigation" >
2019-08-05 11:13:19 +02:00
<!-- ========= START OF TOP NAVBAR ======= -->
2022-06-10 15:30:56 +02:00
< div class = "top-nav" id = "navbar-top" >
< div class = "skip-nav" > < a href = "#skip-navbar-top" title = "Skip navigation links" > Skip navigation links< / a > < / div >
< ul id = "navbar-top-firstrow" class = "nav-list" title = "Navigation" >
2021-03-10 09:12:21 +01:00
< li > < a href = "../../../../index.html" > Overview< / a > < / li >
2019-08-05 11:13:19 +02:00
< li > < a href = "package-summary.html" > Package< / a > < / li >
2021-07-24 13:27:37 +02:00
< li class = "nav-bar-cell1-rev" > Class< / li >
2019-08-05 11:13:19 +02:00
< 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 >
2022-06-10 15:30:56 +02:00
< li > < a href = "../../../../help-doc.html#class" > Help< / a > < / li >
2019-08-05 11:13:19 +02:00
< / ul >
< / div >
2021-07-24 13:27:37 +02:00
< div class = "sub-nav" >
2019-08-05 11:13:19 +02:00
< div >
2021-07-24 13:27:37 +02:00
< ul class = "sub-nav-list" >
2019-08-05 11:13:19 +02:00
< li > Summary: < / li >
2022-06-10 15:30:56 +02:00
< li > < a href = "#nested-class-summary" > Nested< / a > | < / li >
2019-08-05 11:13:19 +02:00
< li > Field | < / li >
< li > Constr | < / li >
2022-06-10 15:30:56 +02:00
< li > < a href = "#method-summary" > Method< / a > < / li >
2019-08-05 11:13:19 +02:00
< / ul >
2021-07-24 13:27:37 +02:00
< ul class = "sub-nav-list" >
2019-08-05 11:13:19 +02:00
< li > Detail: < / li >
< li > Field | < / li >
< li > Constr | < / li >
2022-06-10 15:30:56 +02:00
< li > < a href = "#method-detail" > Method< / a > < / li >
2019-08-05 11:13:19 +02:00
< / ul >
< / div >
2022-06-10 15:30:56 +02:00
< div class = "nav-list-search" > < label for = "search-input" > SEARCH:< / label >
< input type = "text" id = "search-input" value = "search" disabled = "disabled" >
< input type = "reset" id = "reset-button" value = "reset" disabled = "disabled" >
2021-07-24 13:27:37 +02:00
< / div >
2021-03-10 09:12:21 +01:00
< / div >
2021-07-24 13:27:37 +02:00
<!-- ========= END OF TOP NAVBAR ========= -->
2022-06-10 15:30:56 +02:00
< span class = "skip-nav" id = "skip-navbar-top" > < / span > < / nav >
2021-03-10 09:12:21 +01:00
< / header >
2021-07-24 13:27:37 +02:00
< div class = "flex-content" >
2021-03-10 09:12:21 +01:00
< main role = "main" >
2021-07-24 13:27:37 +02:00
<!-- ======== START OF CLASS DATA ======== -->
2019-08-05 11:13:19 +02:00
< div class = "header" >
2021-07-24 13:27:37 +02:00
< div class = "sub-title" > < span class = "package-label-in-type" > Package< / span > < a href = "package-summary.html" > com.djrapitops.plan.capability< / a > < / div >
< h1 title = "Interface CapabilityService" class = "title" > Interface CapabilityService< / h1 >
2019-08-05 11:13:19 +02:00
< / div >
2022-06-10 15:30:56 +02:00
< section class = "class-description" id = "class-description" >
2021-07-24 13:27:37 +02:00
< dl class = "notes" >
2019-08-05 11:13:19 +02:00
< dt > All Known Implementing Classes:< / dt >
2021-03-10 09:12:21 +01:00
< dd > < code > < a href = "CapabilitySvc.html" title = "class in com.djrapitops.plan.capability" > CapabilitySvc< / a > < / code > < / dd >
2019-08-05 11:13:19 +02:00
< / dl >
< hr >
2021-07-24 13:27:37 +02:00
< div class = "type-signature" > < span class = "modifiers" > public interface < / span > < span class = "element-name type-name-label" > CapabilityService< / span > < / div >
2019-08-05 11:13:19 +02:00
< div class = "block" > Service for figuring out provided API capabilities.
< p >
2021-03-10 09:12:21 +01:00
< a href = "#registerEnableListener(java.util.function.Consumer)" > < code > registerEnableListener(Consumer)< / code > < / a > to be notified of Plan reloads
< a href = "#hasCapability(java.lang.String)" > < code > hasCapability(String)< / code > < / a > to check if a capability is available.
2019-08-05 11:13:19 +02:00
< p >
See < code > Capability< / code > for list of capabilities provided by the current version.< / div >
2021-07-24 13:27:37 +02:00
< / section >
< section class = "summary" >
< ul class = "summary-list" >
2019-08-05 11:13:19 +02:00
<!-- ======== NESTED CLASS SUMMARY ======== -->
2021-07-24 13:27:37 +02:00
< li >
2022-06-10 15:30:56 +02:00
< section class = "nested-class-summary" id = "nested-class-summary" >
2021-07-24 13:27:37 +02:00
< h2 > Nested Class Summary< / h2 >
< div class = "caption" > < span > Nested Classes< / span > < / div >
< div class = "summary-table three-column-summary" >
< div class = "table-header col-first" > Modifier and Type< / div >
< div class = "table-header col-second" > Interface< / div >
< div class = "table-header col-last" > Description< / div >
< div class = "col-first even-row-color" > < code > static class < / code > < / div >
2022-06-10 15:30:56 +02:00
< div class = "col-second even-row-color" > < code > < a href = "CapabilityService.ListHolder.html" class = "type-name-link" title = "class in com.djrapitops.plan.capability" > CapabilityService.ListHolder< / a > < / code > < / div >
2021-07-24 13:27:37 +02:00
< div class = "col-last even-row-color" > < / div >
< / div >
2021-03-10 09:12:21 +01:00
< / section >
2021-07-24 13:27:37 +02:00
< / li >
2019-08-05 11:13:19 +02:00
<!-- ========== METHOD SUMMARY =========== -->
2021-07-24 13:27:37 +02:00
< li >
2022-06-10 15:30:56 +02:00
< section class = "method-summary" id = "method-summary" >
2021-07-24 13:27:37 +02:00
< h2 > Method Summary< / h2 >
< div id = "method-summary-table" >
< 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-tab1" role = "tab" aria-selected = "false" aria-controls = "method-summary-table.tabpanel" tabindex = "-1" onkeydown = "switchTab(event)" onclick = "show('method-summary-table', 'method-summary-table-tab1', 3)" class = "table-tab" > Static 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-tab5" role = "tab" aria-selected = "false" aria-controls = "method-summary-table.tabpanel" tabindex = "-1" onkeydown = "switchTab(event)" onclick = "show('method-summary-table', 'method-summary-table-tab5', 3)" class = "table-tab" > Default Methods< / button > < / div >
< div id = "method-summary-table.tabpanel" role = "tabpanel" >
< div class = "summary-table three-column-summary" aria-labelledby = "method-summary-table-tab0" >
< div class = "table-header col-first" > Modifier and Type< / div >
< div class = "table-header col-second" > Method< / div >
< div class = "table-header col-last" > Description< / div >
2022-06-10 15:30:56 +02:00
< div class = "col-first even-row-color method-summary-table method-summary-table-tab1" > < code > static < a href = "CapabilityService.html" title = "interface in com.djrapitops.plan.capability" > CapabilityService< / a > < / code > < / div >
< div class = "col-second even-row-color method-summary-table method-summary-table-tab1" > < code > < a href = "#getInstance()" class = "member-name-link" > getInstance< / a > ()< / code > < / div >
< div class = "col-last even-row-color method-summary-table method-summary-table-tab1" >
2019-08-05 11:13:19 +02:00
< div class = "block" > Obtain instance of CapabilityService.< / div >
2021-07-24 13:27:37 +02:00
< / div >
2022-06-10 15:30:56 +02:00
< div class = "col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5" > < code > default boolean< / code > < / div >
< div class = "col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5" > < code > < a href = "#hasCapability(java.lang.String)" class = "member-name-link" > hasCapability< / a > < wbr > (< a href = "https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title = "class or interface in java.lang" class = "external-link" > String< / a > capabilityName)< / code > < / div >
< div class = "col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5" >
2019-08-05 11:13:19 +02:00
< div class = "block" > Check if the API on the current version provides a capability.< / div >
2021-07-24 13:27:37 +02:00
< / div >
2022-06-10 15:30:56 +02:00
< div class = "col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5" > < code > default void< / code > < / div >
< div class = "col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5" > < code > < a href = "#registerEnableListener(java.util.function.Consumer)" class = "member-name-link" > registerEnableListener< / a > < wbr > (< a href = "https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Consumer.html" title = "class or interface in java.util.function" class = "external-link" > Consumer< / a > < < a href = "https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title = "class or interface in java.lang" class = "external-link" > Boolean< / a > > isEnabledListener)< / code > < / div >
< div class = "col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5" >
2019-08-05 11:13:19 +02:00
< div class = "block" > Register a method to be called when Plan reloads.< / div >
2021-07-24 13:27:37 +02:00
< / div >
< / div >
< / div >
< / div >
2021-03-10 09:12:21 +01:00
< / section >
2019-08-05 11:13:19 +02:00
< / li >
< / ul >
2021-07-24 13:27:37 +02:00
< / section >
< section class = "details" >
< ul class = "details-list" >
2019-08-05 11:13:19 +02:00
<!-- ============ METHOD DETAIL ========== -->
2021-07-24 13:27:37 +02:00
< li >
2022-06-10 15:30:56 +02:00
< section class = "method-details" id = "method-detail" >
2021-07-24 13:27:37 +02:00
< h2 > Method Details< / h2 >
< ul class = "member-list" >
< li >
< section class = "detail" id = "getInstance()" >
< h3 > getInstance< / h3 >
< div class = "member-signature" > < span class = "modifiers" > static< / span > < span class = "return-type" > < a href = "CapabilityService.html" title = "interface in com.djrapitops.plan.capability" > CapabilityService< / a > < / span > < span class = "element-name" > getInstance< / span > ()< / div >
2019-08-05 11:13:19 +02:00
< div class = "block" > Obtain instance of CapabilityService.< / div >
2021-07-24 13:27:37 +02:00
< dl class = "notes" >
< dt > Returns:< / dt >
2019-08-05 11:13:19 +02:00
< dd > CapabilityService implementation.< / dd >
2021-07-24 13:27:37 +02:00
< dt > Throws:< / dt >
2022-06-10 15:30:56 +02:00
< dd > < code > < a href = "https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/NoClassDefFoundError.html" title = "class or interface in java.lang" class = "external-link" > NoClassDefFoundError< / a > < / code > - If Plan is not installed and this class can not be found or if older Plan version is installed.< / dd >
< dd > < code > < a href = "https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalStateException.html" title = "class or interface in java.lang" class = "external-link" > IllegalStateException< / a > < / code > - If Plan is installed, but not enabled.< / dd >
2019-08-05 11:13:19 +02:00
< / dl >
2021-07-24 13:27:37 +02:00
< / section >
2019-08-05 11:13:19 +02:00
< / li >
2021-07-24 13:27:37 +02:00
< li >
< section class = "detail" id = "registerEnableListener(java.util.function.Consumer)" >
< h3 > registerEnableListener< / h3 >
2022-06-10 15:30:56 +02:00
< div class = "member-signature" > < span class = "modifiers" > default< / span > < span class = "return-type" > void< / span > < span class = "element-name" > registerEnableListener< / span > < wbr > < span class = "parameters" > (< a href = "https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Consumer.html" title = "class or interface in java.util.function" class = "external-link" > Consumer< / a > < < a href = "https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title = "class or interface in java.lang" class = "external-link" > Boolean< / a > > isEnabledListener)< / span > < / div >
2019-08-05 11:13:19 +02:00
< div class = "block" > Register a method to be called when Plan reloads.< / div >
2021-07-24 13:27:37 +02:00
< dl class = "notes" >
< dt > Parameters:< / dt >
2019-08-05 11:13:19 +02:00
< dd > < code > isEnabledListener< / code > - The boolean given to the method tells if Plan has enabled successfully.< / dd >
< / dl >
2021-07-24 13:27:37 +02:00
< / section >
2019-08-05 11:13:19 +02:00
< / li >
2021-07-24 13:27:37 +02:00
< li >
< section class = "detail" id = "hasCapability(java.lang.String)" >
< h3 > hasCapability< / h3 >
2022-06-10 15:30:56 +02:00
< div class = "member-signature" > < span class = "modifiers" > default< / span > < span class = "return-type" > boolean< / span > < span class = "element-name" > hasCapability< / span > < wbr > < span class = "parameters" > (< a href = "https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title = "class or interface in java.lang" class = "external-link" > String< / a > capabilityName)< / span > < / div >
2019-08-05 11:13:19 +02:00
< div class = "block" > Check if the API on the current version provides a capability.< / div >
2021-07-24 13:27:37 +02:00
< dl class = "notes" >
< dt > Parameters:< / dt >
2019-08-05 11:13:19 +02:00
< dd > < code > capabilityName< / code > - Name of a capability< / dd >
2021-07-24 13:27:37 +02:00
< dt > Returns:< / dt >
2019-08-05 11:13:19 +02:00
< dd > true if the capability is available.< / dd >
2021-07-24 13:27:37 +02:00
< dt > See Also:< / dt >
2022-06-10 15:30:56 +02:00
< dd >
< ul class = "see-list" >
< li > < code > for different capabilityNames.< / code > < / li >
< / ul >
< / dd >
2019-08-05 11:13:19 +02:00
< / dl >
2021-07-24 13:27:37 +02:00
< / section >
2019-08-05 11:13:19 +02:00
< / li >
< / ul >
2021-03-10 09:12:21 +01:00
< / section >
2019-08-05 11:13:19 +02:00
< / li >
< / ul >
2021-07-24 13:27:37 +02:00
< / section >
2019-08-05 11:13:19 +02:00
<!-- ========= END OF CLASS DATA ========= -->
2021-07-24 13:27:37 +02:00
< / main >
2019-08-05 11:13:19 +02:00
< / div >
< / div >
< / body >
< / html >
