mirror of
https://github.com/GravitLauncher/Launcher
synced 2024-12-23 09:01:08 +03:00
[DOC] Немного правок JavaDoc
This commit is contained in:
parent
a91135835a
commit
709d75eb80
4 changed files with 40 additions and 16 deletions
|
@ -5,7 +5,13 @@
|
||||||
import pro.gravit.launcher.LauncherNetworkAPI;
|
import pro.gravit.launcher.LauncherNetworkAPI;
|
||||||
import pro.gravit.launcher.request.WebSocketEvent;
|
import pro.gravit.launcher.request.WebSocketEvent;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The class of all request events sent by the server to the client
|
||||||
|
*/
|
||||||
public abstract class RequestEvent implements WebSocketEvent {
|
public abstract class RequestEvent implements WebSocketEvent {
|
||||||
|
/**
|
||||||
|
* UUID sent in request
|
||||||
|
*/
|
||||||
@LauncherNetworkAPI
|
@LauncherNetworkAPI
|
||||||
public UUID requestUUID;
|
public UUID requestUUID;
|
||||||
}
|
}
|
||||||
|
|
|
@ -28,16 +28,28 @@ public LauncherModuleInfo getModuleInfo() {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Module initialization status at the current time
|
* Module initialization status at the current time
|
||||||
* CREATED - Module status immediately after loading
|
|
||||||
* INIT - The state of the module during the execution of the method init()
|
|
||||||
* FINISH - Status of the module after initialization
|
|
||||||
*/
|
*/
|
||||||
public enum InitStatus
|
public enum InitStatus
|
||||||
{
|
{
|
||||||
|
/**
|
||||||
|
* When creating an object
|
||||||
|
*/
|
||||||
CREATED(false),
|
CREATED(false),
|
||||||
|
/**
|
||||||
|
* After setting the context
|
||||||
|
*/
|
||||||
PRE_INIT_WAIT(true),
|
PRE_INIT_WAIT(true),
|
||||||
|
/**
|
||||||
|
* During the pre-initialization phase
|
||||||
|
*/
|
||||||
PRE_INIT(false),
|
PRE_INIT(false),
|
||||||
|
/**
|
||||||
|
* Awaiting initialization phase
|
||||||
|
*/
|
||||||
INIT_WAIT(true),
|
INIT_WAIT(true),
|
||||||
|
/**
|
||||||
|
* During the initialization phase
|
||||||
|
*/
|
||||||
INIT(false),
|
INIT(false),
|
||||||
FINISH(true);
|
FINISH(true);
|
||||||
|
|
||||||
|
@ -96,13 +108,13 @@ public void setContext(LauncherModulesContext context)
|
||||||
/**
|
/**
|
||||||
* This method is called before initializing all modules and resolving dependencies.
|
* This method is called before initializing all modules and resolving dependencies.
|
||||||
* <b>You can</b>:
|
* <b>You can</b>:
|
||||||
* Use to Module Manager
|
* - Use to Module Manager
|
||||||
* Add custom modules not described in the manifest
|
* - Add custom modules not described in the manifest
|
||||||
* Change information about your module or modules you control
|
* - Change information about your module or modules you control
|
||||||
* <b>You can not</b>:
|
* <b>You can not</b>:
|
||||||
* Use your dependencies
|
* - Use your dependencies
|
||||||
* Use API Launcher, LaunchServer, ServerWrapper
|
* - Use Launcher, LaunchServer, ServerWrapper API
|
||||||
* Change the names of any modules
|
* - Change the names of any modules
|
||||||
*/
|
*/
|
||||||
public void preInitAction() {
|
public void preInitAction() {
|
||||||
//NOP
|
//NOP
|
||||||
|
@ -119,14 +131,14 @@ public LauncherModule preInit()
|
||||||
/**
|
/**
|
||||||
* Basic module initialization method
|
* Basic module initialization method
|
||||||
* <b>You can</b>:
|
* <b>You can</b>:
|
||||||
* Subscribe to events
|
* - Subscribe to events
|
||||||
* Use your dependencies
|
* - Use your dependencies
|
||||||
* Use provided initContext
|
* - Use provided initContext
|
||||||
* Receive modules and access the module’s internal methods
|
* - Receive modules and access the module’s internal methods
|
||||||
* <b>You can not</b>:
|
* <b>You can not</b>:
|
||||||
* Modify module description, dependencies
|
* - Modify module description, dependencies
|
||||||
* Add modules
|
* - Add modules
|
||||||
* Read configuration
|
* - Read configuration
|
||||||
* @param initContext <b>null</b> on module initialization during boot or startup
|
* @param initContext <b>null</b> on module initialization during boot or startup
|
||||||
* Not <b>null</b> during module initialization while running
|
* Not <b>null</b> during module initialization while running
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -7,6 +7,9 @@ public class LauncherModuleInfo {
|
||||||
public final Version version;
|
public final Version version;
|
||||||
public final int priority;
|
public final int priority;
|
||||||
public final String[] dependencies;
|
public final String[] dependencies;
|
||||||
|
/**
|
||||||
|
* Alternative module names
|
||||||
|
*/
|
||||||
public final String[] providers;
|
public final String[] providers;
|
||||||
|
|
||||||
public LauncherModuleInfo(String name, Version version) {
|
public LauncherModuleInfo(String name, Version version) {
|
||||||
|
|
|
@ -2,6 +2,9 @@
|
||||||
|
|
||||||
import pro.gravit.utils.TypeSerializeInterface;
|
import pro.gravit.utils.TypeSerializeInterface;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The interface of all events sent by the server to the client
|
||||||
|
*/
|
||||||
public interface WebSocketEvent extends TypeSerializeInterface {
|
public interface WebSocketEvent extends TypeSerializeInterface {
|
||||||
String getType();
|
String getType();
|
||||||
}
|
}
|
||||||
|
|
Loading…
Reference in a new issue