JeremyStarTM/Engine
1
0
Fork 0
forked from StarOpenSource/Engine
Code Pull requests Activity Actions

Prefix all @since values with 'v'

Browse source
This commit is contained in:
JeremyStar™ 2024-07-12 02:30:20 +02:00
parent 6cfaf88bca
commit e65c3e2662
Signed by: JeremyStarTM
GPG key ID: E366BAEF67E4704D
174 changed files with 726 additions and 726 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

36
base/src/main/java/de/staropensource/sosengine/base/Engine.java
View file

@ -55,7 +55,7 @@ import java.util.*;
* It is responsible for the base engine initialization.
*
* @see EngineConfiguration
* @since 1-alpha0
* @since v1-alpha0
*/
@SuppressWarnings({ "unused", "JavadocDeclaration", "JavadocBlankLines" })
@EngineSubsystem
@ -63,13 +63,13 @@ public final class Engine implements SubsystemMainClass {
/**
* Contains the class instance.
*
* @since 1-alpha0
* @since v1-alpha0
*
* -- GETTER --
* Returns the class instance.
*
* @return class instance unless the engine is uninitialized
* @since 1-alpha0
* @since v1-alpha0
*/
@Getter
private static Engine instance = null;
@ -78,7 +78,7 @@ public final class Engine implements SubsystemMainClass {
* Logger instance.
*
* @see LoggerInstance
* @since 1-alpha0
* @since v1-alpha0
*/
@SuppressWarnings("NotNullFieldNotInitialized")
@NotNull
@ -88,14 +88,14 @@ public final class Engine implements SubsystemMainClass {
* Contains a list of all registered subsystems.
* The list is sorted after initialization order.
*
* @since 1-alpha1
* @since v1-alpha1
*
* -- GETTER --
* Returns a list of all registered subsystems.
* The list is sorted after initialization order.
*
* @return subsystem list
* @since 1-alpha1
* @since v1-alpha1
*/
@NotNull
@Getter
@ -104,13 +104,13 @@ public final class Engine implements SubsystemMainClass {
/**
* Indicates if the engine is shutting down.
*
* @since 1-alpha1
* @since v1-alpha1
*
* -- GETTER --
* Returns if the engine is shutting down.
*
* @return if the engine is shutting down
* @since 1-alpha1
* @since v1-alpha1
*/
@Getter
private boolean shuttingDown = false;
@ -118,7 +118,7 @@ public final class Engine implements SubsystemMainClass {
/**
* Initializes the StarOpenSource Engine.
*
* @since 1-alpha0
* @since v1-alpha0
*/
public Engine() {
// Only allow one instance
@ -164,7 +164,7 @@ public final class Engine implements SubsystemMainClass {
/**
* Initializes all classes.
*
* @since 1-alpha0
* @since v1-alpha0
*/
private void initializeClasses() {
// Sorted in rough order of dependence
@ -177,7 +177,7 @@ public final class Engine implements SubsystemMainClass {
* This method populates the Crash Handler's content with the default set of content.
*
* @see CrashHandler#getCrashContent()
* @since 1-alpha0
* @since v1-alpha0
*/
@SuppressWarnings("ExtractMethodRecommender")
private void populateCrashContent() {
@ -233,7 +233,7 @@ public final class Engine implements SubsystemMainClass {
/**
* Precomputes all base engine events.
*
* @since 1-alpha0
* @since v1-alpha0
*/
private void precomputeEventListeners() {
// Internal events
@ -248,7 +248,7 @@ public final class Engine implements SubsystemMainClass {
/**
* Collects all subsystems by their {@link EngineSubsystem} annotation.
*
* @since 1-alpha1
* @since v1-alpha1
*/
private void collectSubsystems() {
ArrayList<@NotNull DependencySubsystemVector> subsystemsMutable = new ArrayList<>();
@ -291,7 +291,7 @@ public final class Engine implements SubsystemMainClass {
* Initializes all subsystems.
*
* @throws Exception exceptions thrown by the {@link DependencyResolver}
* @since 1-alpha1
* @since v1-alpha1
*/
private void initializeSubsystems() throws Exception {
DependencyResolver resolver = new DependencyResolver();
@ -331,7 +331,7 @@ public final class Engine implements SubsystemMainClass {
/**
* Starts engine threads.
*
* @since 1-alpha1
* @since v1-alpha1
*/
public void startThreads() {
Logger.startLoggingThread();
@ -341,7 +341,7 @@ public final class Engine implements SubsystemMainClass {
* Shuts the engine and JVM down.
*
* @param exitCode code to exit with, from 0-255
* @since 1-alpha0
* @since v1-alpha0
*/
public synchronized void shutdown(@Range(from = 0, to = 255) int exitCode) {
logger.info("Shutting engine down");
@ -366,7 +366,7 @@ public final class Engine implements SubsystemMainClass {
* Returns the {@link DependencyVector} for this subsystem.
*
* @see DependencyVector
* @since 1-alpha1
* @since v1-alpha1
*/
@NotNull
@Override
@ -377,7 +377,7 @@ public final class Engine implements SubsystemMainClass {
/**
* Shuts the engine and JVM down.
*
* @since 1-alpha0
* @since v1-alpha0
*/
public synchronized void shutdown() {
shutdown(0);

58
base/src/main/java/de/staropensource/sosengine/base/EngineConfiguration.java
View file

@ -46,7 +46,7 @@ import java.util.Properties;
* or have an inconsistent naming scheme. Containing settings as variables in
* one centralized place mitigates this.
*
* @since 1-alpha0
* @since v1-alpha0
*/
@SuppressWarnings({ "unused", "JavadocDeclaration", "JavadocBlankLines" })
@Getter
@ -54,13 +54,13 @@ public final class EngineConfiguration implements SubsystemConfiguration {
/**
* Contains the class instance.
*
* @since 1-alpha0
* @since v1-alpha0
*
* -- GETTER --
* Returns the class instance.
*
* @return class instance unless {@link Engine} is uninitialized
* @since 1-alpha0
* @since v1-alpha0
*/
@Getter
private static EngineConfiguration instance;
@ -68,13 +68,13 @@ public final class EngineConfiguration implements SubsystemConfiguration {
/**
* Defines the group every property must start with to be recognized as a subsystem configuration setting.
*
* @since 1-alpha0
* @since v1-alpha0
*
* -- GETTER --
* Returns the group that every property must start with to be recognized as a subsystem configuration setting.
*
* @return property group
* @since 1-alpha0
* @since v1-alpha0
*/
@NotNull
@Getter
@ -84,14 +84,14 @@ public final class EngineConfiguration implements SubsystemConfiguration {
* If enabled, allows for unintentional behaviour and excess logging.<br/>
* Unless you want to debug or work on a sensitive part of the engine, don't enable this!
*
* @since 1-alpha0
* @since v1-alpha0
*
* -- GETTER --
* Gets the value for {@code debug}.
*
* @return variable value
* @see EngineConfiguration#debug
* @since 1-alpha0
* @since v1-alpha0
*/
private boolean debug;
@ -99,14 +99,14 @@ public final class EngineConfiguration implements SubsystemConfiguration {
* If enabled, all called events will be logged.
*
* @see de.staropensource.sosengine.base.classes.helpers.EventHelper#logCall(Class, Object...)
* @since 1-alpha0
* @since v1-alpha0
*
* -- GETTER --
* Gets the value for {@code debugEvents}.
*
* @return variable value
* @see EngineConfiguration#debugEvents
* @since 1-alpha0
* @since v1-alpha0
*/
private boolean debugEvents;
@ -115,14 +115,14 @@ public final class EngineConfiguration implements SubsystemConfiguration {
* Don't enable unless you want to work on it.
*
* @see AnsiShortcodeConverter
* @since 1-alpha0
* @since v1-alpha0
*
* -- GETTER --
* Gets the value for {@code debugShortcodeConverter}.
*
* @return variable value
* @see EngineConfiguration#debugShortcodeConverter
* @since 1-alpha0
* @since v1-alpha0
*/
private boolean debugShortcodeConverter;
@ -132,14 +132,14 @@ public final class EngineConfiguration implements SubsystemConfiguration {
*
* @see AnsiShortcodeConverter
* @see EngineConfiguration#loggerLevel
* @since 1-alpha0
* @since v1-alpha0
*
* -- GETTER --
* Gets the value for {@code errorShortcodeConverter}.
*
* @return variable value
* @see EngineConfiguration#errorShortcodeConverter
* @since 1-alpha0
* @since v1-alpha0
*/
private boolean errorShortcodeConverter;
@ -147,14 +147,14 @@ public final class EngineConfiguration implements SubsystemConfiguration {
* Determines which logger levels are allowed by setting the minimum logger level.
*
* @see Logger
* @since 1-alpha0
* @since v1-alpha0
*
* -- GETTER --
* Gets the value for {@code loggerLevel}.
*
* @return variable value
* @see EngineConfiguration#loggerLevel
* @since 1-alpha0
* @since v1-alpha0
*/
private LogLevel loggerLevel;
@ -162,14 +162,14 @@ public final class EngineConfiguration implements SubsystemConfiguration {
* Contains the logging template used for creating log messages.
*
* @see Logger
* @since 1-alpha0
* @since v1-alpha0
*
* -- GETTER --
* Gets the value for {@code loggerTemplate}
*
* @return variable value
* @see EngineConfiguration#loggerTemplate
* @since 1-alpha0
* @since v1-alpha0
*/
private String loggerTemplate;
@ -178,14 +178,14 @@ public final class EngineConfiguration implements SubsystemConfiguration {
* Note: This will also prevent Jansi and potentially other libraries from removing temporary native libraries at shutdown.
*
* @see CrashHandler
* @since 1-alpha0
* @since v1-alpha0
*
* -- GETTER --
* Gets the value for {@code loggerImmediateShutdown}.
*
* @return variable value
* @see EngineConfiguration#loggerImmediateShutdown
* @since 1-alpha0
* @since v1-alpha0
*/
private boolean loggerImmediateShutdown;
@ -193,14 +193,14 @@ public final class EngineConfiguration implements SubsystemConfiguration {
* If enabled, will force the {@link Logger} and {@link CrashHandler} to use <a href="https://www.man7.org/linux/man-pages/man3/stderr.3.html">the standard output</a>
* instead of <a href="https://www.man7.org/linux/man-pages/man3/stderr.3.html">the standard error</a> for logging {@code ERROR} and {@code CRASH}.
*
* @since 1-alpha0
* @since v1-alpha0
*
* -- GETTER --
* Gets the value for {@code loggerForceStandardOutput}.
*
* @return variable value
* @see EngineConfiguration#loggerForceStandardOutput
* @since 1-alpha0
* @since v1-alpha0
*/
private boolean loggerForceStandardOutput;
@ -209,14 +209,14 @@ public final class EngineConfiguration implements SubsystemConfiguration {
* Only applies if {@code optimizeLogging} is turned on.
*
* @see EngineConfiguration#optimizeLogging
* @since 1-alpha1
* @since v1-alpha1
*
* -- GETTER --
* Gets the value for {@code loggerForceStandardOutput}.
*
* @return variable value
* @see EngineConfiguration#loggerForceStandardOutput
* @since 1-alpha1
* @since v1-alpha1
*/
private int loggerPollingSpeed;
@ -226,14 +226,14 @@ public final class EngineConfiguration implements SubsystemConfiguration {
*
* @see EngineConfiguration#loggerPollingSpeed
* @see Thread
* @since 1-alpha0
* @since v1-alpha0
*
* -- GETTER --
* Gets the value for {@code optimizeLogging}.
*
* @return variable value
* @see EngineConfiguration#optimizeLogging
* @since 1-alpha0
* @since v1-alpha0
*/
private boolean optimizeLogging;
@ -242,14 +242,14 @@ public final class EngineConfiguration implements SubsystemConfiguration {
* Don't disable unless you want your application to run slower.
*
* @see VirtualThread
* @since 1-alpha0
* @since v1-alpha0
*
* -- GETTER --
* Gets the value for {@code optimizeEvents}.
*
* @return variable value
* @see EngineConfiguration#optimizeEvents
* @since 1-alpha0
* @since v1-alpha0
*/
private boolean optimizeEvents;
@ -257,7 +257,7 @@ public final class EngineConfiguration implements SubsystemConfiguration {
* Constructs this class.
*
* @see Engine
* @since 1-alpha0
* @since v1-alpha0
*/
public EngineConfiguration() {
// Only allow one instance
@ -389,7 +389,7 @@ public final class EngineConfiguration implements SubsystemConfiguration {
/**
* Clears {@code instance}. Used in unit tests.
*
* @since 1-alpha1
* @since v1-alpha1
*/
private static void clearInstance() {
instance = null;

2
base/src/main/java/de/staropensource/sosengine/base/annotations/EngineSubsystem.java
View file

@ -24,7 +24,7 @@ import java.lang.annotation.*;
/**
* This annotation marks a class as a subsystem main class.
*
* @since 1-alpha1
* @since v1-alpha1
*/
@SuppressWarnings("unused")
@Retention(RetentionPolicy.RUNTIME)

2
base/src/main/java/de/staropensource/sosengine/base/annotations/EventListener.java
View file

@ -28,7 +28,7 @@ import java.lang.annotation.*;
/**
* This annotation allows methods to listen on certain events.
*
* @since 1-alpha0
* @since v1-alpha0
*/
@SuppressWarnings("unused")
@Retention(RetentionPolicy.RUNTIME)

2
base/src/main/java/de/staropensource/sosengine/base/annotations/package-info.java
View file

@ -21,6 +21,6 @@
* Contains annotations that are used by the engine
* to dynamically invoke methods or register classes.
*
* @since 1-alpha0
* @since v1-alpha0
*/
package de.staropensource.sosengine.base.annotations;

2
base/src/main/java/de/staropensource/sosengine/base/classes/Event.java
View file

@ -22,7 +22,7 @@ package de.staropensource.sosengine.base.classes;
/**
* Represents an event.
*
* @since 1-alpha0
* @since v1-alpha0
*/
@SuppressWarnings({ "unused" })
public interface Event {

8
base/src/main/java/de/staropensource/sosengine/base/classes/LoggerImpl.java
View file

@ -27,7 +27,7 @@ import org.jetbrains.annotations.NotNull;
* Interface for implementing custom logger implementations, called by {@link de.staropensource.sosengine.base.logging.Logger}.
*
* @see de.staropensource.sosengine.base.logging.Logger
* @since 1-alpha0
* @since v1-alpha0
*/
@SuppressWarnings({ "unused" })
public interface LoggerImpl {
@ -38,7 +38,7 @@ public interface LoggerImpl {
* @param logIssuer log issuer
* @param message log message
* @return new log message
* @since 1-alpha0
* @since v1-alpha0
*/
@NotNull
String prePlaceholder(@NotNull LogLevel level, @NotNull LogIssuer logIssuer, @NotNull String message);
@ -50,7 +50,7 @@ public interface LoggerImpl {
* @param logIssuer log issuer
* @param format log format
* @return new log format
* @since 1-alpha0
* @since v1-alpha0
*/
@NotNull
String postPlaceholder(@NotNull LogLevel level, @NotNull LogIssuer logIssuer, @NotNull String format);
@ -61,7 +61,7 @@ public interface LoggerImpl {
* @param level log level
* @param logIssuer log issuer
* @param format finalized log format
* @since 1-alpha0
* @since v1-alpha0
*/
void print(@NotNull LogLevel level, @NotNull LogIssuer logIssuer, @NotNull String format);
}

6
base/src/main/java/de/staropensource/sosengine/base/classes/Placeholder.java
View file

@ -26,7 +26,7 @@ import org.jetbrains.annotations.NotNull;
* Interface for implementing placeholders.
*
* @see PlaceholderEngine
* @since 1-alpha0
* @since v1-alpha0
*/
@SuppressWarnings({ "unused" })
public interface Placeholder {
@ -34,7 +34,7 @@ public interface Placeholder {
* Returns the placeholder's name.
*
* @return the placeholder name
* @since 1-alpha0
* @since v1-alpha0
*/
@NotNull
String getName();
@ -44,7 +44,7 @@ public interface Placeholder {
*
* @param text text to process
* @return the processed text
* @since 1-alpha0
* @since v1-alpha0
*/
@NotNull
String replace(@NotNull String text);

12
base/src/main/java/de/staropensource/sosengine/base/classes/ShortcodeParserSkeleton.java
View file

@ -46,7 +46,7 @@ import java.util.List;
* <li>negative</li>
* </ul>
*
* @since 1-alpha1
* @since v1-alpha1
*/
@SuppressWarnings({ "unused", "JavadocDeclaration", "JavadocBlankLines" })
public abstract class ShortcodeParserSkeleton {
@ -54,20 +54,20 @@ public abstract class ShortcodeParserSkeleton {
* Logger instance.
*
* @see LoggerInstance
* @since 1-alpha1
* @since v1-alpha1
*/
protected final LoggerInstance logger = new LoggerInstance(new LogIssuer(getClass(), CodePart.ENGINE));
/**
* A list of components the parsed string is made out of.
*
* @since 1-alpha1
* @since v1-alpha1
*
* -- GETTER --
* Returns a list of components the parsed string is made out of.
*
* @return component list of the parsed string
* @since 1-alpha1
* @since v1-alpha1
*/
@NotNull
@Getter
@ -77,7 +77,7 @@ public abstract class ShortcodeParserSkeleton {
* Constructs this class.
*
* @param string string to parse
* @since 1-alpha1
* @since v1-alpha1
*/
public ShortcodeParserSkeleton(@NotNull String string) {
components = parse(string);
@ -89,7 +89,7 @@ public abstract class ShortcodeParserSkeleton {
* @param string string to parse
* @return list of components
* @see EngineConfiguration#errorShortcodeConverter
* @since 1-alpha1
* @since v1-alpha1
*/
@NotNull
private List<@NotNull String> parse(@NotNull String string) {

12
base/src/main/java/de/staropensource/sosengine/base/classes/SubsystemConfiguration.java
View file

@ -26,21 +26,21 @@ import java.util.Properties;
/**
* Base class for subsystem configurations.
*
* @since 1-alpha0
* @since v1-alpha0
*/
@SuppressWarnings({ "unused" })
public interface SubsystemConfiguration {
/**
* Contains the class instance.
*
* @since 1-alpha0
* @since v1-alpha0
*/
SubsystemConfiguration instance = null;
/**
* Defines the group every property must start with to be recognized as a subsystem configuration setting.
*
* @since 1-alpha0
* @since v1-alpha0
*/
@NotNull
String group = "sosengine.";
@ -51,7 +51,7 @@ public interface SubsystemConfiguration {
*
* @param properties {@link Properties} object
* @see SubsystemConfiguration#loadDefaultConfiguration()
* @since 1-alpha0
* @since v1-alpha0
*/
void loadConfiguration(@NotNull Properties properties);
@ -60,7 +60,7 @@ public interface SubsystemConfiguration {
*
* @see SubsystemConfiguration#loadConfiguration(Properties)
* @see System#getProperties()
* @since 1-alpha0
* @since v1-alpha0
*/
void loadConfiguration();
@ -69,7 +69,7 @@ public interface SubsystemConfiguration {
*
* @see SubsystemConfiguration#loadConfiguration()
* @see SubsystemConfiguration#loadConfiguration(Properties)
* @since 1-alpha0
* @since v1-alpha0
*/
void loadDefaultConfiguration();

10
base/src/main/java/de/staropensource/sosengine/base/classes/SubsystemMainClass.java
View file

@ -29,7 +29,7 @@ import org.jetbrains.annotations.NotNull;
/**
* The interface for engine subsystem main classes.
*
* @since 1-alpha0
* @since v1-alpha0
*/
@SuppressWarnings({ "unused" })
public interface SubsystemMainClass {
@ -37,14 +37,14 @@ public interface SubsystemMainClass {
* Logger instance.
*
* @see LoggerInstance
* @since 1-alpha0
* @since v1-alpha0
*/
LoggerInstance logger = null;
/**
* Initializes this subsystem.
*
* @since 1-alpha1
* @since v1-alpha1
*/
void initializeSubsystem();
@ -52,7 +52,7 @@ public interface SubsystemMainClass {
* Returns the {@link DependencyVector} for this subsystem.
*
* @return {@link DependencyVector} for this subsystem
* @since 1-alpha1
* @since v1-alpha1
* @see DependencyVector
*/
@NotNull
@ -63,7 +63,7 @@ public interface SubsystemMainClass {
*
* @see Engine#shutdown()
* @see Engine#shutdown(int)
* @since 1-alpha0
* @since v1-alpha0
*/
@EventListener(event = InternalEngineShutdownEvent.class)
static void shutdown() {}

6
base/src/main/java/de/staropensource/sosengine/base/classes/VersioningSystem.java
View file

@ -26,7 +26,7 @@ import org.jetbrains.annotations.Range;
/**
* An interface used for implementing different versioning systems.
*
* @since 1-alpha1
* @since v1-alpha1
*/
@SuppressWarnings({ "unused" })
public interface VersioningSystem {
@ -34,7 +34,7 @@ public interface VersioningSystem {
* Returns the name of this versioning system.
*
* @return name of this versioning system
* @since 1-alpha1
* @since v1-alpha1
*/
@NotNull
String getName();
@ -45,7 +45,7 @@ public interface VersioningSystem {
* @param version the version to compare against
* @return smaller = {@code 0}, equal = {@code 1}, bigger = {@code 2}
* @throws IncompatibleVersioningSystemException when this versioning system does not support comparing with another versioning system
* @since 1-alpha1
* @since v1-alpha1
*/
@Range(from = 0, to = 2)
int compare(@NotNull VersioningSystem version) throws IncompatibleVersioningSystemException;

16
base/src/main/java/de/staropensource/sosengine/base/classes/helpers/EventHelper.java
View file

@ -43,7 +43,7 @@ import java.util.Set;
/**
* Represents an event.
*
* @since 1-alpha0
* @since v1-alpha0
*/
@Getter
@SuppressWarnings({ "unused" })
@ -51,7 +51,7 @@ public class EventHelper {
/**
* Contains all cached event listeners.
*
* @since 1-alpha0
* @since v1-alpha0
*/
private static final HashMap<@NotNull Class<? extends Event>, LinkedList<@NotNull Method>> cachedEventListeners = new HashMap<>();
@ -65,7 +65,7 @@ public class EventHelper {
*
* @param clazz event class
* @param arguments arguments passed to event listeners
* @since 1-alpha0
* @since v1-alpha0
*/
public static void logCall(@NotNull Class<? extends Event> clazz, @NotNull Object ... arguments) {
// Print event call if event debugging is enabled
@ -82,7 +82,7 @@ public class EventHelper {
* @param clazz event class
* @param forceScanning forces the method to ignore cached event listeners, not recommended
* @return list of annotated methods
* @since 1-alpha0
* @since v1-alpha0
*/
@NotNull
public static LinkedList<Method> getAnnotatedMethods(@NotNull Class<? extends Event> clazz, boolean forceScanning) {
@ -119,7 +119,7 @@ public class EventHelper {
*
* @param clazz event class
* @return list of annotated methods
* @since 1-alpha0
* @since v1-alpha0
*/
@NotNull
public static LinkedList<Method> getAnnotatedMethods(@NotNull Class<? extends Event> clazz) {
@ -130,7 +130,7 @@ public class EventHelper {
* Invokes all matching event listeners without any arguments.
*
* @param clazz event class
* @since 1-alpha0
* @since v1-alpha0
*/
public static void invokeAnnotatedMethods(@NotNull Class<? extends Event> clazz) {
Runnable eventCode = () -> {
@ -156,7 +156,7 @@ public class EventHelper {
* Will recompute all event listeners if the specified event is already cached.
*
* @param clazz event listeners to (p)recompute, set to {@code null} to recompute all cached events
* @since 1-alpha0
* @since v1-alpha0
*/
public static synchronized void precomputeEventListeners(@Nullable Class<? extends Event> clazz) {
if (clazz == null)
@ -176,7 +176,7 @@ public class EventHelper {
* Removes events from the event listener cache.
*
* @param clazz event class to remove cached event listeners for or {@code null} to remove all cached event listeners
* @since 1-alpha0
* @since v1-alpha0
*/
public static synchronized void removePrecomputedEventListeners(@Nullable Class<? extends Event> clazz) {
if (clazz == null)

2
base/src/main/java/de/staropensource/sosengine/base/classes/helpers/package-info.java
View file

@ -21,6 +21,6 @@
* Not necessarily interfaces or extendable classes. Rather, they
* support implementing classes by providing useful or complex code.
*
* @since 1-alpha0
* @since v1-alpha0
*/
package de.staropensource.sosengine.base.classes.helpers;

2
base/src/main/java/de/staropensource/sosengine/base/classes/package-info.java
View file

@ -20,6 +20,6 @@
/**
* Contains various interfaces and abstract classes.
*
* @since 1-alpha0
* @since v1-alpha0
*/
package de.staropensource.sosengine.base.classes;

92
base/src/main/java/de/staropensource/sosengine/base/data/info/EngineInformation.java
View file

@ -45,13 +45,13 @@ public final class EngineInformation {
/**
* Provides the engine's version.
*
* @since 1-alpha0
* @since v1-alpha0
*
* -- GETTER --
* Provides the engine's version.
*
* @return engine version
* @since 1-alpha0
* @since v1-alpha0
*/
@Getter
private static int versioningVersion;
@ -59,13 +59,13 @@ public final class EngineInformation {
/**
* Provides the engine's version type.
*
* @since 1-alpha0
* @since v1-alpha0
*
* -- GETTER --
* Provides the engine's version type.
*
* @return engine version type
* @since 1-alpha0
* @since v1-alpha0
*/
@Getter
private static VersionType versioningType;
@ -73,13 +73,13 @@ public final class EngineInformation {
/**
* Provides the engine's type release.
*
* @since 1-alpha0
* @since v1-alpha0
*
* -- GETTER --
* Provides the engine's type release.
*
* @return engine type release
* @since 1-alpha0
* @since v1-alpha0
*/
@Getter
private static int versioningTyperelease;
@ -88,14 +88,14 @@ public final class EngineInformation {
* Provides the engine's fork identifier.<br/>
* Likely empty. If not, it must be prefixed with a dash.
*
* @since 1-alpha0
* @since v1-alpha0
*
* -- GETTER --
* Provides the engine's fork identifier.<br/>
* Likely empty. If not, it must be prefixed with a dash.
*
* @return engine fork identifier
* @since 1-alpha0
* @since v1-alpha0
*/
@Getter
private static String versioningFork;
@ -103,13 +103,13 @@ public final class EngineInformation {
/**
* Provides the engine's full version string.
*
* @since 1-alpha1
* @since v1-alpha1
*
* -- GETTER --
* Provides the engine's full version string.
*
* @return engine version string
* @since 1-alpha1
* @since v1-alpha1
*/
@Getter
private static String versioningString;
@ -118,13 +118,13 @@ public final class EngineInformation {
/**
* Provides the {@code dirty} value (i.e. if the source tree has been modified).
*
* @since 1-alpha1
* @since v1-alpha1
*
* -- GETTER --
* Provides the {@code dirty} value (i.e. if the source tree has been modified).
*
* @return git dirty value
* @since 1-alpha1
* @since v1-alpha1
*/
@Getter
private static Boolean gitDirty;
@ -132,13 +132,13 @@ public final class EngineInformation {
/**
* Provides the branch the engine was built on.
*
* @since 1-alpha1
* @since v1-alpha1
*
* -- GETTER --
* Provides the branch the engine was built on.
*
* @return git branch
* @since 1-alpha1
* @since v1-alpha1
*/
@Getter
private static String gitBranch;
@ -146,13 +146,13 @@ public final class EngineInformation {
/**
* Provides the commit count.
*
* @since 1-alpha1
* @since v1-alpha1
*
* -- GETTER --
* Provides the commit count.
*
* @return git commit count
* @since 1-alpha1
* @since v1-alpha1
*/
@Getter
private static int gitCommitCount;
@ -160,13 +160,13 @@ public final class EngineInformation {
/**
* Provides the commit identifier (short form).
*
* @since 1-alpha1
* @since v1-alpha1
*
* -- GETTER --
* Provides the commit identifier (short form).
*
* @return git long commit id
* @since 1-alpha1
* @since v1-alpha1
*/
@Getter
private static String gitCommitIdentifierShort;
@ -174,13 +174,13 @@ public final class EngineInformation {
/**
* Provides the commit identifier (long form).
*
* @since 1-alpha1
* @since v1-alpha1
*
* -- GETTER --
* Provides the commit identifier (long form).
*
* @return git long commit id
* @since 1-alpha1
* @since v1-alpha1
*/
@Getter
private static String gitCommitIdentifierLong;
@ -188,13 +188,13 @@ public final class EngineInformation {
/**
* Provides the commit header.
*
* @since 1-alpha1
* @since v1-alpha1
*
* -- GETTER --
* Provides the commit header.
*
* @return git commit header
* @since 1-alpha1
* @since v1-alpha1
*/
@Getter
private static String gitCommitHeader;
@ -202,13 +202,13 @@ public final class EngineInformation {
/**
* Provides the commit time.
*
* @since 1-alpha1
* @since v1-alpha1
*
* -- GETTER --
* Provides the commit time.
*
* @return git commit time
* @since 1-alpha1
* @since v1-alpha1
*/
@Getter
private static ZonedDateTime gitCommitTime;
@ -216,13 +216,13 @@ public final class EngineInformation {
/**
* Provides the commiter's name.
*
* @since 1-alpha1
* @since v1-alpha1
*
* -- GETTER --
* Provides the commiter's name.
*
* @return git committer name
* @since 1-alpha1
* @since v1-alpha1
*/
@Getter
private static String gitCommitterName;
@ -230,13 +230,13 @@ public final class EngineInformation {
/**
* Provides the commiter's email.
*
* @since 1-alpha1
* @since v1-alpha1
*
* -- GETTER --
* Provides the commiter's email.
*
* @return git committer email
* @since 1-alpha1
* @since v1-alpha1
*/
@Getter
private static String gitCommitterEmail;
@ -245,13 +245,13 @@ public final class EngineInformation {
/**
* Provides the version of the dependency {@code Lombok}.
*
* @since 1-alpha0
* @since v1-alpha0
*
* -- GETTER --
* Provides the version of the dependency {@code Lombok}.
*
* @return Lombok dependency version
* @since 1-alpha0
* @since v1-alpha0
*/
@Getter
private static String dependencyLombok;
@ -259,13 +259,13 @@ public final class EngineInformation {
/**
* Provides the version of the dependency {@code Jetbrains Annotations}.
*
* @since 1-alpha0
* @since v1-alpha0
*
* -- GETTER --
* Provides the version of the dependency {@code Jetbrains Annotations}.
*
* @return Jetbrains Annotations dependency version
* @since 1-alpha0
* @since v1-alpha0
*/
@Getter
private static String dependencyJetbrainsAnnotations;
@ -273,13 +273,13 @@ public final class EngineInformation {
/**
* Provides the version of the dependency {@code Jansi}.
*
* @since 1-alpha0
* @since v1-alpha0
*
* -- GETTER --
* Provides the version of the dependency {@code Jansi}.
*
* @return Jansi dependency version
* @since 1-alpha0
* @since v1-alpha0
*/
@Getter
private static String dependencyJansi;
@ -287,13 +287,13 @@ public final class EngineInformation {
/**
* Provides the version of the dependency {@code Reflections}.
*
* @since 1-alpha0
* @since v1-alpha0
*
* -- GETTER --
* Provides the version of the dependency {@code Reflections}.
*
* @return Reflections dependency version
* @since 1-alpha0
* @since v1-alpha0
*/
@Getter
private static String dependencyReflections;
@ -301,13 +301,13 @@ public final class EngineInformation {
/**
* Provides the version of the dependency {@code SLF4J}.
*
* @since 1-alpha0
* @since v1-alpha0
*
* -- GETTER --
* Provides the version of the dependency {@code SLF4J}.
*
* @return SLF4J dependency version
* @since 1-alpha0
* @since v1-alpha0
*/
@Getter
private static String dependencySlf4j;
@ -315,13 +315,13 @@ public final class EngineInformation {
/**
* Provides the version of the dependency {@code LWJGL}.
*
* @since 1-alpha0
* @since v1-alpha0
*
* -- GETTER --
* Provides the version of the dependency {@code LWJGL}.
*
* @return LWJGL dependency version
* @since 1-alpha0
* @since v1-alpha0
*/
@Getter
private static String dependencyLwjgl;
@ -329,13 +329,13 @@ public final class EngineInformation {
/**
* Provides the version of the Gradle plugin {@code Shadow}.
*
* @since 1-alpha0
* @since v1-alpha0
*
* -- GETTER --
* Provides the version of the Gradle plugin {@code Shadow}.
*
* @return Shadow plugin version
* @since 1-alpha0
* @since v1-alpha0
*/
@Getter
private static String pluginShadow;
@ -343,13 +343,13 @@ public final class EngineInformation {
/**
* Provides the version of the Gradle plugin {@code Lombok}.
*
* @since 1-alpha0
* @since v1-alpha0
*
* -- GETTER --
* Provides the version of the Gradle plugin {@code Lombok}.
*
* @return Lombok plugin version
* @since 1-alpha0
* @since v1-alpha0
*/
@Getter
private static String pluginLombok;
@ -357,14 +357,14 @@ public final class EngineInformation {
/**
* Constructs this class.
*
* @since 1-alpha0
* @since v1-alpha0
*/
public EngineInformation() {}
/**
* Updates all variables.
*
* @since 1-alpha1
* @since v1-alpha1
*/
public static synchronized void updateVariables() {
LoggerInstance logger = new LoggerInstance(new LogIssuer(EngineInformation.class, CodePart.ENGINE));

28
base/src/main/java/de/staropensource/sosengine/base/data/info/JvmInformation.java
View file

@ -36,7 +36,7 @@ public final class JvmInformation {
/**
* Constructs this class.
*
* @since 1-alpha0
* @since v1-alpha0
*/
public JvmInformation() {}
@ -45,7 +45,7 @@ public final class JvmInformation {
*
* @return the Java version
* @throws NumberFormatException if the version could not be converted into an int
* @since 1-alpha0
* @since v1-alpha0
*/
public static int getJavaVersion() throws NumberFormatException {
String version = System.getProperty("java.version");
@ -69,7 +69,7 @@ public final class JvmInformation {
* Returns the JVM implementation name.
*
* @return the JVM implementation name
* @since 1-alpha0
* @since v1-alpha0
*/
@NotNull
public static String getImplementationName() {
@ -80,7 +80,7 @@ public final class JvmInformation {
* Returns the JVM implementation version.
*
* @return the JVM implementation version
* @since 1-alpha0
* @since v1-alpha0
*/
@NotNull
public static String getImplementationVersion() {
@ -91,7 +91,7 @@ public final class JvmInformation {
* Returns the JVM implementation vendor.
*
* @return the JVM implementation vendor
* @since 1-alpha0
* @since v1-alpha0
*/
@NotNull
public static String getImplementationVendor() {
@ -102,7 +102,7 @@ public final class JvmInformation {
* Returns the uptime of the JVM.
*
* @return uptime in milliseconds
* @since 1-alpha0
* @since v1-alpha0
*/
public static long getUptime() {
return ManagementFactory.getRuntimeMXBean().getUptime();
@ -112,7 +112,7 @@ public final class JvmInformation {
* Returns the arguments passed to the JVM (not to the running program).
*
* @return the JVM arguments
* @since 1-alpha0
* @since v1-alpha0
*/
@NotNull
public static List<@NotNull String> getArguments() {
@ -125,7 +125,7 @@ public final class JvmInformation {
* Note: This is an estimate.
*
* @return estimated total amount of used memory
* @since 1-alpha1
* @since v1-alpha1
*/
public static long getMemoryTotal() {
return Runtime.getRuntime().totalMemory();
@ -135,7 +135,7 @@ public final class JvmInformation {
* Returns the maximum amount of memory usable by the running application.
*
* @return maximum amount of usable memory
* @since 1-alpha1
* @since v1-alpha1
*/
public static long getMemoryMax() {
return Runtime.getRuntime().maxMemory();
@ -145,7 +145,7 @@ public final class JvmInformation {
* Returns the amount of free memory available to the running application.
*
* @return amount of free memory
* @since 1-alpha1
* @since v1-alpha1
*/
public static long getMemoryFree() {
return Runtime.getRuntime().freeMemory();
@ -155,7 +155,7 @@ public final class JvmInformation {
* Returns the amount of memory used by the running application.
*
* @return amount of used memory
* @since 1-alpha1
* @since v1-alpha1
*/
public static long getMemoryUsed() {
return getMemoryMax() - getMemoryFree();
@ -165,7 +165,7 @@ public final class JvmInformation {
* Returns the memory usage of the heap.
*
* @return heap usage
* @since 1-alpha1
* @since v1-alpha1
*/
public static MemoryUsage getMemoryHeap() {
return ManagementFactory.getMemoryMXBean().getHeapMemoryUsage();
@ -175,7 +175,7 @@ public final class JvmInformation {
* Returns the memory usage of the stack.
*
* @return stack usage
* @since 1-alpha1
* @since v1-alpha1
*/
public static MemoryUsage getMemoryStack() {
return ManagementFactory.getMemoryMXBean().getNonHeapMemoryUsage();
@ -190,7 +190,7 @@ public final class JvmInformation {
* resources accordingly.
*
* @return amount of available processors
* @since 1-alpha1
* @since v1-alpha1
*/
public static int getAvailableProcessors() {
return Runtime.getRuntime().availableProcessors();

2
base/src/main/java/de/staropensource/sosengine/base/data/info/package-info.java
View file

@ -20,6 +20,6 @@
/**
* Provides various classes that can be used to retrieve information about the engine or JVM.
*
* @since 1-alpha0
* @since v1-alpha0
*/
package de.staropensource.sosengine.base.data.info;

2
base/src/main/java/de/staropensource/sosengine/base/data/package-info.java
View file

@ -20,6 +20,6 @@
/**
* Contains various packages with tiny classes that provide or process information.
*
* @since 1-alpha0
* @since v1-alpha0
*/
package de.staropensource.sosengine.base.data;

18
base/src/main/java/de/staropensource/sosengine/base/data/versioning/FourNumberVersioningSystem.java
View file

@ -30,7 +30,7 @@ import org.jetbrains.annotations.Range;
/**
* Represents a four-numbered versioning system, where an application or work is versioning by four arbitrary numbers.
*
* @since 1-alpha1
* @since v1-alpha1
*/
@SuppressWarnings({ "unused", "JavadocDeclaration", "JavadocBlankLines" })
@Getter
@ -38,52 +38,52 @@ public final class FourNumberVersioningSystem implements VersioningSystem {
/**
* Contains the 1. number vector.
*
* @since 1-alpha1
* @since v1-alpha1
*
* -- GETTER --
* Returns the 1. number vector.
*
* @return 1. number vector
* @since 1-alpha1
* @since v1-alpha1
*/
private final int number1;
/**
* Contains the 2. number vector.
*
* @since 1-alpha1
* @since v1-alpha1
*
* -- GETTER --
* Returns the 2. number vector.
*
* @return 2. number vector
* @since 1-alpha1
* @since v1-alpha1
*/
private final int number2;
/**
* Contains the 3. number vector.
*
* @since 1-alpha1
* @since v1-alpha1
*
* -- GETTER --
* Returns the 3. number vector.
*
* @return 3. number vector
* @since 1-alpha1
* @since v1-alpha1
*/
private final int number3;
/**
* Contains the 4. number vector.
*
* @since 1-alpha1
* @since v1-alpha1
*
* -- GETTER --
* Returns the 4. number vector.
*
* @return 4. number vector
* @since 1-alpha1
* @since v1-alpha1
*/
private final int number4;

6
base/src/main/java/de/staropensource/sosengine/base/data/versioning/OneNumberVersioningSystem.java
View file

@ -29,7 +29,7 @@ import org.jetbrains.annotations.Range;
/**
* Represents a two-numbered versioning system, where an application or work is versioning by two arbitrary numbers.
*
* @since 1-alpha1
* @since v1-alpha1
*/
@SuppressWarnings({ "unused", "JavadocDeclaration", "JavadocBlankLines" })
@Getter
@ -37,13 +37,13 @@ public final class OneNumberVersioningSystem implements VersioningSystem {
/**
* Contains the number vector.
*
* @since 1-alpha1
* @since v1-alpha1
*
* -- GETTER --
* Returns the number vector.
*
* @return number vector
* @since 1-alpha1
* @since v1-alpha1
*/
private final int number;

22
base/src/main/java/de/staropensource/sosengine/base/data/versioning/SemanticVersioningSystem.java
View file

@ -35,7 +35,7 @@ import java.util.List;
/**
* Represents the semantic versioning system (version 2.0.0), where an application or work is versioning by a MAJOR version, a MINOR version, a PATCH version and optionally, a pre-release vector and a build number.
*
* @since 1-alpha1
* @since v1-alpha1
*/
@SuppressWarnings({ "unused", "JavadocDeclaration", "JavadocBlankLines" })
@Getter
@ -43,52 +43,52 @@ public final class SemanticVersioningSystem implements VersioningSystem {
/**
* Contains the MAJOR vector.
*
* @since 1-alpha1
* @since v1-alpha1
*
* -- GETTER --
* Returns the MAJOR vector.
*
* @return MAJOR vector
* @since 1-alpha1
* @since v1-alpha1
*/
private final int major;
/**
* Contains the MINOR vector.
*
* @since 1-alpha1
* @since v1-alpha1
*
* -- GETTER --
* Returns the MINOR vector.
*
* @return MINOR vector
* @since 1-alpha1
* @since v1-alpha1
*/
private final int minor;
/**
* Contains the PATCH vector.
*
* @since 1-alpha1
* @since v1-alpha1
*
* -- GETTER --
* Returns the PATCH vector.
*
* @return PATCH vector
* @since 1-alpha1
* @since v1-alpha1
*/
private final int patch;
/**
* Contains the PRERELEASE vector.
*
* @since 1-alpha1
* @since v1-alpha1
*
* -- GETTER --
* Returns the PRERELEASE vector.
*
* @return PRERELEASE vector
* @since 1-alpha1
* @since v1-alpha1
*/
@Nullable
private final String prerelease;
@ -96,13 +96,13 @@ public final class SemanticVersioningSystem implements VersioningSystem {
/**
* Contains the BUILD vector.
*
* @since 1-alpha1
* @since v1-alpha1
*
* -- GETTER --
* Returns the BUILD vector.
*
* @return BUILD vector
* @since 1-alpha1
* @since v1-alpha1
*/
private final int build;

22
base/src/main/java/de/staropensource/sosengine/base/data/versioning/StarOpenSourceVersioningSystem.java
View file

@ -35,7 +35,7 @@ import java.util.Locale;
/**
* Represents the StarOpenSource versioning system (version 2), where an application or work is versioning by a VERSION vector, a TYPE version type, a TYPERELEASE vector and optionally, a fork vector and a companion vector.
*
* @since 1-alpha1
* @since v1-alpha1
*/
@SuppressWarnings({ "unused", "JavadocDeclaration", "JavadocBlankLines" })
@Getter
@ -43,52 +43,52 @@ public final class StarOpenSourceVersioningSystem implements VersioningSystem {
/**
* Contains the VERSION vector.
*
* @since 1-alpha1
* @since v1-alpha1
*
* -- GETTER --
* Returns the VERSION vector.
*
* @return VERSION vector
* @since 1-alpha1
* @since v1-alpha1
*/
private final int version;
/**
* Contains the TYPE vector.
*
* @since 1-alpha1
* @since v1-alpha1
*
* -- GETTER --
* Returns the TYPE vector.
*
* @return TYPE vector
* @since 1-alpha1
* @since v1-alpha1
*/
private final VersionType type;
/**
* Contains the TYPERELEASE vector.
*
* @since 1-alpha1
* @since v1-alpha1
*
* -- GETTER --
* Returns the TYPERELEASE vector.
*
* @return TYPERELEASE vector
* @since 1-alpha1
* @since v1-alpha1
*/
private final int typerelease;
/**
* Contains the COMPANION vector.
*
* @since 1-alpha1
* @since v1-alpha1
*
* -- GETTER --
* Returns the COMPANION vector.
*
* @return COMPANION vector
* @since 1-alpha1
* @since v1-alpha1
*/
@Nullable
private final String companion;
@ -96,13 +96,13 @@ public final class StarOpenSourceVersioningSystem implements VersioningSystem {
/**
* Contains the FORK vector.
*
* @since 1-alpha1
* @since v1-alpha1
*
* -- GETTER --
* Returns the FORK vector.
*
* @return FORK vector
* @since 1-alpha1
* @since v1-alpha1
*/
private final String fork;

14
base/src/main/java/de/staropensource/sosengine/base/data/versioning/ThreeNumberVersioningSystem.java
View file

@ -30,7 +30,7 @@ import org.jetbrains.annotations.Range;
/**
* Represents a three-numbered versioning system, where an application or work is versioning by three arbitrary numbers.
*
* @since 1-alpha1
* @since v1-alpha1
*/
@SuppressWarnings({ "unused", "JavadocDeclaration", "JavadocBlankLines" })
@Getter
@ -38,39 +38,39 @@ public final class ThreeNumberVersioningSystem implements VersioningSystem {
/**
* Contains the 1. number vector.
*
* @since 1-alpha1
* @since v1-alpha1
*
* -- GETTER --
* Returns the 1. number vector.
*
* @return 1. number vector
* @since 1-alpha1
* @since v1-alpha1
*/
private final int number1;
/**
* Contains the 2. number vector.
*
* @since 1-alpha1
* @since v1-alpha1
*
* -- GETTER --
* Returns the 2. number vector.
*
* @return 2. number vector
* @since 1-alpha1
* @since v1-alpha1
*/
private final int number2;
/**
* Contains the 3. number vector.
*
* @since 1-alpha1
* @since v1-alpha1
*
* -- GETTER --
* Returns the 3. number vector.
*
* @return 3. number vector
* @since 1-alpha1
* @since v1-alpha1
*/
private final int number3;

10
base/src/main/java/de/staropensource/sosengine/base/data/versioning/TwoNumberVersioningSystem.java
View file

@ -30,7 +30,7 @@ import org.jetbrains.annotations.Range;
/**
* Represents a two-numbered versioning system, where an application or work is versioning by two arbitrary numbers.
*
* @since 1-alpha1
* @since v1-alpha1
*/
@SuppressWarnings({ "unused", "JavadocDeclaration", "JavadocBlankLines" })
@Getter
@ -38,26 +38,26 @@ public final class TwoNumberVersioningSystem implements VersioningSystem {
/**
* Contains the 1. number vector.
*
* @since 1-alpha1
* @since v1-alpha1
*
* -- GETTER --
* Returns the 1. number vector.
*
* @return 1. number vector
* @since 1-alpha1
* @since v1-alpha1
*/
private final int number1;
/**
* Contains the 2. number vector.
*
* @since 1-alpha1
* @since v1-alpha1
*
* -- GETTER --
* Returns the 2. number vector.
*
* @return 2. number vector
* @since 1-alpha1
* @since v1-alpha1
*/
private final int number2;

2
base/src/main/java/de/staropensource/sosengine/base/data/versioning/package-info.java
View file

@ -21,6 +21,6 @@
* Contains built-in versioning systems that
* can be used to represent versions of some work.
*
* @since 1-alpha1
* @since v1-alpha1
*/
package de.staropensource.sosengine.base.data.versioning;

2
base/src/main/java/de/staropensource/sosengine/base/events/EngineCrashEvent.java
View file

@ -25,7 +25,7 @@ import de.staropensource.sosengine.base.classes.helpers.EventHelper;
/**
* Called in the event of an engine crash, just before the JVM exists.
*
* @since 1-alpha0
* @since v1-alpha0
*/
@SuppressWarnings({ "unused" })
public final class EngineCrashEvent implements Event {

2
base/src/main/java/de/staropensource/sosengine/base/events/EngineShutdownEvent.java
View file

@ -25,7 +25,7 @@ import de.staropensource.sosengine.base.classes.helpers.EventHelper;
/**
* Called when the engine and JVM are about to shutdown.
*
* @since 1-alpha0
* @since v1-alpha0
*/
public final class EngineShutdownEvent implements Event {
/**

2
base/src/main/java/de/staropensource/sosengine/base/events/EngineSoftCrashEvent.java
View file

@ -26,7 +26,7 @@ import de.staropensource.sosengine.base.classes.helpers.EventHelper;
* Called in the event of a soft engine crash
* ie. a crash which was declared as handled.
*
* @since 1-alpha0
* @since v1-alpha0
*/
@SuppressWarnings({ "unused" })
public final class EngineSoftCrashEvent implements Event {

4
base/src/main/java/de/staropensource/sosengine/base/events/LogEvent.java
View file

@ -32,7 +32,7 @@ import java.lang.reflect.Method;
/**
* Called before a new log message is printed.
*
* @since 1-alpha0
* @since v1-alpha0
*/
@SuppressWarnings({ "unused" })
public final class LogEvent implements Event {
@ -56,7 +56,7 @@ public final class LogEvent implements Event {
* @param level log level
* @param logIssuer log issuer
* @param message log message
* @since 1-alpha0
* @since v1-alpha0
*/
public void callEvent(@NotNull LogLevel level, @NotNull LogIssuer logIssuer, @NotNull String message) {
Runnable eventCode = Thread.ofVirtual().start(() -> {

4
base/src/main/java/de/staropensource/sosengine/base/events/ThrowableCatchEvent.java
View file

@ -32,7 +32,7 @@ import java.lang.reflect.Method;
* Called when an exception is caught.
*
* @see Miscellaneous#executeSafely(Runnable, String)
* @since 1-alpha0
* @since v1-alpha0
*/
public final class ThrowableCatchEvent implements Event {
/**
@ -54,7 +54,7 @@ public final class ThrowableCatchEvent implements Event {
*
* @param throwable caught throwable
* @param identifier an identifier given to the runnable
* @since 1-alpha0
* @since v1-alpha0
*/
public void callEvent(@NotNull Throwable throwable, @NotNull String identifier) {
Runnable eventCode = Thread.ofVirtual().start(() -> {

2
base/src/main/java/de/staropensource/sosengine/base/events/package-info.java
View file

@ -20,6 +20,6 @@
/**
* Contains events. There's nothing more to say.
*
* @since 1-alpha1
* @since v1-alpha1
*/
package de.staropensource.sosengine.base.events;

4
base/src/main/java/de/staropensource/sosengine/base/exceptions/DependencyCycleException.java
View file

@ -24,7 +24,7 @@ import org.jetbrains.annotations.NotNull;
/**
* Represents an exception caused by a dependency cycle.
*
* @since 1-alpha1
* @since v1-alpha1
*/
@SuppressWarnings({ "unused" })
public class DependencyCycleException extends Exception {
@ -32,7 +32,7 @@ public class DependencyCycleException extends Exception {
* Constructs this exception.
*
* @param path cycle path
* @since 1-alpha1
* @since v1-alpha1
*/
public DependencyCycleException(@NotNull String path) {
super("Dependency cycle detected: " + path);

4
base/src/main/java/de/staropensource/sosengine/base/exceptions/IncompatibleVersioningSystemException.java
View file

@ -24,7 +24,7 @@ import de.staropensource.sosengine.base.classes.VersioningSystem;
/**
* Represents an exception caused by supplying an invalid or unexpected versioning system.
*
* @since 1-alpha1
* @since v1-alpha1
*/
@SuppressWarnings({ "unused" })
public class IncompatibleVersioningSystemException extends Exception {
@ -33,7 +33,7 @@ public class IncompatibleVersioningSystemException extends Exception {
*
* @param required required versioning system ie. the versioning system throwing this error
* @param found found versioning system ie. the incompatible one
* @since 1-alpha1
* @since v1-alpha1
*/
public IncompatibleVersioningSystemException(VersioningSystem required, VersioningSystem found) {
super("The versioning system " + required + " is incompatible with " + found);

14
base/src/main/java/de/staropensource/sosengine/base/exceptions/InvalidVersionStringException.java
View file

@ -28,7 +28,7 @@ import org.jetbrains.annotations.Nullable;
/**
* Represents an exception caused by an invalid version string.
*
* @since 1-alpha1
* @since v1-alpha1
*/
@Getter
@SuppressWarnings({ "unused", "JavadocDeclaration", "JavadocBlankLines" })
@ -36,13 +36,13 @@ public class InvalidVersionStringException extends Exception {
/**
* Contains the throwable supplied to the constructor.
*
* @since 1-alpha1
* @since v1-alpha1
*
* -- GETTER --
* Returns the throwable supplied by the constructor.
*
* @return throwable
* @since 1-alpha1
* @since v1-alpha1
*/
@Nullable
private final Throwable throwable;
@ -54,7 +54,7 @@ public class InvalidVersionStringException extends Exception {
* @param versionString version string {@code a}
* @param message some error message
* @param throwable throwable that caused the parsing error
* @since 1-alpha1
* @since v1-alpha1
*/
public InvalidVersionStringException(@NotNull VersioningSystem versioningSystem, @NotNull String versionString, @NotNull String message, @NotNull Throwable throwable) {
super("Versioning system " + versioningSystem.getName() + " can't parse version string \"" + versionString + "\": " + message);
@ -67,7 +67,7 @@ public class InvalidVersionStringException extends Exception {
* @param versioningSystem versioning system that is unable to parse version strings
* @param versionString version string {@code a}
* @param message some error message
* @since 1-alpha1
* @since v1-alpha1
*/
public InvalidVersionStringException(@NotNull VersioningSystem versioningSystem, @NotNull String versionString, @NotNull String message) {
super("Versioning system " + versioningSystem.getName() + " can't parse version string \"" + versionString + "\": " + message);
@ -80,7 +80,7 @@ public class InvalidVersionStringException extends Exception {
* @param versioningSystem versioning system that is unable to parse version strings
* @param versionString version string {@code a}
* @param throwable throwable that caused the parsing error
* @since 1-alpha1
* @since v1-alpha1
*/
public InvalidVersionStringException(@NotNull VersioningSystem versioningSystem, @NotNull String versionString, @NotNull Throwable throwable) {
super("Versioning system " + versioningSystem.getName() + " can't parse version string \"" + versionString + "\"");
@ -92,7 +92,7 @@ public class InvalidVersionStringException extends Exception {
*
* @param versioningSystem versioning system that is unable to parse version strings
* @param versionString version string {@code a}
* @since 1-alpha1
* @since v1-alpha1
*/
public InvalidVersionStringException(@NotNull VersioningSystem versioningSystem, @NotNull String versionString) {
super("Versioning system " + versioningSystem.getName() + " can't parse version string \"" + versionString + "\"");

6
base/src/main/java/de/staropensource/sosengine/base/exceptions/UnexpectedThrowableException.java
View file

@ -27,7 +27,7 @@ import org.jetbrains.annotations.Nullable;
* Represents an exception caused by some throwable.
* Basic wrapper for every throwable there is.
*
* @since 1-alpha1
* @since v1-alpha1
*/
@SuppressWarnings({ "unused", "JavadocDeclaration", "JavadocBlankLines" })
@Getter
@ -35,13 +35,13 @@ public class UnexpectedThrowableException extends Exception {
/**
* Contains the throwable supplied to the constructor.
*
* @since 1-alpha1
* @since v1-alpha1
*
* -- GETTER --
* Returns the throwable supplied by the constructor.
*
* @return throwable
* @since 1-alpha1
* @since v1-alpha1
*/
@Nullable
Throwable throwable;

8
base/src/main/java/de/staropensource/sosengine/base/exceptions/UnmetDependenciesException.java
View file

@ -28,7 +28,7 @@ import java.util.Map;
/**
* Represents an exception caused by unmet dependencies.
*
* @since 1-alpha1
* @since v1-alpha1
*/
@SuppressWarnings({ "unused", "JavadocDeclaration", "JavadocBlankLines" })
@Getter
@ -39,7 +39,7 @@ public class UnmetDependenciesException extends Exception {
* The key contains the {@link DependencyVector} that has unmet dependencies,
* while the value contains the error string ie. which dependency is unmet and why.
*
* @since 1-alpha1
* @since v1-alpha1
*
* -- GETTER --
* Returns the unmet dependencies list supplied to the constructor.
@ -48,7 +48,7 @@ public class UnmetDependenciesException extends Exception {
* while the value contains the error string ie. which dependency is unmet and why.
*
* @return unmet dependencies list
* @since 1-alpha1
* @since v1-alpha1
*/
@NotNull
private final Map<@NotNull DependencyVector, @NotNull String> unmetDependencies;
@ -57,7 +57,7 @@ public class UnmetDependenciesException extends Exception {
* Constructs this exception.
*
* @param unmetDependencies map of unmet dependencies
* @since 1-alpha1
* @since v1-alpha1
* @see UnmetDependenciesException#unmetDependencies
*/
public UnmetDependenciesException(@NotNull Map<@NotNull DependencyVector, @NotNull String> unmetDependencies) {

2
base/src/main/java/de/staropensource/sosengine/base/exceptions/package-info.java
View file

@ -20,6 +20,6 @@
/**
* Contains exceptions thrown by the engine.
*
* @since 1-alpha1
* @since v1-alpha1
*/
package de.staropensource.sosengine.base.exceptions;

2
base/src/main/java/de/staropensource/sosengine/base/internal/events/InternalEngineShutdownEvent.java
View file

@ -25,7 +25,7 @@ import de.staropensource.sosengine.base.classes.helpers.EventHelper;
/**
* Called when the engine and JVM are about to shutdown, after {@link de.staropensource.sosengine.base.events.EngineShutdownEvent}.
*
* @since 1-alpha0
* @since v1-alpha0
*/
public class InternalEngineShutdownEvent implements Event {
/**

2
base/src/main/java/de/staropensource/sosengine/base/internal/package-info.java
View file

@ -20,6 +20,6 @@
/**
* Contains engine-internal stuff, not part of the API.
*
* @since 1-alpha1
* @since v1-alpha1
*/
package de.staropensource.sosengine.base.internal;

4
base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/DateDay.java
View file

@ -29,14 +29,14 @@ import java.util.Calendar;
* Implements the {@code date_day} placeholder.
*
* @see Placeholder
* @since 1-alpha0
* @since v1-alpha0
*/
@SuppressWarnings({ "unused" })
public final class DateDay implements Placeholder {
/**
* Constructs this class.
*
* @since 1-alpha0
* @since v1-alpha0
*/
public DateDay() {}

4
base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/DateMonth.java
View file

@ -29,14 +29,14 @@ import java.util.Calendar;
* Implements the {@code date_month} placeholder.
*
* @see Placeholder
* @since 1-alpha0
* @since v1-alpha0
*/
@SuppressWarnings({ "unused" })
public final class DateMonth implements Placeholder {
/**
* Constructs this class.
*
* @since 1-alpha0
* @since v1-alpha0
*/
public DateMonth() {}

4
base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/DateYear.java
View file

@ -29,14 +29,14 @@ import java.util.Calendar;
* Implements the {@code date_year} placeholder.
*
* @see Placeholder
* @since 1-alpha0
* @since v1-alpha0
*/
@SuppressWarnings({ "unused" })
public final class DateYear implements Placeholder {
/**
* Constructs this class.
*
* @since 1-alpha0
* @since v1-alpha0
*/
public DateYear() {}

4
base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineDependencyJansi.java
View file

@ -27,14 +27,14 @@ import org.jetbrains.annotations.NotNull;
* Implements the {@code engine_dependency_jansi} placeholder.
*
* @see Placeholder
* @since 1-alpha0
* @since v1-alpha0
*/
@SuppressWarnings({ "unused" })
public final class EngineDependencyJansi implements Placeholder {
/**
* Constructs this class.
*
* @since 1-alpha0
* @since v1-alpha0
*/
public EngineDependencyJansi() {}

4
base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineDependencyJetbrainsAnnotations.java
View file

@ -26,7 +26,7 @@ import org.jetbrains.annotations.NotNull;
/**
* Implements the {@code engine_dependency_jetbrains_annotations} placeholder.
*
* @since 1-alpha0
* @since v1-alpha0
* @see Placeholder
*/
@SuppressWarnings({ "unused" })
@ -34,7 +34,7 @@ public final class EngineDependencyJetbrainsAnnotations implements Placeholder {
/**
* Constructs this class.
*
* @since 1-alpha0
* @since v1-alpha0
*/
public EngineDependencyJetbrainsAnnotations() {}

4
base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineDependencyLombok.java
View file

@ -27,14 +27,14 @@ import org.jetbrains.annotations.NotNull;
* Implements the {@code engine_dependency_lombok} placeholder.
*
* @see Placeholder
* @since 1-alpha0
* @since v1-alpha0
*/
@SuppressWarnings({ "unused" })
public final class EngineDependencyLombok implements Placeholder {
/**
* Constructs this class.
*
* @since 1-alpha0
* @since v1-alpha0
*/
public EngineDependencyLombok() {}

4
base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineDependencyLwjgl.java
View file

@ -27,14 +27,14 @@ import org.jetbrains.annotations.NotNull;
* Implements the {@code engine_dependency_lwjgl} placeholder.
*
* @see Placeholder
* @since 1-alpha0
* @since v1-alpha0
*/
@SuppressWarnings({ "unused" })
public final class EngineDependencyLwjgl implements Placeholder {
/**
* Constructs this class.
*
* @since 1-alpha0
* @since v1-alpha0
*/
public EngineDependencyLwjgl() {}

4
base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineDependencyReflections.java
View file

@ -27,14 +27,14 @@ import org.jetbrains.annotations.NotNull;
* Implements the {@code engine_dependency_reflections} placeholder.
*
* @see Placeholder
* @since 1-alpha0
* @since v1-alpha0
*/
@SuppressWarnings({ "unused" })
public final class EngineDependencyReflections implements Placeholder {
/**
* Constructs this class.
*
* @since 1-alpha0
* @since v1-alpha0
*/
public EngineDependencyReflections() {}

4
base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineDependencySlf4j.java
View file

@ -27,14 +27,14 @@ import org.jetbrains.annotations.NotNull;
* Implements the {@code engine_dependency_slf4j} placeholder.
*
* @see Placeholder
* @since 1-alpha0
* @since v1-alpha0
*/
@SuppressWarnings({ "unused" })
public final class EngineDependencySlf4j implements Placeholder {
/**
* Constructs this class.
*
* @since 1-alpha0
* @since v1-alpha0
*/
public EngineDependencySlf4j() {}

4
base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineGitBranch.java
View file

@ -27,14 +27,14 @@ import org.jetbrains.annotations.NotNull;
* Implements the {@code engine_git_branch} placeholder.
*
* @see Placeholder
* @since 1-alpha0
* @since v1-alpha0
*/
@SuppressWarnings({ "unused" })
public final class EngineGitBranch implements Placeholder {
/**
* Constructs this class.
*
* @since 1-alpha0
* @since v1-alpha0
*/
public EngineGitBranch() {}

4
base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineGitCommitHeader.java
View file

@ -27,14 +27,14 @@ import org.jetbrains.annotations.NotNull;
* Implements the {@code engine_git_commit_header} placeholder.
*
* @see Placeholder
* @since 1-alpha0
* @since v1-alpha0
*/
@SuppressWarnings({ "unused" })
public final class EngineGitCommitHeader implements Placeholder {
/**
* Constructs this class.
*
* @since 1-alpha0
* @since v1-alpha0
*/
public EngineGitCommitHeader() {}

4
base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineGitCommitIdLong.java
View file

@ -27,14 +27,14 @@ import org.jetbrains.annotations.NotNull;
* Implements the {@code engine_git_commit_id_long} placeholder.
*
* @see Placeholder
* @since 1-alpha0
* @since v1-alpha0
*/
@SuppressWarnings({ "unused" })
public final class EngineGitCommitIdLong implements Placeholder {
/**
* Constructs this class.
*
* @since 1-alpha0
* @since v1-alpha0
*/
public EngineGitCommitIdLong() {}

4
base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineGitCommitIdShort.java
View file

@ -27,14 +27,14 @@ import org.jetbrains.annotations.NotNull;
* Implements the {@code engine_git_commit_id_short} placeholder.
*
* @see Placeholder
* @since 1-alpha0
* @since v1-alpha0
*/
@SuppressWarnings({ "unused" })
public final class EngineGitCommitIdShort implements Placeholder {
/**
* Constructs this class.
*
* @since 1-alpha0
* @since v1-alpha0
*/
public EngineGitCommitIdShort() {}

4
base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineGitCommitTimeDay.java
View file

@ -27,14 +27,14 @@ import org.jetbrains.annotations.NotNull;
* Implements the {@code engine_git_commit_time_day} placeholder.
*
* @see Placeholder
* @since 1-alpha0
* @since v1-alpha0
*/
@SuppressWarnings({ "unused" })
public final class EngineGitCommitTimeDay implements Placeholder {
/**
* Constructs this class.
*
* @since 1-alpha0
* @since v1-alpha0
*/
public EngineGitCommitTimeDay() {}

4
base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineGitCommitTimeHour.java
View file

@ -27,14 +27,14 @@ import org.jetbrains.annotations.NotNull;
* Implements the {@code engine_git_commit_time_hour} placeholder.
*
* @see Placeholder
* @since 1-alpha0
* @since v1-alpha0
*/
@SuppressWarnings({ "unused" })
public final class EngineGitCommitTimeHour implements Placeholder {
/**
* Constructs this class.
*
* @since 1-alpha0
* @since v1-alpha0
*/
public EngineGitCommitTimeHour() {}

4
base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineGitCommitTimeMinute.java
View file

@ -27,14 +27,14 @@ import org.jetbrains.annotations.NotNull;
* Implements the {@code engine_git_commit_time_minute} placeholder.
*
* @see Placeholder
* @since 1-alpha0
* @since v1-alpha0
*/
@SuppressWarnings({ "unused" })
public final class EngineGitCommitTimeMinute implements Placeholder {
/**
* Constructs this class.
*
* @since 1-alpha0
* @since v1-alpha0
*/
public EngineGitCommitTimeMinute() {}

4
base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineGitCommitTimeMonth.java
View file

@ -27,14 +27,14 @@ import org.jetbrains.annotations.NotNull;
* Implements the {@code engine_git_commit_time_month} placeholder.
*
* @see Placeholder
* @since 1-alpha0
* @since v1-alpha0
*/
@SuppressWarnings({ "unused" })
public final class EngineGitCommitTimeMonth implements Placeholder {
/**
* Constructs this class.
*
* @since 1-alpha0
* @since v1-alpha0
*/
public EngineGitCommitTimeMonth() {}

4
base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineGitCommitTimeSecond.java
View file

@ -27,14 +27,14 @@ import org.jetbrains.annotations.NotNull;
* Implements the {@code engine_git_commit_time_second} placeholder.
*
* @see Placeholder
* @since 1-alpha0
* @since v1-alpha0
*/
@SuppressWarnings({ "unused" })
public final class EngineGitCommitTimeSecond implements Placeholder {
/**
* Constructs this class.
*
* @since 1-alpha0
* @since v1-alpha0
*/
public EngineGitCommitTimeSecond() {}

4
base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineGitCommitTimeYear.java
View file

@ -27,14 +27,14 @@ import org.jetbrains.annotations.NotNull;
* Implements the {@code engine_git_commit_time_year} placeholder.
*
* @see Placeholder
* @since 1-alpha0
* @since v1-alpha0
*/
@SuppressWarnings({ "unused" })
public final class EngineGitCommitTimeYear implements Placeholder {
/**
* Constructs this class.
*
* @since 1-alpha0
* @since v1-alpha0
*/
public EngineGitCommitTimeYear() {}

4
base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineGitCommits.java
View file

@ -27,14 +27,14 @@ import org.jetbrains.annotations.NotNull;
* Implements the {@code engine_git_commits} placeholder.
*
* @see Placeholder
* @since 1-alpha0
* @since v1-alpha0
*/
@SuppressWarnings({ "unused" })
public final class EngineGitCommits implements Placeholder {
/**
* Constructs this class.
*
* @since 1-alpha0
* @since v1-alpha0
*/
public EngineGitCommits() {}

4
base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineGitCommitterEmail.java
View file

@ -27,14 +27,14 @@ import org.jetbrains.annotations.NotNull;
* Implements the {@code engine_git_committer_email} placeholder.
*
* @see Placeholder
* @since 1-alpha0
* @since v1-alpha0
*/
@SuppressWarnings({ "unused" })
public final class EngineGitCommitterEmail implements Placeholder {
/**
* Constructs this class.
*
* @since 1-alpha0
* @since v1-alpha0
*/
public EngineGitCommitterEmail() {}

4
base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineGitCommitterName.java
View file

@ -27,14 +27,14 @@ import org.jetbrains.annotations.NotNull;
* Implements the {@code engine_git_committer_name} placeholder.
*
* @see Placeholder
* @since 1-alpha0
* @since v1-alpha0
*/
@SuppressWarnings({ "unused" })
public final class EngineGitCommitterName implements Placeholder {
/**
* Constructs this class.
*
* @since 1-alpha0
* @since v1-alpha0
*/
public EngineGitCommitterName() {}

4
base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineGitDirty.java
View file

@ -27,14 +27,14 @@ import org.jetbrains.annotations.NotNull;
* Implements the {@code engine_git_dirty} placeholder.
*
* @see Placeholder
* @since 1-alpha0
* @since v1-alpha0
*/
@SuppressWarnings({ "unused" })
public final class EngineGitDirty implements Placeholder {
/**
* Constructs this class.
*
* @since 1-alpha0
* @since v1-alpha0
*/
public EngineGitDirty() {}

4
base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EnginePluginLombok.java
View file

@ -27,14 +27,14 @@ import org.jetbrains.annotations.NotNull;
* Implements the {@code engine_plugin_lombok} placeholder.
*
* @see Placeholder
* @since 1-alpha0
* @since v1-alpha0
*/
@SuppressWarnings({ "unused" })
public final class EnginePluginLombok implements Placeholder {
/**
* Constructs this class.
*
* @since 1-alpha0
* @since v1-alpha0
*/
public EnginePluginLombok() {}

4
base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EnginePluginShadow.java
View file

@ -27,14 +27,14 @@ import org.jetbrains.annotations.NotNull;
* Implements the {@code engine_plugin_shadow} placeholder.
*
* @see Placeholder
* @since 1-alpha0
* @since v1-alpha0
*/
@SuppressWarnings({ "unused" })
public final class EnginePluginShadow implements Placeholder {
/**
* Constructs this class.
*
* @since 1-alpha0
* @since v1-alpha0
*/
public EnginePluginShadow() {}

4
base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineVersion.java
View file

@ -26,14 +26,14 @@ import org.jetbrains.annotations.NotNull;
* Implements the {@code engine_version} placeholder.
*
* @see Placeholder
* @since 1-alpha0
* @since v1-alpha0
*/
@SuppressWarnings({ "unused" })
public final class EngineVersion implements Placeholder {
/**
* Constructs this class.
*
* @since 1-alpha0
* @since v1-alpha0
*/
public EngineVersion() {}

4
base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineVersionFork.java
View file

@ -27,14 +27,14 @@ import org.jetbrains.annotations.NotNull;
* Implements the {@code engine_version_fork} placeholder.
*
* @see Placeholder
* @since 1-alpha0
* @since v1-alpha0
*/
@SuppressWarnings({ "unused" })
public final class EngineVersionFork implements Placeholder {
/**
* Constructs this class.
*
* @since 1-alpha0
* @since v1-alpha0
*/
public EngineVersionFork() {}

4
base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineVersionType.java
View file

@ -27,14 +27,14 @@ import org.jetbrains.annotations.NotNull;
* Implements the {@code engine_version_type} placeholder.
*
* @see Placeholder
* @since 1-alpha0
* @since v1-alpha0
*/
@SuppressWarnings({ "unused" })
public final class EngineVersionType implements Placeholder {
/**
* Constructs this class.
*
* @since 1-alpha0
* @since v1-alpha0
*/
public EngineVersionType() {}

4
base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineVersionTyperelease.java
View file

@ -27,14 +27,14 @@ import org.jetbrains.annotations.NotNull;
* Implements the {@code engine_version_typerelease} placeholder.
*
* @see Placeholder
* @since 1-alpha0
* @since v1-alpha0
*/
@SuppressWarnings({ "unused" })
public final class EngineVersionTyperelease implements Placeholder {
/**
* Constructs this class.
*
* @since 1-alpha0
* @since v1-alpha0
*/
public EngineVersionTyperelease() {}

4
base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineVersionVersion.java
View file

@ -27,14 +27,14 @@ import org.jetbrains.annotations.NotNull;
* Implements the {@code engine_version_version} placeholder.
*
* @see Placeholder
* @since 1-alpha0
* @since v1-alpha0
*/
@SuppressWarnings({ "unused" })
public final class EngineVersionVersion implements Placeholder {
/**
* Constructs this class.
*
* @since 1-alpha0
* @since v1-alpha0
*/
public EngineVersionVersion() {}

4
base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/JvmArguments.java
View file

@ -27,14 +27,14 @@ import org.jetbrains.annotations.NotNull;
* Implements the {@code jvm_arguments} placeholder.
*
* @see Placeholder
* @since 1-alpha0
* @since v1-alpha0
*/
@SuppressWarnings({ "unused" })
public final class JvmArguments implements Placeholder {
/**
* Constructs this class.
*
* @since 1-alpha0
* @since v1-alpha0
*/
public JvmArguments() {}

4
base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/JvmImplementationName.java
View file

@ -27,14 +27,14 @@ import org.jetbrains.annotations.NotNull;
* Implements the {@code jvm_implementation_name} placeholder.
*
* @see Placeholder
* @since 1-alpha0
* @since v1-alpha0
*/
@SuppressWarnings({ "unused" })
public final class JvmImplementationName implements Placeholder {
/**
* Constructs this class.
*
* @since 1-alpha0
* @since v1-alpha0
*/
public JvmImplementationName() {}

4
base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/JvmImplementationVendor.java
View file

@ -27,14 +27,14 @@ import org.jetbrains.annotations.NotNull;
* Implements the {@code jvm_implementation_vendor} placeholder.
*
* @see Placeholder
* @since 1-alpha0
* @since v1-alpha0
*/
@SuppressWarnings({ "unused" })
public final class JvmImplementationVendor implements Placeholder {
/**
* Constructs this class.
*
* @since 1-alpha0
* @since v1-alpha0
*/
public JvmImplementationVendor() {}

4
base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/JvmImplementationVersion.java
View file

@ -27,14 +27,14 @@ import org.jetbrains.annotations.NotNull;
* Implements the {@code jvm_implementation_version} placeholder.
*
* @see Placeholder
* @since 1-alpha0
* @since v1-alpha0
*/
@SuppressWarnings({ "unused" })
public final class JvmImplementationVersion implements Placeholder {
/**
* Constructs this class.
*
* @since 1-alpha0
* @since v1-alpha0
*/
public JvmImplementationVersion() {}

4
base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/JvmJava.java
View file

@ -27,14 +27,14 @@ import org.jetbrains.annotations.NotNull;
* Implements the {@code jvm_java} placeholder.
*
* @see Placeholder
* @since 1-alpha0
* @since v1-alpha0
*/
@SuppressWarnings({ "unused" })
public final class JvmJava implements Placeholder {
/**
* Constructs this class.
*
* @since 1-alpha0
* @since v1-alpha0
*/
public JvmJava() {}

4
base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/JvmUptime.java
View file

@ -27,14 +27,14 @@ import org.jetbrains.annotations.NotNull;
* Implements the {@code jvm_uptime} placeholder.
*
* @see Placeholder
* @since 1-alpha0
* @since v1-alpha0
*/
@SuppressWarnings({ "unused" })
public final class JvmUptime implements Placeholder {
/**
* Constructs this class.
*
* @since 1-alpha0
* @since v1-alpha0
*/
public JvmUptime() {}

4
base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/TimeEpoch.java
View file

@ -28,14 +28,14 @@ import org.jetbrains.annotations.NotNull;
*
* @see Placeholder
*
* @since 1-alpha0
* @since v1-alpha0
*/
@SuppressWarnings({ "unused" })
public final class TimeEpoch implements Placeholder {
/**
* Constructs this class.
*
* @since 1-alpha0
* @since v1-alpha0
*/
public TimeEpoch() {}

4
base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/TimeHour.java
View file

@ -29,14 +29,14 @@ import java.util.Calendar;
* Implements the {@code time_hour} placeholder.
*
* @see Placeholder
* @since 1-alpha0
* @since v1-alpha0
*/
@SuppressWarnings({ "unused" })
public final class TimeHour implements Placeholder {
/**
* Constructs this class.
*
* @since 1-alpha0
* @since v1-alpha0
*/
public TimeHour() {}

4
base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/TimeMinute.java
View file

@ -29,14 +29,14 @@ import java.util.Calendar;
* Implements the {@code time_minute} placeholder.
*
* @see Placeholder
* @since 1-alpha0
* @since v1-alpha0
*/
@SuppressWarnings({ "unused" })
public final class TimeMinute implements Placeholder {
/**
* Constructs this class.
*
* @since 1-alpha0
* @since v1-alpha0
*/
public TimeMinute() {}

4
base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/TimeSecond.java
View file

@ -29,14 +29,14 @@ import java.util.Calendar;
* Implements the {@code time_second} placeholder.
*
* @see Placeholder
* @since 1-alpha0
* @since v1-alpha0
*/
@SuppressWarnings({ "unused" })
public final class TimeSecond implements Placeholder {
/**
* Constructs this class.
*
* @since 1-alpha0
* @since v1-alpha0
*/
public TimeSecond() {}

4
base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/TimeZone.java
View file

@ -28,14 +28,14 @@ import java.util.Locale;
* Implements the {@code time_zone} placeholder.
*
* @see Placeholder
* @since 1-alpha0
* @since v1-alpha0
*/
@SuppressWarnings({ "unused" })
public final class TimeZone implements Placeholder {
/**
* Constructs this class.
*
* @since 1-alpha0
* @since v1-alpha0
*/
public TimeZone() {}

6
base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/crashhandler/IssuerClass.java
View file

@ -27,14 +27,14 @@ import org.jetbrains.annotations.NotNull;
* Implements the {@code issuer_class} placeholder.
*
* @see Placeholder
* @since 1-alpha0
* @since v1-alpha0
*/
@SuppressWarnings({ "unused" })
public final class IssuerClass implements Placeholder {
/**
* The {@link LogIssuer} to use.
*
* @since 1-alpha0
* @since v1-alpha0
*/
@NotNull
private final LogIssuer logIssuer;
@ -43,7 +43,7 @@ public final class IssuerClass implements Placeholder {
* Constructs this class.
*
* @param logIssuer {@link LogIssuer} to use
* @since 1-alpha0
* @since v1-alpha0
*/
public IssuerClass(@NotNull LogIssuer logIssuer) {
this.logIssuer = logIssuer;

6
base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/crashhandler/IssuerCodePart.java
View file

@ -27,14 +27,14 @@ import org.jetbrains.annotations.NotNull;
* Implements the {@code issuer_code_part} placeholder.
*
* @see Placeholder
* @since 1-alpha0
* @since v1-alpha0
*/
@SuppressWarnings({ "unused" })
public final class IssuerCodePart implements Placeholder {
/**
* The {@link LogIssuer} to use.
*
* @since 1-alpha0
* @since v1-alpha0
*/
@NotNull
private final LogIssuer logIssuer;
@ -43,7 +43,7 @@ public final class IssuerCodePart implements Placeholder {
* Constructs this class.
*
* @param logIssuer {@link LogIssuer} to use
* @since 1-alpha0
* @since v1-alpha0
*/
public IssuerCodePart(@NotNull LogIssuer logIssuer) {
this.logIssuer = logIssuer;

6
base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/crashhandler/IssuerInfo.java
View file

@ -27,14 +27,14 @@ import org.jetbrains.annotations.NotNull;
* Implements the {@code issuer_info} placeholder.
*
* @see Placeholder
* @since 1-alpha0
* @since v1-alpha0
*/
@SuppressWarnings({ "unused" })
public final class IssuerInfo implements Placeholder {
/**
* The {@link LogIssuer} to use.
*
* @since 1-alpha0
* @since v1-alpha0
*/
@NotNull
private final LogIssuer logIssuer;
@ -43,7 +43,7 @@ public final class IssuerInfo implements Placeholder {
* Constructs this class.
*
* @param logIssuer {@link LogIssuer} to use
* @since 1-alpha0
* @since v1-alpha0
*/
public IssuerInfo(@NotNull LogIssuer logIssuer) {
this.logIssuer = logIssuer;

6
base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/crashhandler/IssuerMessage.java
View file

@ -26,14 +26,14 @@ import org.jetbrains.annotations.NotNull;
* Implements the {@code issuer_message} placeholder.
*
* @see Placeholder
* @since 1-alpha0
* @since v1-alpha0
*/
@SuppressWarnings({ "unused" })
public final class IssuerMessage implements Placeholder {
/**
* The message to use.
*
* @since 1-alpha0
* @since v1-alpha0
*/
@NotNull
private final String message;
@ -42,7 +42,7 @@ public final class IssuerMessage implements Placeholder {
* Constructs this class.
*
* @param message message to use
* @since 1-alpha0
* @since v1-alpha0
*/
public IssuerMessage(@NotNull String message) {
this.message = message;

6
base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/crashhandler/IssuerPackage.java
View file

@ -27,14 +27,14 @@ import org.jetbrains.annotations.NotNull;
* Implements the {@code issuer_package} placeholder.
*
* @see Placeholder
* @since 1-alpha0
* @since v1-alpha0
*/
@SuppressWarnings({ "unused" })
public final class IssuerPackage implements Placeholder {
/**
* The {@link LogIssuer} to use.
*
* @since 1-alpha0
* @since v1-alpha0
*/
@NotNull
private final LogIssuer logIssuer;
@ -43,7 +43,7 @@ public final class IssuerPackage implements Placeholder {
* Constructs this class.
*
* @param logIssuer {@link LogIssuer} to use
* @since 1-alpha0
* @since v1-alpha0
*/
public IssuerPackage(@NotNull LogIssuer logIssuer) {
this.logIssuer = logIssuer;

6
base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/crashhandler/IssuerPath.java
View file

@ -27,14 +27,14 @@ import org.jetbrains.annotations.NotNull;
* Implements the {@code issuer_path} placeholder.
*
* @see Placeholder
* @since 1-alpha0
* @since v1-alpha0
*/
@SuppressWarnings({ "unused" })
public final class IssuerPath implements Placeholder {
/**
* The {@link LogIssuer} to use.
*
* @since 1-alpha0
* @since v1-alpha0
*/
@NotNull
private final LogIssuer logIssuer;
@ -43,7 +43,7 @@ public final class IssuerPath implements Placeholder {
* Constructs this class.
*
* @param logIssuer {@link LogIssuer} to use
* @since 1-alpha0
* @since v1-alpha0
*/
public IssuerPath(@NotNull LogIssuer logIssuer) {
this.logIssuer = logIssuer;

6
base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/crashhandler/Stacktrace.java
View file

@ -28,14 +28,14 @@ import org.jetbrains.annotations.Nullable;
* Implements the {@code stacktrace} placeholder.
*
* @see Placeholder
* @since 1-alpha0
* @since v1-alpha0
*/
@SuppressWarnings({ "unused" })
public final class Stacktrace implements Placeholder {
/**
* The {@link Throwable} to use.
*
* @since 1-alpha0
* @since v1-alpha0
*/
@Nullable
private final Throwable throwable;
@ -44,7 +44,7 @@ public final class Stacktrace implements Placeholder {
* Constructs this class.
*
* @param throwable {@link Throwable} to use
* @since 1-alpha0
* @since v1-alpha0
*/
public Stacktrace(@Nullable Throwable throwable) {
this.throwable = throwable;

2
base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/crashhandler/package-info.java
View file

@ -21,6 +21,6 @@
* Contains all placeholders used in the {@link de.staropensource.sosengine.base.logging.CrashHandler}.
*
* @see de.staropensource.sosengine.base.logging.CrashHandler
* @since 1-alpha0
* @since v1-alpha0
*/
package de.staropensource.sosengine.base.internal.placeholders.crashhandler;

6
base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/logger/LogClass.java
View file

@ -27,14 +27,14 @@ import org.jetbrains.annotations.NotNull;
* Implements the {@code log_class} placeholder.
*
* @see Placeholder
* @since 1-alpha0
* @since v1-alpha0
*/
@SuppressWarnings({ "unused" })
public final class LogClass implements Placeholder {
/**
* The {@link LogIssuer} to use.
*
* @since 1-alpha0
* @since v1-alpha0
*/
@NotNull
private final LogIssuer logIssuer;
@ -43,7 +43,7 @@ public final class LogClass implements Placeholder {
* Constructs this class.
*
* @param logIssuer {@link LogIssuer} to use
* @since 1-alpha0
* @since v1-alpha0
*/
public LogClass(@NotNull LogIssuer logIssuer) {
this.logIssuer = logIssuer;

6
base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/logger/LogCodePart.java
View file

@ -27,14 +27,14 @@ import org.jetbrains.annotations.NotNull;
* Implements the {@code log_code_part} placeholder.
*
* @see Placeholder
* @since 1-alpha0
* @since v1-alpha0
*/
@SuppressWarnings({ "unused" })
public final class LogCodePart implements Placeholder {
/**
* The {@link LogIssuer} to use.
*
* @since 1-alpha0
* @since v1-alpha0
*/
@NotNull
private final LogIssuer logIssuer;
@ -43,7 +43,7 @@ public final class LogCodePart implements Placeholder {
* Constructs this class.
*
* @param logIssuer {@link LogIssuer} to use
* @since 1-alpha0
* @since v1-alpha0
*/
public LogCodePart(@NotNull LogIssuer logIssuer) {
this.logIssuer = logIssuer;

6
base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/logger/LogColorPrimary.java
View file

@ -27,14 +27,14 @@ import org.jetbrains.annotations.NotNull;
* Implements the {@code log_color_primary} placeholder.
*
* @see Placeholder
* @since 1-alpha0
* @since v1-alpha0
*/
@SuppressWarnings({ "unused" })
public final class LogColorPrimary implements Placeholder {
/**
* The {@link LogLevel} to use.
*
* @since 1-alpha0
* @since v1-alpha0
*/
@NotNull
private final LogLevel level;
@ -43,7 +43,7 @@ public final class LogColorPrimary implements Placeholder {
* Constructs this class.
*
* @param level {@link LogLevel} to use
* @since 1-alpha0
* @since v1-alpha0
*/
public LogColorPrimary(@NotNull LogLevel level) {
this.level = level;

6
base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/logger/LogColorSecondary.java
View file

@ -27,14 +27,14 @@ import org.jetbrains.annotations.NotNull;
* Implements the {@code log_color_secondary} placeholder.
*
* @see Placeholder
* @since 1-alpha0
* @since v1-alpha0
*/
@SuppressWarnings({ "unused" })
public final class LogColorSecondary implements Placeholder {
/**
* The {@link LogLevel} to use.
*
* @since 1-alpha0
* @since v1-alpha0
*/
@NotNull
private final LogLevel level;
@ -43,7 +43,7 @@ public final class LogColorSecondary implements Placeholder {
* Constructs this class.
*
* @param level {@link LogLevel} to use
* @since 1-alpha0
* @since v1-alpha0
*/
public LogColorSecondary(@NotNull LogLevel level) {
this.level = level;

6
base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/logger/LogInfo.java
View file

@ -27,14 +27,14 @@ import org.jetbrains.annotations.NotNull;
* Implements the {@code log_info} placeholder.
*
* @see Placeholder
* @since 1-alpha0
* @since v1-alpha0
*/
@SuppressWarnings({ "unused" })
public final class LogInfo implements Placeholder {
/**
* The {@link LogIssuer} to use
*
* @since 1-alpha0
* @since v1-alpha0
*/
@NotNull
private final LogIssuer logIssuer;
@ -43,7 +43,7 @@ public final class LogInfo implements Placeholder {
* Constructs this class.
*
* @param logIssuer {@link LogIssuer} to use
* @since 1-alpha0
* @since v1-alpha0
*/
public LogInfo(@NotNull LogIssuer logIssuer) {
this.logIssuer = logIssuer;

6
base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/logger/LogLevel.java
View file

@ -26,14 +26,14 @@ import org.jetbrains.annotations.NotNull;
* Implements the {@code log_level} placeholder.
*
* @see Placeholder
* @since 1-alpha0
* @since v1-alpha0
*/
@SuppressWarnings({ "unused" })
public final class LogLevel implements Placeholder {
/**
* The {@link de.staropensource.sosengine.base.types.logging.LogLevel} to use.
*
* @since 1-alpha0
* @since v1-alpha0
*/
@NotNull
private final de.staropensource.sosengine.base.types.logging.LogLevel level;
@ -42,7 +42,7 @@ public final class LogLevel implements Placeholder {
* Constructs this class.
*
* @param level {@link de.staropensource.sosengine.base.types.logging.LogLevel} to use
* @since 1-alpha0
* @since v1-alpha0
*/
public LogLevel(@NotNull de.staropensource.sosengine.base.types.logging.LogLevel level) {
this.level = level;

6
base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/logger/LogMessage.java
View file

@ -26,14 +26,14 @@ import org.jetbrains.annotations.NotNull;
* Implements the {@code log_message} placeholder.
*
* @see Placeholder
* @since 1-alpha0
* @since v1-alpha0
*/
@SuppressWarnings({ "unused" })
public final class LogMessage implements Placeholder {
/**
* The message to use.
*
* @since 1-alpha0
* @since v1-alpha0
*/
@NotNull
private final String message;
@ -42,7 +42,7 @@ public final class LogMessage implements Placeholder {
* Constructs this class.
*
* @param message message to use
* @since 1-alpha0
* @since v1-alpha0
*/
public LogMessage(@NotNull String message) {
this.message = message;

6
base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/logger/LogPackage.java
View file

@ -27,14 +27,14 @@ import org.jetbrains.annotations.NotNull;
* Implements the {@code log_package} placeholder.
*
* @see Placeholder
* @since 1-alpha0
* @since v1-alpha0
*/
@SuppressWarnings({ "unused" })
public final class LogPackage implements Placeholder {
/**
* The {@link LogIssuer} to use.
*
* @since 1-alpha0
* @since v1-alpha0
*/
@NotNull
private final LogIssuer logIssuer;
@ -43,7 +43,7 @@ public final class LogPackage implements Placeholder {
* Constructs this class.
*
* @param logIssuer {@link LogIssuer} to use
* @since 1-alpha0
* @since v1-alpha0
*/
public LogPackage(@NotNull LogIssuer logIssuer) {
this.logIssuer = logIssuer;

6
base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/logger/LogPath.java
View file

@ -27,14 +27,14 @@ import org.jetbrains.annotations.NotNull;
* Implements the {@code log_path} placeholder.
*
* @see Placeholder
* @since 1-alpha0
* @since v1-alpha0
*/
@SuppressWarnings({ "unused" })
public final class LogPath implements Placeholder {
/**
* The {@link LogIssuer} to use.
*
* @since 1-alpha0
* @since v1-alpha0
*/
@NotNull
private final LogIssuer logIssuer;
@ -43,7 +43,7 @@ public final class LogPath implements Placeholder {
* Constructs this class.
*
* @param logIssuer {@link LogIssuer} to use
* @since 1-alpha0
* @since v1-alpha0
*/
public LogPath(@NotNull LogIssuer logIssuer) {
this.logIssuer = logIssuer;

2
base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/logger/package-info.java
View file

@ -21,6 +21,6 @@
* Contains all placeholders used in the {@link de.staropensource.sosengine.base.logging.Logger}.
*
* @see de.staropensource.sosengine.base.logging.Logger
* @since 1-alpha0
* @since v1-alpha0
*/
package de.staropensource.sosengine.base.internal.placeholders.logger;

2
base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/package-info.java
View file

@ -22,6 +22,6 @@
*
* @see de.staropensource.sosengine.base.utility.PlaceholderEngine
* @see de.staropensource.sosengine.base.classes.Placeholder
* @since 1-alpha0
* @since v1-alpha0
*/
package de.staropensource.sosengine.base.internal.placeholders;

Some files were not shown because too many files have changed in this diff Show more