Plexus/Website
1
0
Fork 0
mirror of https://github.com/plexusorg/Website.git synced 2024-12-23 10:27:38 +00:00
Code Issues Packages Projects Releases Wiki Activity
15bc449f7e
Website/static/javadoc/dev/plex/module/PlexModule.html

643 lines
50 KiB
HTML
Raw Normal View History

Add javadocs
2024-11-30 20:17:10 +00:00
<!DOCTYPE HTML>
<html lang="en">
<head>
Huge documentation update
2024-12-02 18:41:26 +00:00
<!-- Generated by javadoc (21) -->
<title>PlexModule (server 1.5-SNAPSHOT API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="declaration: package: dev.plex.module, class: PlexModule">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../script-dir/jquery-ui.min.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
<script type="text/javascript" src="../../../script-dir/jquery-3.6.1.min.js"></script>
<script type="text/javascript" src="../../../script-dir/jquery-ui.min.js"></script>
Add javadocs
2024-11-30 20:17:10 +00:00
</head>
<body class="class-declaration-page">
<script type="text/javascript">var pathtoroot = "../../../";
loadScripts(document, 'script');</script>
<noscript>
Huge documentation update
2024-12-02 18:41:26 +00:00
<div>JavaScript is disabled on your browser.</div>
Add javadocs
2024-11-30 20:17:10 +00:00
</noscript>
<div class="flex-box">
Huge documentation update
2024-12-02 18:41:26 +00:00
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false"
aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon">&nbsp;</span><span
class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span>
</button>
<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">
<li><a href="../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">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#class">Help</a></li>
</ul>
<ul class="sub-nav-list-small">
<li>
<p>Summary:</p>
<ul>
<li>Nested</li>
<li><a href="#field-summary">Field</a></li>
<li><a href="#constructor-summary">Constr</a></li>
<li><a href="#method-summary">Method</a></li>
</ul>
</li>
<li>
<p>Detail:</p>
<ul>
<li><a href="#field-detail">Field</a></li>
<li><a href="#constructor-detail">Constr</a></li>
<li><a href="#method-detail">Method</a></li>
</ul>
</li>
</ul>
</div>
<div class="sub-nav">
<div id="navbar-sub-list">
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field-summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li><a href="#field-detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</a></li>
</ul>
</div>
<div class="nav-list-search"><a href="../../../search.html">SEARCH</a>
<input type="text" id="search-input" disabled placeholder="Search">
<input type="reset" id="reset-button" disabled value="reset">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a
href="package-summary.html">dev.plex.module</a></div>
<h1 title="Class PlexModule" class="title">Class PlexModule</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html"
title="class or interface in java.lang" class="external-link">java.lang.Object</a>
<div class="inheritance">dev.plex.module.PlexModule</div>
</div>
<section class="class-description" id="class-description">
<hr>
<div class="type-signature"><span class="modifiers">public abstract class </span><span
class="element-name type-name-label">PlexModule</span>
<span class="extends-implements">extends <a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html"
title="class or interface in java.lang" class="external-link">Object</a></span></div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- =========== FIELD SUMMARY =========== -->
<li>
<section class="field-summary" id="field-summary">
<h2>Field Summary</h2>
<div class="caption"><span>Fields</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">Field</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>private final <a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/List.html"
title="class or interface in java.util" class="external-link">List</a>
<wbr>&lt;<a href="../command/PlexCommand.html" title="class in dev.plex.command">PlexCommand</a>&gt;</code>
</div>
<div class="col-second even-row-color"><code><a href="#commands"
class="member-name-link">commands</a></code>
</div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>private <a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/File.html"
title="class or interface in java.io" class="external-link">File</a></code>
</div>
<div class="col-second odd-row-color"><code><a href="#dataFolder"
class="member-name-link">dataFolder</a></code>
</div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code>private final <a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/List.html"
title="class or interface in java.util" class="external-link">List</a>
<wbr>&lt;<a href="../listener/PlexListener.html" title="class in dev.plex.listener">PlexListener</a>&gt;</code>
</div>
<div class="col-second even-row-color"><code><a href="#listeners"
class="member-name-link">listeners</a></code>
</div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>private
org.apache.logging.log4j.Logger</code></div>
<div class="col-second odd-row-color"><code><a href="#logger" class="member-name-link">logger</a></code>
</div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code>private <a href="../Plex.html"
title="class in dev.plex">Plex</a></code>
</div>
<div class="col-second even-row-color"><code><a href="#plex" class="member-name-link">plex</a></code>
</div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>private <a href="PlexModuleFile.html"
title="class in dev.plex.module">PlexModuleFile</a></code>
</div>
<div class="col-second odd-row-color"><code><a href="#plexModuleFile"
class="member-name-link">plexModuleFile</a></code>
</div>
<div class="col-last odd-row-color">&nbsp;</div>
</div>
</section>
</li>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li>
<section class="constructor-summary" id="constructor-summary">
<h2>Constructor Summary</h2>
<div class="caption"><span>Constructors</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()"
class="member-name-link">PlexModule</a>()</code>
</div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<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-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-tab4" role="tab" aria-selected="false"
aria-controls="method-summary-table.tabpanel" tabindex="-1"
onkeydown="switchTab(event)"
onclick="show('method-summary-table', 'method-summary-table-tab4', 3)"
class="table-tab">Concrete Methods
</button>
</div>
<div id="method-summary-table.tabpanel" role="tabpanel"
aria-labelledby="method-summary-table-tab0">
<div class="summary-table three-column-summary">
<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>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<code><a href="#addDefaultMessage(java.lang.String,java.lang.Object)"
class="member-name-link">addDefaultMessage</a>
<wbr>
(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang"
class="external-link">String</a>&nbsp;message,
<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html"
title="class or interface in java.lang"
class="external-link">Object</a>&nbsp;initValue)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Adds a message to the messages.yml file</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<code><a
href="#addDefaultMessage(java.lang.String,java.lang.Object,java.lang.String...)"
class="member-name-link">addDefaultMessage</a>
<wbr>
(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang"
class="external-link">String</a>&nbsp;message,
<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html"
title="class or interface in java.lang"
class="external-link">Object</a>&nbsp;initValue,
<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang"
class="external-link">String</a>...&nbsp;comments)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Adds a message to the messages.yml with a comment</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<code><a href="#disable()" class="member-name-link">disable</a>()</code>
</div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
&nbsp;
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<code><a href="#enable()" class="member-name-link">enable</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
&nbsp;
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<code><a href="../command/PlexCommand.html"
title="class in dev.plex.command">PlexCommand</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<code><a href="#getCommand(java.lang.String)" class="member-name-link">getCommand</a>
<wbr>
(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang"
class="external-link">String</a>&nbsp;name)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
&nbsp;
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<code>@Nullable <a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/InputStream.html"
title="class or interface in java.io" class="external-link">InputStream</a></code>
</div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<code><a href="#getResource(java.lang.String)" class="member-name-link">getResource</a>
<wbr>
(@NotNull <a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang" class="external-link">String</a>&nbsp;filename)</code>
</div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
&nbsp;
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<code><a href="#load()" class="member-name-link">load</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
&nbsp;
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<code><a href="#registerCommand(dev.plex.command.PlexCommand)"
class="member-name-link">registerCommand</a>
<wbr>
(<a href="../command/PlexCommand.html"
title="class in dev.plex.command">PlexCommand</a>&nbsp;command)</code>
</div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Registers a PlexCommand within a module</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<code><a href="#registerListener(dev.plex.listener.PlexListener)"
class="member-name-link">registerListener</a>
<wbr>
(<a href="../listener/PlexListener.html"
title="class in dev.plex.listener">PlexListener</a>&nbsp;listener)</code>
</div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Registers a PlexListener within a module</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<code><a href="#unregisterCommand(dev.plex.command.PlexCommand)"
class="member-name-link">unregisterCommand</a>
<wbr>
(<a href="../command/PlexCommand.html"
title="class in dev.plex.command">PlexCommand</a>&nbsp;command)</code>
</div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Unregisters a PlexCommand.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<code><a href="#unregisterListener(dev.plex.listener.PlexListener)"
class="member-name-link">unregisterListener</a>
<wbr>
(<a href="../listener/PlexListener.html"
title="class in dev.plex.listener">PlexListener</a>&nbsp;listener)</code>
</div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Unregisters a PlexListener.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;java.lang.<a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html"
title="class or interface in java.lang" class="external-link">Object</a></h3>
<code><a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#clone()"
title="class or interface in java.lang" class="external-link">clone</a>, <a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)"
title="class or interface in java.lang" class="external-link">equals</a>, <a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#finalize()"
title="class or interface in java.lang" class="external-link">finalize</a>, <a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#getClass()"
title="class or interface in java.lang" class="external-link">getClass</a>, <a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#hashCode()"
title="class or interface in java.lang" class="external-link">hashCode</a>, <a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#notify()"
title="class or interface in java.lang" class="external-link">notify</a>, <a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#notifyAll()"
title="class or interface in java.lang" class="external-link">notifyAll</a>, <a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#toString()"
title="class or interface in java.lang" class="external-link">toString</a>, <a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#wait()"
title="class or interface in java.lang" class="external-link">wait</a>, <a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#wait(long)"
title="class or interface in java.lang" class="external-link">wait</a>, <a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#wait(long,int)"
title="class or interface in java.lang" class="external-link">wait</a></code>
</div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ============ FIELD DETAIL =========== -->
<li>
<section class="field-details" id="field-detail">
<h2>Field Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="commands">
<h3>commands</h3>
<div class="member-signature"><span class="modifiers">private final</span>&nbsp;<span
class="return-type"><a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/List.html"
title="class or interface in java.util" class="external-link">List</a>&lt;<a
href="../command/PlexCommand.html" title="class in dev.plex.command">PlexCommand</a>&gt;</span>&nbsp;<span
class="element-name">commands</span></div>
</section>
</li>
<li>
<section class="detail" id="listeners">
<h3>listeners</h3>
<div class="member-signature"><span class="modifiers">private final</span>&nbsp;<span
class="return-type"><a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/List.html"
title="class or interface in java.util" class="external-link">List</a>&lt;<a
href="../listener/PlexListener.html" title="class in dev.plex.listener">PlexListener</a>&gt;</span>&nbsp;<span
class="element-name">listeners</span></div>
</section>
</li>
<li>
<section class="detail" id="plex">
<h3>plex</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span
class="return-type"><a href="../Plex.html" title="class in dev.plex">Plex</a></span>&nbsp;<span
class="element-name">plex</span></div>
</section>
</li>
<li>
<section class="detail" id="plexModuleFile">
<h3>plexModuleFile</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span
class="return-type"><a href="PlexModuleFile.html"
title="class in dev.plex.module">PlexModuleFile</a></span>&nbsp;<span
class="element-name">plexModuleFile</span></div>
</section>
</li>
<li>
<section class="detail" id="dataFolder">
<h3>dataFolder</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span
class="return-type"><a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/File.html"
title="class or interface in java.io"
class="external-link">File</a></span>&nbsp;<span class="element-name">dataFolder</span>
</div>
</section>
</li>
<li>
<section class="detail" id="logger">
<h3>logger</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span
class="return-type">org.apache.logging.log4j.Logger</span>&nbsp;<span
class="element-name">logger</span></div>
</section>
</li>
</ul>
</section>
</li>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li>
<section class="constructor-details" id="constructor-detail">
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;()">
<h3>PlexModule</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span
class="element-name">PlexModule</span>()
</div>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="load()">
<h3>load</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span
class="return-type">void</span>&nbsp;<span
class="element-name">load</span>()
</div>
</section>
</li>
<li>
<section class="detail" id="enable()">
<h3>enable</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span
class="return-type">void</span>&nbsp;<span
class="element-name">enable</span>()
</div>
</section>
</li>
<li>
<section class="detail" id="disable()">
<h3>disable</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span
class="return-type">void</span>&nbsp;<span
class="element-name">disable</span>()
</div>
</section>
</li>
<li>
<section class="detail" id="registerListener(dev.plex.listener.PlexListener)">
<h3>registerListener</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span
class="return-type">void</span>&nbsp;<span class="element-name">registerListener</span>
<wbr>
<span class="parameters">(<a href="../listener/PlexListener.html"
title="class in dev.plex.listener">PlexListener</a>&nbsp;listener)</span>
</div>
<div class="block">Registers a PlexListener within a module</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>listener</code> - The PlexListener to be registered</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="unregisterListener(dev.plex.listener.PlexListener)">
<h3>unregisterListener</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span
class="return-type">void</span>&nbsp;<span class="element-name">unregisterListener</span>
<wbr>
<span class="parameters">(<a href="../listener/PlexListener.html"
title="class in dev.plex.listener">PlexListener</a>&nbsp;listener)</span>
</div>
<div class="block">Unregisters a PlexListener. Handled by Plex automatically
</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>listener</code> - The PlexListener to be registered</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="registerCommand(dev.plex.command.PlexCommand)">
<h3>registerCommand</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span
class="return-type">void</span>&nbsp;<span class="element-name">registerCommand</span>
<wbr>
<span class="parameters">(<a href="../command/PlexCommand.html"
title="class in dev.plex.command">PlexCommand</a>&nbsp;command)</span>
</div>
<div class="block">Registers a PlexCommand within a module</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>command</code> - The PlexCommand to be registered</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="unregisterCommand(dev.plex.command.PlexCommand)">
<h3>unregisterCommand</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span
class="return-type">void</span>&nbsp;<span class="element-name">unregisterCommand</span>
<wbr>
<span class="parameters">(<a href="../command/PlexCommand.html"
title="class in dev.plex.command">PlexCommand</a>&nbsp;command)</span>
</div>
<div class="block">Unregisters a PlexCommand. Handled by Plex automatically
</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>command</code> - The PlexCommand to be registered</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getCommand(java.lang.String)">
<h3>getCommand</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span
class="return-type"><a href="../command/PlexCommand.html"
title="class in dev.plex.command">PlexCommand</a></span>&nbsp;<span
class="element-name">getCommand</span>
<wbr>
<span class="parameters">(<a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang"
class="external-link">String</a>&nbsp;name)</span></div>
</section>
</li>
<li>
<section class="detail" id="addDefaultMessage(java.lang.String,java.lang.Object)">
<h3>addDefaultMessage</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span
class="return-type">void</span>&nbsp;<span class="element-name">addDefaultMessage</span>
<wbr>
<span class="parameters">(<a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang"
class="external-link">String</a>&nbsp;message,
<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html"
title="class or interface in java.lang" class="external-link">Object</a>&nbsp;initValue)</span></div>
<div class="block">Adds a message to the messages.yml file</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>message</code> - The key value for the message</dd>
<dd><code>initValue</code> - The message itself</dd>
</dl>
</section>
</li>
<li>
<section class="detail"
id="addDefaultMessage(java.lang.String,java.lang.Object,java.lang.String...)">
<h3>addDefaultMessage</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span
class="return-type">void</span>&nbsp;<span class="element-name">addDefaultMessage</span>
<wbr>
<span class="parameters">(<a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang"
class="external-link">String</a>&nbsp;message,
<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html"
title="class or interface in java.lang" class="external-link">Object</a>&nbsp;initValue,
<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang" class="external-link">String</a>...&nbsp;comments)</span></div>
<div class="block">Adds a message to the messages.yml with a comment</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>message</code> - The key value for the message</dd>
<dd><code>initValue</code> - The message itself</dd>
<dd><code>comments</code> - The comments to be placed above the message</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getResource(java.lang.String)">
<h3>getResource</h3>
<div class="member-signature"><span class="annotations">@Nullable
</span><span class="modifiers">public</span>&nbsp;<span class="return-type">@Nullable <a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/InputStream.html"
title="class or interface in java.io"
class="external-link">InputStream</a></span>&nbsp;<span
class="element-name">getResource</span>
<wbr>
<span class="parameters">(@NotNull
@NotNull <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang" class="external-link">String</a>&nbsp;filename)</span></div>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
</div>
Add javadocs
2024-11-30 20:17:10 +00:00
</div>
</body>
</html>
Reference in New Issue Copy Permalink