Package me.github.simonplays15.betterbansystem.api.files

Class BasePluginDescription

java.lang.Object

me.github.simonplays15.betterbansystem.api.files.BasePluginDescription

public class BasePluginDescription
                    extends Object

The BasePluginDescription class represents the description of a plugin. It stores information about the plugin's name, version, main class, commands, and description.

Constructor Summary

Constructors

Constructor	Description
BasePluginDescription (@NotNull InputStream stream)	Constructs a new instance of the BasePluginDescription class with the given InputStream.
BasePluginDescription (@NotNull Reader reader)	Class: BasePluginDescription Represents a plugin description.

Method Summary

Modifier and Type	Method	Description
Map<String, Map<String, Object>>	getCommands()	Retrieves the commands stored in a map.
String	getDescription()	Retrieves the description of the plugin.
String	getMain()	Returns the main class specified in the plugin description.
String	getName()	Returns the name of the plugin.
String	getVersion()	Retrieves the version of the plugin.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

BasePluginDescription

public BasePluginDescription
                                            
                                            (@NotNull
 @NotNull InputStream stream)
                                            throws InvalidDescriptionException
                                        

Constructs a new instance of the BasePluginDescription class with the given InputStream.

Parameters:

stream - The InputStream containing the plugin's description data.

Throws:

InvalidDescriptionException - If the description is invalid.

BasePluginDescription

public BasePluginDescription
                                            
                                            (@NotNull
 @NotNull Reader reader)
                                            throws InvalidDescriptionException
                                        

Class: BasePluginDescription Represents a plugin description.

Throws:

InvalidDescriptionException

Method Details

getName

public String getName()
                                        

Returns the name of the plugin.

Returns:

The name of the plugin.

getMain

public String getMain()
                                        

Returns the main class specified in the plugin description.

Returns:

the main class specified in the plugin description

getCommands

public Map<String,Map<String,Object>> getCommands()
                                        

Retrieves the commands stored in a map.

Returns:

A map of commands, where the key is a string representing the command name and the value is another map object containing the command data.

getDescription

public String getDescription()
                                        

Retrieves the description of the plugin.

Returns:

The description of the plugin as a string.

getVersion

public String getVersion()
                                        

Retrieves the version of the plugin.

Returns:

The version of the plugin.