mirror of https://github.com/GeyserMC/Geyser.git
107 lines
2.7 KiB
Java
107 lines
2.7 KiB
Java
/*
|
|
* Copyright (c) 2019-2023 GeyserMC. http://geysermc.org
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
* of this software and associated documentation files (the "Software"), to deal
|
|
* in the Software without restriction, including without limitation the rights
|
|
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
* copies of the Software, and to permit persons to whom the Software is
|
|
* furnished to do so, subject to the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be included in
|
|
* all copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
* THE SOFTWARE.
|
|
*
|
|
* @author GeyserMC
|
|
* @link https://github.com/GeyserMC/Geyser
|
|
*/
|
|
|
|
package org.geysermc.geyser.api.extension;
|
|
|
|
import org.checkerframework.checker.nullness.qual.NonNull;
|
|
|
|
import java.util.List;
|
|
|
|
/**
|
|
* Represents the description of an {@link Extension}.
|
|
*/
|
|
public interface ExtensionDescription {
|
|
|
|
/**
|
|
* Gets the extension's id.
|
|
*
|
|
* @return the extension's id
|
|
*/
|
|
@NonNull
|
|
String id();
|
|
|
|
/**
|
|
* Gets the extension's name.
|
|
*
|
|
* @return the extension's name
|
|
*/
|
|
@NonNull
|
|
String name();
|
|
|
|
/**
|
|
* Gets the extension's main class.
|
|
*
|
|
* @return the extension's main class
|
|
*/
|
|
@NonNull
|
|
String main();
|
|
|
|
/**
|
|
* Gets the extension's major api version
|
|
*
|
|
* @return the extension's major api version
|
|
*/
|
|
int majorApiVersion();
|
|
|
|
/**
|
|
* Gets the extension's minor api version
|
|
*
|
|
* @return the extension's minor api version
|
|
*/
|
|
int minorApiVersion();
|
|
|
|
/**
|
|
* Gets the extension's patch api version
|
|
*
|
|
* @return the extension's patch api version
|
|
*/
|
|
int patchApiVersion();
|
|
|
|
/**
|
|
* Gets the extension's api version.
|
|
*
|
|
* @return the extension's api version
|
|
*/
|
|
default String apiVersion() {
|
|
return majorApiVersion() + "." + minorApiVersion() + "." + patchApiVersion();
|
|
}
|
|
|
|
/**
|
|
* Gets the extension's description.
|
|
*
|
|
* @return the extension's description
|
|
*/
|
|
@NonNull
|
|
String version();
|
|
|
|
/**
|
|
* Gets the extension's authors.
|
|
*
|
|
* @return the extension's authors
|
|
*/
|
|
@NonNull
|
|
List<String> authors();
|
|
}
|