From e65c3e266278dd0fbff7b651463f4de39a49cb47 Mon Sep 17 00:00:00 2001 From: JeremyStarTM Date: Fri, 12 Jul 2024 02:30:20 +0200 Subject: [PATCH] Prefix all @since values with 'v' --- .../staropensource/sosengine/base/Engine.java | 36 ++++---- .../sosengine/base/EngineConfiguration.java | 58 ++++++------ .../base/annotations/EngineSubsystem.java | 2 +- .../base/annotations/EventListener.java | 2 +- .../base/annotations/package-info.java | 2 +- .../sosengine/base/classes/Event.java | 2 +- .../sosengine/base/classes/LoggerImpl.java | 8 +- .../sosengine/base/classes/Placeholder.java | 6 +- .../base/classes/ShortcodeParserSkeleton.java | 12 +-- .../base/classes/SubsystemConfiguration.java | 12 +-- .../base/classes/SubsystemMainClass.java | 10 +- .../base/classes/VersioningSystem.java | 6 +- .../base/classes/helpers/EventHelper.java | 16 ++-- .../base/classes/helpers/package-info.java | 2 +- .../sosengine/base/classes/package-info.java | 2 +- .../base/data/info/EngineInformation.java | 92 +++++++++---------- .../base/data/info/JvmInformation.java | 28 +++--- .../base/data/info/package-info.java | 2 +- .../sosengine/base/data/package-info.java | 2 +- .../FourNumberVersioningSystem.java | 18 ++-- .../versioning/OneNumberVersioningSystem.java | 6 +- .../versioning/SemanticVersioningSystem.java | 22 ++--- .../StarOpenSourceVersioningSystem.java | 22 ++--- .../ThreeNumberVersioningSystem.java | 14 +-- .../versioning/TwoNumberVersioningSystem.java | 10 +- .../base/data/versioning/package-info.java | 2 +- .../base/events/EngineCrashEvent.java | 2 +- .../base/events/EngineShutdownEvent.java | 2 +- .../base/events/EngineSoftCrashEvent.java | 2 +- .../sosengine/base/events/LogEvent.java | 4 +- .../base/events/ThrowableCatchEvent.java | 4 +- .../sosengine/base/events/package-info.java | 2 +- .../exceptions/DependencyCycleException.java | 4 +- ...IncompatibleVersioningSystemException.java | 4 +- .../InvalidVersionStringException.java | 14 +-- .../UnexpectedThrowableException.java | 6 +- .../UnmetDependenciesException.java | 8 +- .../base/exceptions/package-info.java | 2 +- .../events/InternalEngineShutdownEvent.java | 2 +- .../sosengine/base/internal/package-info.java | 2 +- .../base/internal/placeholders/DateDay.java | 4 +- .../base/internal/placeholders/DateMonth.java | 4 +- .../base/internal/placeholders/DateYear.java | 4 +- .../placeholders/EngineDependencyJansi.java | 4 +- .../EngineDependencyJetbrainsAnnotations.java | 4 +- .../placeholders/EngineDependencyLombok.java | 4 +- .../placeholders/EngineDependencyLwjgl.java | 4 +- .../EngineDependencyReflections.java | 4 +- .../placeholders/EngineDependencySlf4j.java | 4 +- .../placeholders/EngineGitBranch.java | 4 +- .../placeholders/EngineGitCommitHeader.java | 4 +- .../placeholders/EngineGitCommitIdLong.java | 4 +- .../placeholders/EngineGitCommitIdShort.java | 4 +- .../placeholders/EngineGitCommitTimeDay.java | 4 +- .../placeholders/EngineGitCommitTimeHour.java | 4 +- .../EngineGitCommitTimeMinute.java | 4 +- .../EngineGitCommitTimeMonth.java | 4 +- .../EngineGitCommitTimeSecond.java | 4 +- .../placeholders/EngineGitCommitTimeYear.java | 4 +- .../placeholders/EngineGitCommits.java | 4 +- .../placeholders/EngineGitCommitterEmail.java | 4 +- .../placeholders/EngineGitCommitterName.java | 4 +- .../internal/placeholders/EngineGitDirty.java | 4 +- .../placeholders/EnginePluginLombok.java | 4 +- .../placeholders/EnginePluginShadow.java | 4 +- .../internal/placeholders/EngineVersion.java | 4 +- .../placeholders/EngineVersionFork.java | 4 +- .../placeholders/EngineVersionType.java | 4 +- .../EngineVersionTyperelease.java | 4 +- .../placeholders/EngineVersionVersion.java | 4 +- .../internal/placeholders/JvmArguments.java | 4 +- .../placeholders/JvmImplementationName.java | 4 +- .../placeholders/JvmImplementationVendor.java | 4 +- .../JvmImplementationVersion.java | 4 +- .../base/internal/placeholders/JvmJava.java | 4 +- .../base/internal/placeholders/JvmUptime.java | 4 +- .../base/internal/placeholders/TimeEpoch.java | 4 +- .../base/internal/placeholders/TimeHour.java | 4 +- .../internal/placeholders/TimeMinute.java | 4 +- .../internal/placeholders/TimeSecond.java | 4 +- .../base/internal/placeholders/TimeZone.java | 4 +- .../crashhandler/IssuerClass.java | 6 +- .../crashhandler/IssuerCodePart.java | 6 +- .../placeholders/crashhandler/IssuerInfo.java | 6 +- .../crashhandler/IssuerMessage.java | 6 +- .../crashhandler/IssuerPackage.java | 6 +- .../placeholders/crashhandler/IssuerPath.java | 6 +- .../placeholders/crashhandler/Stacktrace.java | 6 +- .../crashhandler/package-info.java | 2 +- .../placeholders/logger/LogClass.java | 6 +- .../placeholders/logger/LogCodePart.java | 6 +- .../placeholders/logger/LogColorPrimary.java | 6 +- .../logger/LogColorSecondary.java | 6 +- .../internal/placeholders/logger/LogInfo.java | 6 +- .../placeholders/logger/LogLevel.java | 6 +- .../placeholders/logger/LogMessage.java | 6 +- .../placeholders/logger/LogPackage.java | 6 +- .../internal/placeholders/logger/LogPath.java | 6 +- .../placeholders/logger/package-info.java | 2 +- .../internal/placeholders/package-info.java | 2 +- .../types/DependencySubsystemVector.java | 10 +- .../base/internal/types/QueuedLogMessage.java | 16 ++-- .../base/internal/types/package-info.java | 2 +- .../sosengine/base/logging/CrashHandler.java | 20 ++-- .../sosengine/base/logging/Logger.java | 44 ++++----- .../base/logging/LoggerInstance.java | 26 +++--- .../implementation/ColoredLoggerImpl.java | 4 +- .../implementation/PlainLoggerImpl.java | 4 +- .../logging/implementation/RawLoggerImpl.java | 4 +- .../logging/implementation/package-info.java | 2 +- .../sosengine/base/logging/package-info.java | 2 +- .../sosengine/base/package-info.java | 2 +- .../sosengine/base/types/CodePart.java | 8 +- .../base/types/DependencyVector.java | 18 ++-- .../sosengine/base/types/EventPriority.java | 16 ++-- .../sosengine/base/types/Tristate.java | 8 +- .../sosengine/base/types/VersionType.java | 10 +- .../types/immutable/ImmutableArrayList.java | 6 +- .../types/immutable/ImmutableHashMap.java | 6 +- .../immutable/ImmutableLinkedHashMap.java | 6 +- .../types/immutable/ImmutableLinkedList.java | 6 +- .../base/types/immutable/package-info.java | 2 +- .../base/types/logging/LogIssuer.java | 16 ++-- .../base/types/logging/LogLevel.java | 16 ++-- .../sosengine/base/types/logging/LogRule.java | 6 +- .../base/types/logging/LogRuleType.java | 6 +- .../base/types/logging/package-info.java | 2 +- .../sosengine/base/types/package-info.java | 2 +- .../sosengine/base/types/vectors/Vec2.java | 16 ++-- .../sosengine/base/types/vectors/Vec2i.java | 16 ++-- .../sosengine/base/types/vectors/Vec3.java | 22 ++--- .../sosengine/base/types/vectors/Vec3i.java | 22 ++--- .../base/types/vectors/package-info.java | 2 +- .../base/utility/DependencyResolver.java | 26 +++--- .../sosengine/base/utility/ListFormatter.java | 2 +- .../sosengine/base/utility/Miscellaneous.java | 18 ++-- .../base/utility/PlaceholderEngine.java | 18 ++-- .../converter/AnsiShortcodeConverter.java | 6 +- .../converter/EmptyShortcodeConverter.java | 6 +- .../base/utility/converter/package-info.java | 2 +- .../sosengine/base/utility/package-info.java | 2 +- .../base/utility/parser/PropertyParser.java | 32 +++---- .../base/utility/parser/StackTraceParser.java | 12 +-- .../base/utility/parser/package-info.java | 2 +- .../sosengine/package-info.java | 2 +- .../sosengine/unittests/UnitConfig.java | 6 +- .../sosengine/unittests/UnitLogger.java | 20 ++-- base/src/main/java/module-info.java | 2 +- .../graphics/opengl/OpenGlManagement.java | 2 +- .../graphics/opengl/OpenGlSubsystem.java | 18 ++-- .../graphics/opengl/classes/Window.java | 16 ++-- .../opengl/events/GraphicsErrorEvent.java | 2 +- .../opengl/src/main/java/module-info.java | 2 +- .../sosengine/graphics/GraphicsSubsystem.java | 28 +++--- .../GraphicsSubsystemConfiguration.java | 20 ++-- .../graphics/classes/ApiMainClass.java | 14 +-- .../graphics/classes/ApiManagementClass.java | 4 +- .../sosengine/graphics/classes/Window.java | 18 ++-- .../events/GraphicsApiErrorEvent.java | 4 +- .../events/GraphicsApiShutdownEvent.java | 2 +- .../graphics/events/GraphicsErrorEvent.java | 4 +- .../sosengine/graphics/types/WindowMode.java | 8 +- graphics/src/main/java/module-info.java | 2 +- .../graphics/vulkan/VulkanManagement.java | 2 +- .../graphics/vulkan/VulkanSubsystem.java | 16 ++-- .../vulkan/events/GraphicsErrorEvent.java | 2 +- .../vulkan/src/main/java/module-info.java | 2 +- .../slf4j_compat/CompatibilityLogger.java | 26 +++--- .../CompatibilityLoggerFactory.java | 8 +- .../CompatibilityLoggerProvider.java | 16 ++-- .../Slf4jCompatibilitySubsystem.java | 6 +- slf4j-compat/src/main/java/module-info.java | 2 +- .../sosengine/testapp/Main.java | 4 +- testapp/src/main/java/module-info.java | 2 +- 174 files changed, 726 insertions(+), 726 deletions(-) diff --git a/base/src/main/java/de/staropensource/sosengine/base/Engine.java b/base/src/main/java/de/staropensource/sosengine/base/Engine.java index d8c2290..bdf9a76 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/Engine.java +++ b/base/src/main/java/de/staropensource/sosengine/base/Engine.java @@ -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); diff --git a/base/src/main/java/de/staropensource/sosengine/base/EngineConfiguration.java b/base/src/main/java/de/staropensource/sosengine/base/EngineConfiguration.java index 99e8006..1349320 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/EngineConfiguration.java +++ b/base/src/main/java/de/staropensource/sosengine/base/EngineConfiguration.java @@ -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.
* 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 the standard output * instead of the standard error 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; diff --git a/base/src/main/java/de/staropensource/sosengine/base/annotations/EngineSubsystem.java b/base/src/main/java/de/staropensource/sosengine/base/annotations/EngineSubsystem.java index 92db05b..090e271 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/annotations/EngineSubsystem.java +++ b/base/src/main/java/de/staropensource/sosengine/base/annotations/EngineSubsystem.java @@ -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) diff --git a/base/src/main/java/de/staropensource/sosengine/base/annotations/EventListener.java b/base/src/main/java/de/staropensource/sosengine/base/annotations/EventListener.java index 63f22d2..5665c83 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/annotations/EventListener.java +++ b/base/src/main/java/de/staropensource/sosengine/base/annotations/EventListener.java @@ -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) diff --git a/base/src/main/java/de/staropensource/sosengine/base/annotations/package-info.java b/base/src/main/java/de/staropensource/sosengine/base/annotations/package-info.java index 04f8eb7..66a47e2 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/annotations/package-info.java +++ b/base/src/main/java/de/staropensource/sosengine/base/annotations/package-info.java @@ -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; diff --git a/base/src/main/java/de/staropensource/sosengine/base/classes/Event.java b/base/src/main/java/de/staropensource/sosengine/base/classes/Event.java index e622d55..7718ea6 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/classes/Event.java +++ b/base/src/main/java/de/staropensource/sosengine/base/classes/Event.java @@ -22,7 +22,7 @@ package de.staropensource.sosengine.base.classes; /** * Represents an event. * - * @since 1-alpha0 + * @since v1-alpha0 */ @SuppressWarnings({ "unused" }) public interface Event { diff --git a/base/src/main/java/de/staropensource/sosengine/base/classes/LoggerImpl.java b/base/src/main/java/de/staropensource/sosengine/base/classes/LoggerImpl.java index 784029d..c467b88 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/classes/LoggerImpl.java +++ b/base/src/main/java/de/staropensource/sosengine/base/classes/LoggerImpl.java @@ -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); } diff --git a/base/src/main/java/de/staropensource/sosengine/base/classes/Placeholder.java b/base/src/main/java/de/staropensource/sosengine/base/classes/Placeholder.java index 26dcd0f..9314f06 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/classes/Placeholder.java +++ b/base/src/main/java/de/staropensource/sosengine/base/classes/Placeholder.java @@ -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); diff --git a/base/src/main/java/de/staropensource/sosengine/base/classes/ShortcodeParserSkeleton.java b/base/src/main/java/de/staropensource/sosengine/base/classes/ShortcodeParserSkeleton.java index 46edba9..a782076 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/classes/ShortcodeParserSkeleton.java +++ b/base/src/main/java/de/staropensource/sosengine/base/classes/ShortcodeParserSkeleton.java @@ -46,7 +46,7 @@ import java.util.List; *
  • negative
    • * * - * @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) { diff --git a/base/src/main/java/de/staropensource/sosengine/base/classes/SubsystemConfiguration.java b/base/src/main/java/de/staropensource/sosengine/base/classes/SubsystemConfiguration.java index 2d798c9..7ad5165 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/classes/SubsystemConfiguration.java +++ b/base/src/main/java/de/staropensource/sosengine/base/classes/SubsystemConfiguration.java @@ -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(); diff --git a/base/src/main/java/de/staropensource/sosengine/base/classes/SubsystemMainClass.java b/base/src/main/java/de/staropensource/sosengine/base/classes/SubsystemMainClass.java index d60760c..b7a2225 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/classes/SubsystemMainClass.java +++ b/base/src/main/java/de/staropensource/sosengine/base/classes/SubsystemMainClass.java @@ -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() {} diff --git a/base/src/main/java/de/staropensource/sosengine/base/classes/VersioningSystem.java b/base/src/main/java/de/staropensource/sosengine/base/classes/VersioningSystem.java index 54c0b4e..7235dcb 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/classes/VersioningSystem.java +++ b/base/src/main/java/de/staropensource/sosengine/base/classes/VersioningSystem.java @@ -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; diff --git a/base/src/main/java/de/staropensource/sosengine/base/classes/helpers/EventHelper.java b/base/src/main/java/de/staropensource/sosengine/base/classes/helpers/EventHelper.java index 379de6b..49f0c55 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/classes/helpers/EventHelper.java +++ b/base/src/main/java/de/staropensource/sosengine/base/classes/helpers/EventHelper.java @@ -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, 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 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 getAnnotatedMethods(@NotNull Class 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 getAnnotatedMethods(@NotNull Class 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 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 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 clazz) { if (clazz == null) diff --git a/base/src/main/java/de/staropensource/sosengine/base/classes/helpers/package-info.java b/base/src/main/java/de/staropensource/sosengine/base/classes/helpers/package-info.java index f7360bb..2758cf6 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/classes/helpers/package-info.java +++ b/base/src/main/java/de/staropensource/sosengine/base/classes/helpers/package-info.java @@ -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; diff --git a/base/src/main/java/de/staropensource/sosengine/base/classes/package-info.java b/base/src/main/java/de/staropensource/sosengine/base/classes/package-info.java index 62c93fa..eee44da 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/classes/package-info.java +++ b/base/src/main/java/de/staropensource/sosengine/base/classes/package-info.java @@ -20,6 +20,6 @@ /** * Contains various interfaces and abstract classes. * - * @since 1-alpha0 + * @since v1-alpha0 */ package de.staropensource.sosengine.base.classes; diff --git a/base/src/main/java/de/staropensource/sosengine/base/data/info/EngineInformation.java b/base/src/main/java/de/staropensource/sosengine/base/data/info/EngineInformation.java index 5a7e3f1..8b9344c 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/data/info/EngineInformation.java +++ b/base/src/main/java/de/staropensource/sosengine/base/data/info/EngineInformation.java @@ -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.
    * Likely empty. If not, it must be prefixed with a dash. * - * @since 1-alpha0 + * @since v1-alpha0 * * -- GETTER -- * Provides the engine's fork identifier.
    * 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)); diff --git a/base/src/main/java/de/staropensource/sosengine/base/data/info/JvmInformation.java b/base/src/main/java/de/staropensource/sosengine/base/data/info/JvmInformation.java index 9d2bf6f..3cd6e26 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/data/info/JvmInformation.java +++ b/base/src/main/java/de/staropensource/sosengine/base/data/info/JvmInformation.java @@ -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(); diff --git a/base/src/main/java/de/staropensource/sosengine/base/data/info/package-info.java b/base/src/main/java/de/staropensource/sosengine/base/data/info/package-info.java index cda374f..d326178 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/data/info/package-info.java +++ b/base/src/main/java/de/staropensource/sosengine/base/data/info/package-info.java @@ -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; diff --git a/base/src/main/java/de/staropensource/sosengine/base/data/package-info.java b/base/src/main/java/de/staropensource/sosengine/base/data/package-info.java index 88efdb4..ac579d0 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/data/package-info.java +++ b/base/src/main/java/de/staropensource/sosengine/base/data/package-info.java @@ -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; diff --git a/base/src/main/java/de/staropensource/sosengine/base/data/versioning/FourNumberVersioningSystem.java b/base/src/main/java/de/staropensource/sosengine/base/data/versioning/FourNumberVersioningSystem.java index 3677747..a116ff1 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/data/versioning/FourNumberVersioningSystem.java +++ b/base/src/main/java/de/staropensource/sosengine/base/data/versioning/FourNumberVersioningSystem.java @@ -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; diff --git a/base/src/main/java/de/staropensource/sosengine/base/data/versioning/OneNumberVersioningSystem.java b/base/src/main/java/de/staropensource/sosengine/base/data/versioning/OneNumberVersioningSystem.java index 2bafd52..f228e24 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/data/versioning/OneNumberVersioningSystem.java +++ b/base/src/main/java/de/staropensource/sosengine/base/data/versioning/OneNumberVersioningSystem.java @@ -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; diff --git a/base/src/main/java/de/staropensource/sosengine/base/data/versioning/SemanticVersioningSystem.java b/base/src/main/java/de/staropensource/sosengine/base/data/versioning/SemanticVersioningSystem.java index 26877e5..e602369 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/data/versioning/SemanticVersioningSystem.java +++ b/base/src/main/java/de/staropensource/sosengine/base/data/versioning/SemanticVersioningSystem.java @@ -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; diff --git a/base/src/main/java/de/staropensource/sosengine/base/data/versioning/StarOpenSourceVersioningSystem.java b/base/src/main/java/de/staropensource/sosengine/base/data/versioning/StarOpenSourceVersioningSystem.java index 999ea1f..b3ac4f9 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/data/versioning/StarOpenSourceVersioningSystem.java +++ b/base/src/main/java/de/staropensource/sosengine/base/data/versioning/StarOpenSourceVersioningSystem.java @@ -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; diff --git a/base/src/main/java/de/staropensource/sosengine/base/data/versioning/ThreeNumberVersioningSystem.java b/base/src/main/java/de/staropensource/sosengine/base/data/versioning/ThreeNumberVersioningSystem.java index 72923e8..af9837d 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/data/versioning/ThreeNumberVersioningSystem.java +++ b/base/src/main/java/de/staropensource/sosengine/base/data/versioning/ThreeNumberVersioningSystem.java @@ -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; diff --git a/base/src/main/java/de/staropensource/sosengine/base/data/versioning/TwoNumberVersioningSystem.java b/base/src/main/java/de/staropensource/sosengine/base/data/versioning/TwoNumberVersioningSystem.java index 5f98141..26c0f2c 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/data/versioning/TwoNumberVersioningSystem.java +++ b/base/src/main/java/de/staropensource/sosengine/base/data/versioning/TwoNumberVersioningSystem.java @@ -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; diff --git a/base/src/main/java/de/staropensource/sosengine/base/data/versioning/package-info.java b/base/src/main/java/de/staropensource/sosengine/base/data/versioning/package-info.java index 163a93e..eea14f1 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/data/versioning/package-info.java +++ b/base/src/main/java/de/staropensource/sosengine/base/data/versioning/package-info.java @@ -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; diff --git a/base/src/main/java/de/staropensource/sosengine/base/events/EngineCrashEvent.java b/base/src/main/java/de/staropensource/sosengine/base/events/EngineCrashEvent.java index 092cd7d..b3131c7 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/events/EngineCrashEvent.java +++ b/base/src/main/java/de/staropensource/sosengine/base/events/EngineCrashEvent.java @@ -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 { diff --git a/base/src/main/java/de/staropensource/sosengine/base/events/EngineShutdownEvent.java b/base/src/main/java/de/staropensource/sosengine/base/events/EngineShutdownEvent.java index 019f4fc..bf55235 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/events/EngineShutdownEvent.java +++ b/base/src/main/java/de/staropensource/sosengine/base/events/EngineShutdownEvent.java @@ -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 { /** diff --git a/base/src/main/java/de/staropensource/sosengine/base/events/EngineSoftCrashEvent.java b/base/src/main/java/de/staropensource/sosengine/base/events/EngineSoftCrashEvent.java index 65f0464..f2167a4 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/events/EngineSoftCrashEvent.java +++ b/base/src/main/java/de/staropensource/sosengine/base/events/EngineSoftCrashEvent.java @@ -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 { diff --git a/base/src/main/java/de/staropensource/sosengine/base/events/LogEvent.java b/base/src/main/java/de/staropensource/sosengine/base/events/LogEvent.java index e5ce6b4..d6233ca 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/events/LogEvent.java +++ b/base/src/main/java/de/staropensource/sosengine/base/events/LogEvent.java @@ -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(() -> { diff --git a/base/src/main/java/de/staropensource/sosengine/base/events/ThrowableCatchEvent.java b/base/src/main/java/de/staropensource/sosengine/base/events/ThrowableCatchEvent.java index 6eb5f32..fa30afb 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/events/ThrowableCatchEvent.java +++ b/base/src/main/java/de/staropensource/sosengine/base/events/ThrowableCatchEvent.java @@ -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(() -> { diff --git a/base/src/main/java/de/staropensource/sosengine/base/events/package-info.java b/base/src/main/java/de/staropensource/sosengine/base/events/package-info.java index 67ba583..a68cb65 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/events/package-info.java +++ b/base/src/main/java/de/staropensource/sosengine/base/events/package-info.java @@ -20,6 +20,6 @@ /** * Contains events. There's nothing more to say. * - * @since 1-alpha1 + * @since v1-alpha1 */ package de.staropensource.sosengine.base.events; diff --git a/base/src/main/java/de/staropensource/sosengine/base/exceptions/DependencyCycleException.java b/base/src/main/java/de/staropensource/sosengine/base/exceptions/DependencyCycleException.java index bd47519..11aa05f 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/exceptions/DependencyCycleException.java +++ b/base/src/main/java/de/staropensource/sosengine/base/exceptions/DependencyCycleException.java @@ -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); diff --git a/base/src/main/java/de/staropensource/sosengine/base/exceptions/IncompatibleVersioningSystemException.java b/base/src/main/java/de/staropensource/sosengine/base/exceptions/IncompatibleVersioningSystemException.java index de2628c..8ae97db 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/exceptions/IncompatibleVersioningSystemException.java +++ b/base/src/main/java/de/staropensource/sosengine/base/exceptions/IncompatibleVersioningSystemException.java @@ -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); diff --git a/base/src/main/java/de/staropensource/sosengine/base/exceptions/InvalidVersionStringException.java b/base/src/main/java/de/staropensource/sosengine/base/exceptions/InvalidVersionStringException.java index 390c949..e2b2ee4 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/exceptions/InvalidVersionStringException.java +++ b/base/src/main/java/de/staropensource/sosengine/base/exceptions/InvalidVersionStringException.java @@ -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 + "\""); diff --git a/base/src/main/java/de/staropensource/sosengine/base/exceptions/UnexpectedThrowableException.java b/base/src/main/java/de/staropensource/sosengine/base/exceptions/UnexpectedThrowableException.java index 51d8545..5b86c1a 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/exceptions/UnexpectedThrowableException.java +++ b/base/src/main/java/de/staropensource/sosengine/base/exceptions/UnexpectedThrowableException.java @@ -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; diff --git a/base/src/main/java/de/staropensource/sosengine/base/exceptions/UnmetDependenciesException.java b/base/src/main/java/de/staropensource/sosengine/base/exceptions/UnmetDependenciesException.java index 1139a69..5202598 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/exceptions/UnmetDependenciesException.java +++ b/base/src/main/java/de/staropensource/sosengine/base/exceptions/UnmetDependenciesException.java @@ -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) { diff --git a/base/src/main/java/de/staropensource/sosengine/base/exceptions/package-info.java b/base/src/main/java/de/staropensource/sosengine/base/exceptions/package-info.java index 77d8919..a12b4e7 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/exceptions/package-info.java +++ b/base/src/main/java/de/staropensource/sosengine/base/exceptions/package-info.java @@ -20,6 +20,6 @@ /** * Contains exceptions thrown by the engine. * - * @since 1-alpha1 + * @since v1-alpha1 */ package de.staropensource.sosengine.base.exceptions; diff --git a/base/src/main/java/de/staropensource/sosengine/base/internal/events/InternalEngineShutdownEvent.java b/base/src/main/java/de/staropensource/sosengine/base/internal/events/InternalEngineShutdownEvent.java index 5cb0f09..a88ed89 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/internal/events/InternalEngineShutdownEvent.java +++ b/base/src/main/java/de/staropensource/sosengine/base/internal/events/InternalEngineShutdownEvent.java @@ -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 { /** diff --git a/base/src/main/java/de/staropensource/sosengine/base/internal/package-info.java b/base/src/main/java/de/staropensource/sosengine/base/internal/package-info.java index 9a9cf56..df52caf 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/internal/package-info.java +++ b/base/src/main/java/de/staropensource/sosengine/base/internal/package-info.java @@ -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; diff --git a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/DateDay.java b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/DateDay.java index f404ab4..fffa4c9 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/DateDay.java +++ b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/DateDay.java @@ -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() {} diff --git a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/DateMonth.java b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/DateMonth.java index ba2a798..4f9216b 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/DateMonth.java +++ b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/DateMonth.java @@ -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() {} diff --git a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/DateYear.java b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/DateYear.java index 9918c0c..ae7132c 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/DateYear.java +++ b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/DateYear.java @@ -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() {} diff --git a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineDependencyJansi.java b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineDependencyJansi.java index 219f912..587c819 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineDependencyJansi.java +++ b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineDependencyJansi.java @@ -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() {} diff --git a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineDependencyJetbrainsAnnotations.java b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineDependencyJetbrainsAnnotations.java index 51690f0..6647986 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineDependencyJetbrainsAnnotations.java +++ b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineDependencyJetbrainsAnnotations.java @@ -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() {} diff --git a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineDependencyLombok.java b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineDependencyLombok.java index 18d8e13..c0a2154 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineDependencyLombok.java +++ b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineDependencyLombok.java @@ -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() {} diff --git a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineDependencyLwjgl.java b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineDependencyLwjgl.java index 44293e1..624fd14 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineDependencyLwjgl.java +++ b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineDependencyLwjgl.java @@ -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() {} diff --git a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineDependencyReflections.java b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineDependencyReflections.java index e9e14db..8ce98db 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineDependencyReflections.java +++ b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineDependencyReflections.java @@ -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() {} diff --git a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineDependencySlf4j.java b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineDependencySlf4j.java index f9fccdf..537f9d8 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineDependencySlf4j.java +++ b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineDependencySlf4j.java @@ -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() {} diff --git a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineGitBranch.java b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineGitBranch.java index deba4e2..d947fc2 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineGitBranch.java +++ b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineGitBranch.java @@ -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() {} diff --git a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineGitCommitHeader.java b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineGitCommitHeader.java index 83105aa..a1a02eb 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineGitCommitHeader.java +++ b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineGitCommitHeader.java @@ -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() {} diff --git a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineGitCommitIdLong.java b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineGitCommitIdLong.java index 001eabe..363288e 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineGitCommitIdLong.java +++ b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineGitCommitIdLong.java @@ -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() {} diff --git a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineGitCommitIdShort.java b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineGitCommitIdShort.java index f64b675..c5b8a83 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineGitCommitIdShort.java +++ b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineGitCommitIdShort.java @@ -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() {} diff --git a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineGitCommitTimeDay.java b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineGitCommitTimeDay.java index 2e9f0e7..14ed0b4 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineGitCommitTimeDay.java +++ b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineGitCommitTimeDay.java @@ -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() {} diff --git a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineGitCommitTimeHour.java b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineGitCommitTimeHour.java index 15cfea3..8ae182c 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineGitCommitTimeHour.java +++ b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineGitCommitTimeHour.java @@ -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() {} diff --git a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineGitCommitTimeMinute.java b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineGitCommitTimeMinute.java index 5e6842b..5f3cd76 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineGitCommitTimeMinute.java +++ b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineGitCommitTimeMinute.java @@ -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() {} diff --git a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineGitCommitTimeMonth.java b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineGitCommitTimeMonth.java index 7392541..95bc2d7 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineGitCommitTimeMonth.java +++ b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineGitCommitTimeMonth.java @@ -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() {} diff --git a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineGitCommitTimeSecond.java b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineGitCommitTimeSecond.java index 35a2c4b..bd53926 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineGitCommitTimeSecond.java +++ b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineGitCommitTimeSecond.java @@ -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() {} diff --git a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineGitCommitTimeYear.java b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineGitCommitTimeYear.java index b0eacd8..4a9e107 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineGitCommitTimeYear.java +++ b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineGitCommitTimeYear.java @@ -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() {} diff --git a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineGitCommits.java b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineGitCommits.java index ccdaf3a..2f9d117 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineGitCommits.java +++ b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineGitCommits.java @@ -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() {} diff --git a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineGitCommitterEmail.java b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineGitCommitterEmail.java index 9087e6a..0edf956 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineGitCommitterEmail.java +++ b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineGitCommitterEmail.java @@ -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() {} diff --git a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineGitCommitterName.java b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineGitCommitterName.java index 9bdba75..6a2c5a0 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineGitCommitterName.java +++ b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineGitCommitterName.java @@ -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() {} diff --git a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineGitDirty.java b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineGitDirty.java index 4ecc5e0..15ae7be 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineGitDirty.java +++ b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineGitDirty.java @@ -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() {} diff --git a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EnginePluginLombok.java b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EnginePluginLombok.java index 907a68b..8815c9f 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EnginePluginLombok.java +++ b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EnginePluginLombok.java @@ -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() {} diff --git a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EnginePluginShadow.java b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EnginePluginShadow.java index 21ffd95..47ea8ac 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EnginePluginShadow.java +++ b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EnginePluginShadow.java @@ -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() {} diff --git a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineVersion.java b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineVersion.java index a4fdd94..4dc9f5d 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineVersion.java +++ b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineVersion.java @@ -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() {} diff --git a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineVersionFork.java b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineVersionFork.java index e5a2f94..cbb12b4 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineVersionFork.java +++ b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineVersionFork.java @@ -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() {} diff --git a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineVersionType.java b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineVersionType.java index 10c93ac..d5b4f97 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineVersionType.java +++ b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineVersionType.java @@ -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() {} diff --git a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineVersionTyperelease.java b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineVersionTyperelease.java index 4722c06..83e0127 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineVersionTyperelease.java +++ b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineVersionTyperelease.java @@ -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() {} diff --git a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineVersionVersion.java b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineVersionVersion.java index 7e7d8a7..38065a6 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineVersionVersion.java +++ b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/EngineVersionVersion.java @@ -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() {} diff --git a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/JvmArguments.java b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/JvmArguments.java index 85176a3..ddcd238 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/JvmArguments.java +++ b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/JvmArguments.java @@ -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() {} diff --git a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/JvmImplementationName.java b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/JvmImplementationName.java index 6e6cb2b..cbe7458 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/JvmImplementationName.java +++ b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/JvmImplementationName.java @@ -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() {} diff --git a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/JvmImplementationVendor.java b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/JvmImplementationVendor.java index 4cf2c8e..1cb64cd 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/JvmImplementationVendor.java +++ b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/JvmImplementationVendor.java @@ -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() {} diff --git a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/JvmImplementationVersion.java b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/JvmImplementationVersion.java index 426f905..97e42b6 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/JvmImplementationVersion.java +++ b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/JvmImplementationVersion.java @@ -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() {} diff --git a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/JvmJava.java b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/JvmJava.java index 2c61b41..6388eec 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/JvmJava.java +++ b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/JvmJava.java @@ -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() {} diff --git a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/JvmUptime.java b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/JvmUptime.java index 9d40905..27d4ce6 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/JvmUptime.java +++ b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/JvmUptime.java @@ -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() {} diff --git a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/TimeEpoch.java b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/TimeEpoch.java index 71296f3..c9ced3c 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/TimeEpoch.java +++ b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/TimeEpoch.java @@ -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() {} diff --git a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/TimeHour.java b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/TimeHour.java index bea9589..5235b99 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/TimeHour.java +++ b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/TimeHour.java @@ -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() {} diff --git a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/TimeMinute.java b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/TimeMinute.java index a1a0372..6c8bcb4 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/TimeMinute.java +++ b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/TimeMinute.java @@ -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() {} diff --git a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/TimeSecond.java b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/TimeSecond.java index 243dd3b..16e5961 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/TimeSecond.java +++ b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/TimeSecond.java @@ -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() {} diff --git a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/TimeZone.java b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/TimeZone.java index 922a478..2d3b604 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/TimeZone.java +++ b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/TimeZone.java @@ -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() {} diff --git a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/crashhandler/IssuerClass.java b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/crashhandler/IssuerClass.java index 7b10a8c..87452a6 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/crashhandler/IssuerClass.java +++ b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/crashhandler/IssuerClass.java @@ -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; diff --git a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/crashhandler/IssuerCodePart.java b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/crashhandler/IssuerCodePart.java index caffa35..3a9c5f9 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/crashhandler/IssuerCodePart.java +++ b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/crashhandler/IssuerCodePart.java @@ -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; diff --git a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/crashhandler/IssuerInfo.java b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/crashhandler/IssuerInfo.java index c3140f9..c97e821 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/crashhandler/IssuerInfo.java +++ b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/crashhandler/IssuerInfo.java @@ -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; diff --git a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/crashhandler/IssuerMessage.java b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/crashhandler/IssuerMessage.java index accdd94..60cf797 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/crashhandler/IssuerMessage.java +++ b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/crashhandler/IssuerMessage.java @@ -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; diff --git a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/crashhandler/IssuerPackage.java b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/crashhandler/IssuerPackage.java index 5be7123..a9e8602 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/crashhandler/IssuerPackage.java +++ b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/crashhandler/IssuerPackage.java @@ -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; diff --git a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/crashhandler/IssuerPath.java b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/crashhandler/IssuerPath.java index 217c6a2..d54dfb9 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/crashhandler/IssuerPath.java +++ b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/crashhandler/IssuerPath.java @@ -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; diff --git a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/crashhandler/Stacktrace.java b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/crashhandler/Stacktrace.java index 43ab919..ab2e993 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/crashhandler/Stacktrace.java +++ b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/crashhandler/Stacktrace.java @@ -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; diff --git a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/crashhandler/package-info.java b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/crashhandler/package-info.java index c865195..3d9ba95 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/crashhandler/package-info.java +++ b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/crashhandler/package-info.java @@ -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; diff --git a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/logger/LogClass.java b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/logger/LogClass.java index b85c60f..6bfdd4b 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/logger/LogClass.java +++ b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/logger/LogClass.java @@ -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; diff --git a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/logger/LogCodePart.java b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/logger/LogCodePart.java index a5eef63..a23745c 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/logger/LogCodePart.java +++ b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/logger/LogCodePart.java @@ -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; diff --git a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/logger/LogColorPrimary.java b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/logger/LogColorPrimary.java index ab35171..080c0ed 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/logger/LogColorPrimary.java +++ b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/logger/LogColorPrimary.java @@ -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; diff --git a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/logger/LogColorSecondary.java b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/logger/LogColorSecondary.java index de00dbf..4048af8 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/logger/LogColorSecondary.java +++ b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/logger/LogColorSecondary.java @@ -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; diff --git a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/logger/LogInfo.java b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/logger/LogInfo.java index 8515bf6..ba39afc 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/logger/LogInfo.java +++ b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/logger/LogInfo.java @@ -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; diff --git a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/logger/LogLevel.java b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/logger/LogLevel.java index 3564727..19ec451 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/logger/LogLevel.java +++ b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/logger/LogLevel.java @@ -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; diff --git a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/logger/LogMessage.java b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/logger/LogMessage.java index a79cd2f..653c0f3 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/logger/LogMessage.java +++ b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/logger/LogMessage.java @@ -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; diff --git a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/logger/LogPackage.java b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/logger/LogPackage.java index 2ca7ac8..6ec148a 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/logger/LogPackage.java +++ b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/logger/LogPackage.java @@ -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; diff --git a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/logger/LogPath.java b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/logger/LogPath.java index 8698891..85bb986 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/logger/LogPath.java +++ b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/logger/LogPath.java @@ -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; diff --git a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/logger/package-info.java b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/logger/package-info.java index 8e97df9..f346a2b 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/logger/package-info.java +++ b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/logger/package-info.java @@ -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; diff --git a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/package-info.java b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/package-info.java index dd8016b..b861c90 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/package-info.java +++ b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/package-info.java @@ -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; diff --git a/base/src/main/java/de/staropensource/sosengine/base/internal/types/DependencySubsystemVector.java b/base/src/main/java/de/staropensource/sosengine/base/internal/types/DependencySubsystemVector.java index 5e1e136..1d06b39 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/internal/types/DependencySubsystemVector.java +++ b/base/src/main/java/de/staropensource/sosengine/base/internal/types/DependencySubsystemVector.java @@ -32,7 +32,7 @@ import java.util.List; * Used during the subsystem initialization process to easily determine the initialization order * without much extra code and performance loss. * - * @since 1-alpha1 + * @since v1-alpha1 */ @SuppressWarnings({ "unused", "JavadocDeclaration", "JavadocBlankLines" }) @Getter @@ -46,7 +46,7 @@ public class DependencySubsystemVector extends DependencyVector { * Returns the associated {@link SubsystemMainClass}. * * @return associated {@link SubsystemMainClass} - * @since 1-alpha1 + * @since v1-alpha1 */ private final SubsystemMainClass mainClass; @@ -55,7 +55,7 @@ public class DependencySubsystemVector extends DependencyVector { * * @param vector existing dependency vector to use * @param mainClass {@link SubsystemMainClass} to associate - * @since 1-alpha1 + * @since v1-alpha1 */ public DependencySubsystemVector(@NotNull DependencyVector vector, @NotNull SubsystemMainClass mainClass) { super(vector.getIdentifier(), vector.getVersioningSystem(), vector.getVersion(), vector.getDependencies()); @@ -70,7 +70,7 @@ public class DependencySubsystemVector extends DependencyVector { * @param version version * @param dependencies dependencies in the usual format ({@code dependencyA}, {@code dependencyB=5.1}, {@code dependencyC>3.1}, {@code dependencyD<6.1}) * @param mainClass {@link SubsystemMainClass} to associate - * @since 1-alpha1 + * @since v1-alpha1 */ public DependencySubsystemVector(@NotNull String identifier, @NotNull Class versioningSystem, @NotNull String version, @NotNull List<@NotNull String> dependencies, @NotNull SubsystemMainClass mainClass) { super(identifier, versioningSystem, version, dependencies); @@ -84,7 +84,7 @@ public class DependencySubsystemVector extends DependencyVector { * @param versioningSystem versioning system to use * @param version version * @param mainClass {@link SubsystemMainClass} to associate - * @since 1-alpha1 + * @since v1-alpha1 */ public DependencySubsystemVector(@NotNull String identifier, @NotNull Class versioningSystem, @NotNull String version, @NotNull SubsystemMainClass mainClass) { super(identifier, versioningSystem, version); diff --git a/base/src/main/java/de/staropensource/sosengine/base/internal/types/QueuedLogMessage.java b/base/src/main/java/de/staropensource/sosengine/base/internal/types/QueuedLogMessage.java index 0e9dfe6..3e9c209 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/internal/types/QueuedLogMessage.java +++ b/base/src/main/java/de/staropensource/sosengine/base/internal/types/QueuedLogMessage.java @@ -27,7 +27,7 @@ import org.jetbrains.annotations.NotNull; /** * Represents a queued log message. * - * @since 1-alpha1 + * @since v1-alpha1 */ @SuppressWarnings({ "unused", "JavadocDeclaration", "JavadocBlankLines" }) @Getter @@ -35,13 +35,13 @@ public class QueuedLogMessage { /** * The log message's issuer. * - * @since 1-alpha1 + * @since v1-alpha1 * * -- GETTER -- * Returns the log message's issuer. * * @return issuer - * @since 1-alpha1 + * @since v1-alpha1 */ @NotNull private final LogIssuer issuer; @@ -49,13 +49,13 @@ public class QueuedLogMessage { /** * The log message's level. * - * @since 1-alpha1 + * @since v1-alpha1 * * -- GETTER -- * Returns the log message's level. * * @return level - * @since 1-alpha1 + * @since v1-alpha1 */ @NotNull private final LogLevel level; @@ -63,13 +63,13 @@ public class QueuedLogMessage { /** * The log message. * - * @since 1-alpha1 + * @since v1-alpha1 * * -- GETTER -- * Returns the log message. * * @return message - * @since 1-alpha1 + * @since v1-alpha1 */ @NotNull private final String message; @@ -80,7 +80,7 @@ public class QueuedLogMessage { * @param issuer log message issuer * @param level log message level * @param message log message - * @since 1-alpha1 + * @since v1-alpha1 */ public QueuedLogMessage(@NotNull LogIssuer issuer, @NotNull LogLevel level, @NotNull String message) { this.issuer = issuer; diff --git a/base/src/main/java/de/staropensource/sosengine/base/internal/types/package-info.java b/base/src/main/java/de/staropensource/sosengine/base/internal/types/package-info.java index 99b2b2d..d60f6e5 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/internal/types/package-info.java +++ b/base/src/main/java/de/staropensource/sosengine/base/internal/types/package-info.java @@ -21,6 +21,6 @@ * Contains engine-internal data types, usually for passing * data around classes more efficiently. * - * @since 1-alpha1 + * @since v1-alpha1 */ package de.staropensource.sosengine.base.internal.types; diff --git a/base/src/main/java/de/staropensource/sosengine/base/logging/CrashHandler.java b/base/src/main/java/de/staropensource/sosengine/base/logging/CrashHandler.java index 6074709..0fb2f85 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/logging/CrashHandler.java +++ b/base/src/main/java/de/staropensource/sosengine/base/logging/CrashHandler.java @@ -43,7 +43,7 @@ import java.util.List; * @see Logger * @see LoggerInstance * @see LogIssuer - * @since 1-alpha0 + * @since v1-alpha0 */ @SuppressWarnings({ "unused", "JavadocDeclaration", "JavadocBlankLines" }) public final class CrashHandler { @@ -51,19 +51,19 @@ public final class CrashHandler { /** * Contains the template used to print a crash report. * - * @since 1-alpha0 + * @since v1-alpha0 * * -- GETTER -- * Gets the template used to print a crash report. * * @return crash report template - * @since 1-alpha0 + * @since v1-alpha0 * * -- SETTER -- * Sets the template used to print a crash report. * * @param crashTemplate new crash template - * @since 1-alpha0 + * @since v1-alpha0 */ @NotNull @Getter @@ -85,13 +85,13 @@ public final class CrashHandler { /** * Contains nested {@link LinkedHashMap}s that contain the content printed at the time of a crash. * - * @since 1-alpha0 + * @since v1-alpha0 * * -- GETTER -- * Returns the nested {@link LinkedHashMap}s that contain the content printed at the time of a crash. * * @return crash content - * @since 1-alpha0 + * @since v1-alpha0 */ @NotNull @Getter @@ -100,7 +100,7 @@ public final class CrashHandler { /** * Constructs this class. * - * @since 1-alpha0 + * @since v1-alpha0 */ public CrashHandler() {} @@ -110,7 +110,7 @@ public final class CrashHandler { * @param logIssuer information about the class that caused the crash * @param message crash error detail * @param throwable simply to provide stacktrace and further insight into the crash, can be set to {@code null} - * @since 1-alpha0 + * @since v1-alpha0 */ public static synchronized void handleCrash(@NotNull LogIssuer logIssuer, @NotNull String message, @Nullable Throwable throwable, boolean throwableHandled) { if (throwable == null) @@ -169,7 +169,7 @@ public final class CrashHandler { * @param indentationSize indentation level * @return crash content string * @see CrashHandler#processCrashContent() - * @since 1-alpha0 + * @since v1-alpha0 */ /* * Note: This entire method causes a compilation warning as we are using "unchecked or unsecure operations". @@ -227,7 +227,7 @@ public final class CrashHandler { * Generates the content for a crash report. Processes {@code crashContent} and spits out a String. * * @return crash content string - * @since 1-alpha0 + * @since v1-alpha0 */ public static synchronized String processCrashContent() { return processCrashContent(crashContent, 0); diff --git a/base/src/main/java/de/staropensource/sosengine/base/logging/Logger.java b/base/src/main/java/de/staropensource/sosengine/base/logging/Logger.java index 9b0952c..c7e2690 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/logging/Logger.java +++ b/base/src/main/java/de/staropensource/sosengine/base/logging/Logger.java @@ -55,21 +55,21 @@ public final class Logger { * Refers to the active {@link LoggerImpl} that is used to process and print log messages. * * @see LoggerImpl - * @since 1-alpha0 + * @since v1-alpha0 * * -- GETTER -- * Returns the active {@link LoggerImpl}. * * @return active {@link LoggerImpl} * @see LoggerImpl - * @since 1-alpha0 + * @since v1-alpha0 * * -- SETTER -- * Sets the active {@link LoggerImpl}. * * @param loggerImplementation new active {@link LoggerImpl} * @see LoggerImpl - * @since 1-alpha0 + * @since v1-alpha0 */ @NotNull @Getter @@ -79,13 +79,13 @@ public final class Logger { /** * Refers to the logging thread. * - * @since 1-alpha1 + * @since v1-alpha1 * * -- GETTER -- * Returns the logging thread. * * @return logging thread - * @since 1-alpha1 + * @since v1-alpha1 */ @Getter @Nullable @@ -94,20 +94,20 @@ public final class Logger { /** * A list of {@link QueuedLogMessage}s. * - * @since 1-alpha1 + * @since v1-alpha1 */ private static final LinkedList queuedMessages = new LinkedList<>(); /** * Contains all active {@link LogRule}s. * - * @since 1-alpha1 + * @since v1-alpha1 * * -- GETTER -- * Returns all active {@link LogRule}s. * * @return active rules - * @since 1-alpha1 + * @since v1-alpha1 */ @Getter private static final List activeRules = new ArrayList<>(); @@ -115,14 +115,14 @@ public final class Logger { /** * Constructs this class. * - * @since 1-alpha0 + * @since v1-alpha0 */ public Logger() {} /** * Starts the logging thread. * - * @since 1-alpha1 + * @since v1-alpha1 * @see Logger#loggingThread */ public static void startLoggingThread() { @@ -154,7 +154,7 @@ public final class Logger { /** * Prints all queued log messages. * - * @since 1-alpha1 + * @since v1-alpha1 */ public static synchronized void flushLogMessages() { // Only execute code if queued messages list is not empty @@ -177,7 +177,7 @@ public final class Logger { * @param issuer log issuer * @param level log level * @param message log message - * @since 1-alpha1 + * @since v1-alpha1 */ private static void processLogMessage(@NotNull LogIssuer issuer, @NotNull LogLevel level, @NotNull String message) { // Evaluate all active rules @@ -227,7 +227,7 @@ public final class Logger { * @param issuer log issuer * @param level log level * @param message log message - * @since 1-alpha0 + * @since v1-alpha0 */ private static synchronized void log(@NotNull LogIssuer issuer, @NotNull LogLevel level, @NotNull String message) { // Check if engine has initialized @@ -250,7 +250,7 @@ public final class Logger { * * @param logIssuer issuing class * @param message diagnostic message - * @since 1-alpha0 + * @since v1-alpha0 */ public static void diag(@NotNull LogIssuer logIssuer, @NotNull String message) { log(logIssuer, LogLevel.DIAGNOSTIC, message); @@ -261,7 +261,7 @@ public final class Logger { * * @param logIssuer issuing class * @param message verbose message - * @since 1-alpha0 + * @since v1-alpha0 */ public static void verb(@NotNull LogIssuer logIssuer, @NotNull String message) { log(logIssuer, LogLevel.VERBOSE, message); @@ -272,7 +272,7 @@ public final class Logger { * * @param logIssuer issuing class * @param message silent warning message - * @since 1-alpha0 + * @since v1-alpha0 */ public static void sarn(@NotNull LogIssuer logIssuer, @NotNull String message) { log(logIssuer, LogLevel.SILENT_WARNING, message); @@ -283,7 +283,7 @@ public final class Logger { * * @param logIssuer issuing class * @param message informational message - * @since 1-alpha0 + * @since v1-alpha0 */ public static void info(@NotNull LogIssuer logIssuer, @NotNull String message) { log(logIssuer, LogLevel.INFORMATIONAL, message); @@ -294,7 +294,7 @@ public final class Logger { * * @param logIssuer issuing class * @param message warning message - * @since 1-alpha0 + * @since v1-alpha0 */ public static void warn(@NotNull LogIssuer logIssuer, @NotNull String message) { log(logIssuer, LogLevel.WARNING, message); @@ -305,7 +305,7 @@ public final class Logger { * * @param logIssuer issuing class * @param message error message - * @since 1-alpha0 + * @since v1-alpha0 */ public static void error(@NotNull LogIssuer logIssuer, @NotNull String message) { log(logIssuer, LogLevel.ERROR, message); @@ -318,7 +318,7 @@ public final class Logger { * @param message diagnostic message * @param throwable the throwable that caused this crash * @param handled declare the throwable has handled - * @since 1-alpha0 + * @since v1-alpha0 */ public static void crash(@NotNull LogIssuer logIssuer, @NotNull String message, @NotNull Throwable throwable, boolean handled) { CrashHandler.handleCrash(logIssuer, message, throwable, handled); @@ -330,7 +330,7 @@ public final class Logger { * @param logIssuer issuing class * @param message diagnostic message * @param throwable the throwable that caused this crash - * @since 1-alpha0 + * @since v1-alpha0 */ public static void crash(@NotNull LogIssuer logIssuer, @NotNull String message, @NotNull Throwable throwable) { CrashHandler.handleCrash(logIssuer, message, throwable, false); @@ -341,7 +341,7 @@ public final class Logger { * * @param logIssuer issuing class * @param message diagnostic message - * @since 1-alpha0 + * @since v1-alpha0 */ public static void crash(@NotNull LogIssuer logIssuer, @NotNull String message) { CrashHandler.handleCrash(logIssuer, message, null, false); diff --git a/base/src/main/java/de/staropensource/sosengine/base/logging/LoggerInstance.java b/base/src/main/java/de/staropensource/sosengine/base/logging/LoggerInstance.java index 40f294b..cb3edec 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/logging/LoggerInstance.java +++ b/base/src/main/java/de/staropensource/sosengine/base/logging/LoggerInstance.java @@ -26,7 +26,7 @@ import org.jetbrains.annotations.NotNull; /** * Removes the need to add {@code getClass} to all calls to {@link Logger}. * - * @since 1-alpha0 + * @since v1-alpha0 */ @SuppressWarnings({ "unused", "JavadocDeclaration", "JavadocBlankLines" }) @Getter @@ -34,13 +34,13 @@ public final class LoggerInstance { /** * Contains the class that this {@link LoggerInstance} belongs to. * - * @since 1-alpha0 + * @since v1-alpha0 * * -- GETTER -- * Returns the class that this {@link LoggerInstance} belongs to. * * @return the parent class - * @since 1-alpha0 + * @since v1-alpha0 */ @NotNull private final LogIssuer logIssuer; @@ -49,7 +49,7 @@ public final class LoggerInstance { * Creates a logger instance. * * @param logIssuer information about the parent class - * @since 1-alpha0 + * @since v1-alpha0 */ public LoggerInstance(@NotNull LogIssuer logIssuer) { this.logIssuer = logIssuer; @@ -59,7 +59,7 @@ public final class LoggerInstance { * Prints a diagnostic message. * * @param message diagnostic message - * @since 1-alpha0 + * @since v1-alpha0 */ public void diag(@NotNull String message) { Logger.diag(logIssuer, message); @@ -69,7 +69,7 @@ public final class LoggerInstance { * Prints a verbose message. * * @param message verbose message - * @since 1-alpha0 + * @since v1-alpha0 */ public void verb(@NotNull String message) { Logger.verb(logIssuer, message); @@ -79,7 +79,7 @@ public final class LoggerInstance { * Prints a silent warning message. * * @param message silent warning message - * @since 1-alpha0 + * @since v1-alpha0 */ public void sarn(@NotNull String message) { Logger.sarn(logIssuer, message); @@ -89,7 +89,7 @@ public final class LoggerInstance { * Prints an informational message. * * @param message informational message - * @since 1-alpha0 + * @since v1-alpha0 */ public void info(@NotNull String message) { Logger.info(logIssuer, message); @@ -99,7 +99,7 @@ public final class LoggerInstance { * Prints a warning message. * * @param message warning message - * @since 1-alpha0 + * @since v1-alpha0 */ public void warn(@NotNull String message) { Logger.warn(logIssuer, message); @@ -109,7 +109,7 @@ public final class LoggerInstance { * Prints an error message. * * @param message error message - * @since 1-alpha0 + * @since v1-alpha0 */ public void error(@NotNull String message) { Logger.error(logIssuer, message); @@ -122,7 +122,7 @@ public final class LoggerInstance { * @param throwable throwable that caused this crash * @param handled declare the throwable has handled * @see CrashHandler - * @since 1-alpha0 + * @since v1-alpha0 */ public void crash(@NotNull String message, @NotNull Throwable throwable, boolean handled) { Logger.crash(logIssuer, message, throwable, handled); @@ -134,7 +134,7 @@ public final class LoggerInstance { * @param message diagnostic message * @param throwable throwable that caused this crash * @see CrashHandler - * @since 1-alpha0 + * @since v1-alpha0 */ public void crash(@NotNull String message, @NotNull Throwable throwable) { Logger.crash(logIssuer, message, throwable); @@ -145,7 +145,7 @@ public final class LoggerInstance { * * @param message diagnostic message * @see CrashHandler - * @since 1-alpha0 + * @since v1-alpha0 */ public void crash(@NotNull String message) { Logger.crash(logIssuer, message); diff --git a/base/src/main/java/de/staropensource/sosengine/base/logging/implementation/ColoredLoggerImpl.java b/base/src/main/java/de/staropensource/sosengine/base/logging/implementation/ColoredLoggerImpl.java index 71fa5fe..d12761d 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/logging/implementation/ColoredLoggerImpl.java +++ b/base/src/main/java/de/staropensource/sosengine/base/logging/implementation/ColoredLoggerImpl.java @@ -34,14 +34,14 @@ import org.jetbrains.annotations.NotNull; * * @see Logger * @see LoggerImpl - * @since 1-alpha0 + * @since v1-alpha0 */ @SuppressWarnings({ "unused" }) public class ColoredLoggerImpl implements LoggerImpl { /** * Constructs this class. * - * @since 1-alpha0 + * @since v1-alpha0 */ public ColoredLoggerImpl() {} diff --git a/base/src/main/java/de/staropensource/sosengine/base/logging/implementation/PlainLoggerImpl.java b/base/src/main/java/de/staropensource/sosengine/base/logging/implementation/PlainLoggerImpl.java index 75cc629..fedbfc9 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/logging/implementation/PlainLoggerImpl.java +++ b/base/src/main/java/de/staropensource/sosengine/base/logging/implementation/PlainLoggerImpl.java @@ -32,14 +32,14 @@ import org.jetbrains.annotations.NotNull; * * @see Logger * @see LoggerImpl - * @since 1-alpha1 + * @since v1-alpha1 */ @SuppressWarnings({ "unused" }) public class PlainLoggerImpl implements LoggerImpl { /** * Constructs this class. * - * @since 1-alpha1 + * @since v1-alpha1 */ public PlainLoggerImpl() {} diff --git a/base/src/main/java/de/staropensource/sosengine/base/logging/implementation/RawLoggerImpl.java b/base/src/main/java/de/staropensource/sosengine/base/logging/implementation/RawLoggerImpl.java index 65a4a2c..d65f10b 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/logging/implementation/RawLoggerImpl.java +++ b/base/src/main/java/de/staropensource/sosengine/base/logging/implementation/RawLoggerImpl.java @@ -32,14 +32,14 @@ import org.jetbrains.annotations.NotNull; * * @see Logger * @see LoggerImpl - * @since 1-alpha1 + * @since v1-alpha1 */ @SuppressWarnings({ "unused" }) public class RawLoggerImpl implements LoggerImpl { /** * Constructs this class. * - * @since 1-alpha1 + * @since v1-alpha1 */ public RawLoggerImpl() {} diff --git a/base/src/main/java/de/staropensource/sosengine/base/logging/implementation/package-info.java b/base/src/main/java/de/staropensource/sosengine/base/logging/implementation/package-info.java index d495ecd..f7e6305 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/logging/implementation/package-info.java +++ b/base/src/main/java/de/staropensource/sosengine/base/logging/implementation/package-info.java @@ -21,6 +21,6 @@ * Contains a set of built-in logger implementations * that all print log output a bit differently. * - * @since 1-alpha1 + * @since v1-alpha1 */ package de.staropensource.sosengine.base.logging.implementation; diff --git a/base/src/main/java/de/staropensource/sosengine/base/logging/package-info.java b/base/src/main/java/de/staropensource/sosengine/base/logging/package-info.java index 9e9e0d4..8f89a15 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/logging/package-info.java +++ b/base/src/main/java/de/staropensource/sosengine/base/logging/package-info.java @@ -23,6 +23,6 @@ * @see de.staropensource.sosengine.base.logging.Logger * @see de.staropensource.sosengine.base.logging.LoggerInstance * @see de.staropensource.sosengine.base.logging.CrashHandler - * @since 1-alpha0 + * @since v1-alpha0 */ package de.staropensource.sosengine.base.logging; diff --git a/base/src/main/java/de/staropensource/sosengine/base/package-info.java b/base/src/main/java/de/staropensource/sosengine/base/package-info.java index 601cdaf..409dc3e 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/package-info.java +++ b/base/src/main/java/de/staropensource/sosengine/base/package-info.java @@ -23,6 +23,6 @@ * @see de.staropensource.sosengine.base.Engine * @since v1-alpha0 * @author jeremystartm <jeremystartm@staropensource.de> - * @since 1-alpha0 + * @since v1-alpha0 */ package de.staropensource.sosengine.base; diff --git a/base/src/main/java/de/staropensource/sosengine/base/types/CodePart.java b/base/src/main/java/de/staropensource/sosengine/base/types/CodePart.java index e7bd508..ef6d9f9 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/types/CodePart.java +++ b/base/src/main/java/de/staropensource/sosengine/base/types/CodePart.java @@ -27,28 +27,28 @@ import de.staropensource.sosengine.base.types.logging.LogIssuer; * @see LogIssuer * @see de.staropensource.sosengine.base.logging.Logger * @see de.staropensource.sosengine.base.logging.CrashHandler - * @since 1-alpha0 + * @since v1-alpha0 */ @SuppressWarnings({ "unused" }) public enum CodePart { /** * Indicates that the specified code or class belongs to the sos!engine. * - * @since 1-alpha0 + * @since v1-alpha0 */ ENGINE, /** * Indicates that the specified code or class belongs to the running application. * - * @since 1-alpha0 + * @since v1-alpha0 */ APPLICATION, /** * Indicates that the specified code or class belongs to a modification to the running application. * - * @since 1-alpha0 + * @since v1-alpha0 */ MODIFICATION } diff --git a/base/src/main/java/de/staropensource/sosengine/base/types/DependencyVector.java b/base/src/main/java/de/staropensource/sosengine/base/types/DependencyVector.java index 38e8e0a..42f41b3 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/types/DependencyVector.java +++ b/base/src/main/java/de/staropensource/sosengine/base/types/DependencyVector.java @@ -29,7 +29,7 @@ import java.util.List; /** * Represents a dependency vector, used for dependency management. * - * @since 1-alpha1 + * @since v1-alpha1 */ @SuppressWarnings({ "unused", "JavadocDeclaration", "JavadocBlankLines" }) @Getter @@ -37,13 +37,13 @@ public class DependencyVector { /** * Contains the identifier of this vector. * - * @since 1-alpha1 + * @since v1-alpha1 * * -- GETTER -- * Returns the vector identifier. * * @return vector identifier - * @since 1-alpha1 + * @since v1-alpha1 */ @NotNull private final String identifier; @@ -51,13 +51,13 @@ public class DependencyVector { /** * Determines which versioning system this vector uses. * - * @since 1-alpha1 + * @since v1-alpha1 * * -- GETTER -- * Returns the versioning system this vector uses. * * @return versioning system in use - * @since 1-alpha1 + * @since v1-alpha1 */ @NotNull private final Class versioningSystem; @@ -65,13 +65,13 @@ public class DependencyVector { /** * Contains the version of this vector. * - * @since 1-alpha1 + * @since v1-alpha1 * * -- GETTER -- * Returns the vector version. * * @return vector version - * @since 1-alpha1 + * @since v1-alpha1 */ @NotNull private final String version; @@ -79,13 +79,13 @@ public class DependencyVector { /** * Contains all vectors this vector hard-depends on. * - * @since 1-alpha1 + * @since v1-alpha1 * * -- GETTER -- * Returns all vectors this vector hard-depends on. * * @return hard dependencies - * @since 1-alpha1 + * @since v1-alpha1 */ @NotNull private final List<@NotNull String> dependencies; diff --git a/base/src/main/java/de/staropensource/sosengine/base/types/EventPriority.java b/base/src/main/java/de/staropensource/sosengine/base/types/EventPriority.java index c934b13..ac11561 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/types/EventPriority.java +++ b/base/src/main/java/de/staropensource/sosengine/base/types/EventPriority.java @@ -24,7 +24,7 @@ import de.staropensource.sosengine.base.annotations.EventListener; /** * Determines in which order events are processed. * - * @since 1-alpha0 + * @since v1-alpha0 */ @SuppressWarnings("unused") public enum EventPriority { @@ -32,42 +32,42 @@ public enum EventPriority { * {@link EventListener}s with this priority are processed first. * This event is exclusive to subsystems and should not be used by applications. * - * @since 1-alpha0 + * @since v1-alpha0 */ EXTREMELY_IMPORTANT, /** * {@link EventListener}s with this priority are executed first. * - * @since 1-alpha0 + * @since v1-alpha0 */ VERY_IMPORTANT, /** * {@link EventListener}s with this priority are executed second. * - * @since 1-alpha0 + * @since v1-alpha0 */ IMPORTANT, /** * The default event priority, {@link EventListener}s with this priority are executed third. * - * @since 1-alpha0 + * @since v1-alpha0 */ DEFAULT, /** * {@link EventListener}s with this priority are executed fourth. * - * @since 1-alpha0 + * @since v1-alpha0 */ UNIMPORTANT, /** * {@link EventListener}s with this priority are executed fifth. * - * @since 1-alpha0 + * @since v1-alpha0 */ VERY_UNIMPORTANT, @@ -75,7 +75,7 @@ public enum EventPriority { * {@link EventListener}s with this priority are processed last. * This event is exclusive to subsystems and should not be used by applications. * - * @since 1-alpha0 + * @since v1-alpha0 */ EXTREMELY_UNIMPORTANT, } diff --git a/base/src/main/java/de/staropensource/sosengine/base/types/Tristate.java b/base/src/main/java/de/staropensource/sosengine/base/types/Tristate.java index 0fb0f41..5c6dd91 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/types/Tristate.java +++ b/base/src/main/java/de/staropensource/sosengine/base/types/Tristate.java @@ -22,28 +22,28 @@ package de.staropensource.sosengine.base.types; /** * tl;dr just a boolean but it can be UNSET too. * - * @since 1-alpha1 + * @since v1-alpha1 */ @SuppressWarnings({ "unused" }) public enum Tristate { /** * Indicates that something is unset. * - * @since 1-alpha1 + * @since v1-alpha1 */ UNSET, /** * Indicates that something is true. * - * @since 1-alpha1 + * @since v1-alpha1 */ TRUE, /** * Indicates that something is false. * - * @since 1-alpha1 + * @since v1-alpha1 */ FALSE } diff --git a/base/src/main/java/de/staropensource/sosengine/base/types/VersionType.java b/base/src/main/java/de/staropensource/sosengine/base/types/VersionType.java index 4d54316..ba22552 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/types/VersionType.java +++ b/base/src/main/java/de/staropensource/sosengine/base/types/VersionType.java @@ -27,35 +27,35 @@ import de.staropensource.sosengine.base.data.versioning.StarOpenSourceVersioning * * @see StarOpenSourceVersioningSystem * @see EngineInformation#versioningType - * @since 1-alpha0 + * @since v1-alpha0 */ @SuppressWarnings({ "unused" }) public enum VersionType { /** * Indicates that the next version is in the early stages of development and is highly experimental. Behaviour may break at and time and may contain bugs and issues. * - * @since 1-alpha0 + * @since v1-alpha0 */ ALPHA, /** * Indicates that the next version is in development and is experimental. It may contain bugs and issues. * - * @since 1-alpha0 + * @since v1-alpha0 */ BETA, /** * Indicates that the application is nearing the next release. The application may be stable but needs to be tested before release. * - * @since 1-alpha0 + * @since v1-alpha0 */ RELEASE_CANDIDATE, /** * Should be used for tested, stable and working builds. * - * @since 1-alpha0 + * @since v1-alpha0 */ RELEASE } diff --git a/base/src/main/java/de/staropensource/sosengine/base/types/immutable/ImmutableArrayList.java b/base/src/main/java/de/staropensource/sosengine/base/types/immutable/ImmutableArrayList.java index bce9cc0..2ef1c5d 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/types/immutable/ImmutableArrayList.java +++ b/base/src/main/java/de/staropensource/sosengine/base/types/immutable/ImmutableArrayList.java @@ -28,14 +28,14 @@ import java.util.function.UnaryOperator; * An unmodifiable {@link ArrayList}. * * @param contained type - * @since 1-alpha1 + * @since v1-alpha1 */ @SuppressWarnings({ "unused" }) public class ImmutableArrayList extends ArrayList { /** * Creates a new immutable array list. * - * @since 1-alpha1 + * @since v1-alpha1 */ public ImmutableArrayList() {} @@ -43,7 +43,7 @@ public class ImmutableArrayList extends ArrayList { * Converts a {@link LinkedList} into a {@link ImmutableArrayList}. * * @param list {@link List} to convert - * @since 1-alpha1 + * @since v1-alpha1 */ public ImmutableArrayList(@NotNull List list) { super.addAll(list); diff --git a/base/src/main/java/de/staropensource/sosengine/base/types/immutable/ImmutableHashMap.java b/base/src/main/java/de/staropensource/sosengine/base/types/immutable/ImmutableHashMap.java index ea74471..f84894d 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/types/immutable/ImmutableHashMap.java +++ b/base/src/main/java/de/staropensource/sosengine/base/types/immutable/ImmutableHashMap.java @@ -31,14 +31,14 @@ import java.util.function.BiFunction; * * @param contained key type * @param contained value type - * @since 1-alpha1 + * @since v1-alpha1 */ @SuppressWarnings({ "unused" }) public class ImmutableHashMap extends HashMap { /** * Creates a new immutable hash map. * - * @since 1-alpha1 + * @since v1-alpha1 */ public ImmutableHashMap() {} @@ -46,7 +46,7 @@ public class ImmutableHashMap extends HashMap { * Converts a {@link Map} into a {@link ImmutableHashMap}. * * @param map {@link Map} to convert - * @since 1-alpha1 + * @since v1-alpha1 */ public ImmutableHashMap(@NotNull Map map) { for (K key : map.keySet()) diff --git a/base/src/main/java/de/staropensource/sosengine/base/types/immutable/ImmutableLinkedHashMap.java b/base/src/main/java/de/staropensource/sosengine/base/types/immutable/ImmutableLinkedHashMap.java index f56033a..a802607 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/types/immutable/ImmutableLinkedHashMap.java +++ b/base/src/main/java/de/staropensource/sosengine/base/types/immutable/ImmutableLinkedHashMap.java @@ -31,14 +31,14 @@ import java.util.function.BiFunction; * * @param contained key type * @param contained value type - * @since 1-alpha1 + * @since v1-alpha1 */ @SuppressWarnings({ "unused" }) public class ImmutableLinkedHashMap extends LinkedHashMap { /** * Creates a new immutable linked hash map. * - * @since 1-alpha1 + * @since v1-alpha1 */ public ImmutableLinkedHashMap() {} @@ -46,7 +46,7 @@ public class ImmutableLinkedHashMap extends LinkedHashMap { * Converts a {@link Map} into a {@link ImmutableLinkedHashMap}. * * @param map {@link Map} to convert - * @since 1-alpha1 + * @since v1-alpha1 */ public ImmutableLinkedHashMap(@NotNull Map map) { for (K key : map.keySet()) diff --git a/base/src/main/java/de/staropensource/sosengine/base/types/immutable/ImmutableLinkedList.java b/base/src/main/java/de/staropensource/sosengine/base/types/immutable/ImmutableLinkedList.java index 3b86d93..9cad4ea 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/types/immutable/ImmutableLinkedList.java +++ b/base/src/main/java/de/staropensource/sosengine/base/types/immutable/ImmutableLinkedList.java @@ -31,14 +31,14 @@ import java.util.function.UnaryOperator; * An unmodifiable {@link LinkedList}. * * @param contained type - * @since 1-alpha1 + * @since v1-alpha1 */ @SuppressWarnings({ "unused" }) public class ImmutableLinkedList extends LinkedList { /** * Creates a new immutable linked list. * - * @since 1-alpha1 + * @since v1-alpha1 */ public ImmutableLinkedList() {} @@ -46,7 +46,7 @@ public class ImmutableLinkedList extends LinkedList { * Converts a {@link LinkedList} into a {@link ImmutableLinkedList}. * * @param list {@link List} to convert - * @since 1-alpha1 + * @since v1-alpha1 */ public ImmutableLinkedList(@NotNull List list) { super.addAll(size(), list); diff --git a/base/src/main/java/de/staropensource/sosengine/base/types/immutable/package-info.java b/base/src/main/java/de/staropensource/sosengine/base/types/immutable/package-info.java index 238f22a..0f35a2c 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/types/immutable/package-info.java +++ b/base/src/main/java/de/staropensource/sosengine/base/types/immutable/package-info.java @@ -20,6 +20,6 @@ /** * Contains immutable versions of data types. * - * @since 1-alpha1 + * @since v1-alpha1 */ package de.staropensource.sosengine.base.types.immutable; diff --git a/base/src/main/java/de/staropensource/sosengine/base/types/logging/LogIssuer.java b/base/src/main/java/de/staropensource/sosengine/base/types/logging/LogIssuer.java index bd84f48..cb33592 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/types/logging/LogIssuer.java +++ b/base/src/main/java/de/staropensource/sosengine/base/types/logging/LogIssuer.java @@ -29,7 +29,7 @@ import org.jetbrains.annotations.Nullable; * * @see de.staropensource.sosengine.base.logging.Logger * @see de.staropensource.sosengine.base.logging.CrashHandler - * @since 1-alpha0 + * @since v1-alpha0 */ @SuppressWarnings({ "unused", "JavadocDeclaration", "JavadocBlankLines" }) @Getter @@ -41,7 +41,7 @@ public class LogIssuer { * Returns the issuing class. * * @return the issuing class - * @since 1-alpha0 + * @since v1-alpha0 */ @NotNull private final Class clazz; @@ -53,7 +53,7 @@ public class LogIssuer { * Returns additional information about the issuer. * * @return additional information about the issuer - * @since 1-alpha0 + * @since v1-alpha0 */ @Nullable private final String additionalInformation; @@ -67,7 +67,7 @@ public class LogIssuer { * Returns the {@link CodePart} that indicates whether the class belongs to the engine, application or a modification. * * @return the {@link CodePart} - * @since 1-alpha0 + * @since v1-alpha0 */ @NotNull private final CodePart codePart; @@ -78,7 +78,7 @@ public class LogIssuer { * @param clazz issuing class * @param additionalInformation additional information about the issuer * @param codePart identifies to which part of the program the class belongs to - * @since 1-alpha0 + * @since v1-alpha0 */ public LogIssuer(@NotNull Class clazz, @NotNull String additionalInformation, @NotNull CodePart codePart) { this.clazz = clazz; @@ -92,7 +92,7 @@ public class LogIssuer { * * @param clazz issuing class * @param additionalInformation additional information about the issuer - * @since 1-alpha0 + * @since v1-alpha0 */ public LogIssuer(@NotNull Class clazz, @NotNull String additionalInformation) { this.clazz = clazz; @@ -106,7 +106,7 @@ public class LogIssuer { * * @param clazz issuing class * @param codePart identifies to which part of the program the class belongs to - * @since 1-alpha0 + * @since v1-alpha0 */ public LogIssuer(@NotNull Class clazz, @NotNull CodePart codePart) { this.clazz = clazz; @@ -118,7 +118,7 @@ public class LogIssuer { * Creates a new log issuer. * * @param clazz issuing class - * @since 1-alpha0 + * @since v1-alpha0 */ public LogIssuer(@NotNull Class clazz) { this.clazz = clazz; diff --git a/base/src/main/java/de/staropensource/sosengine/base/types/logging/LogLevel.java b/base/src/main/java/de/staropensource/sosengine/base/types/logging/LogLevel.java index af7641a..19a55d3 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/types/logging/LogLevel.java +++ b/base/src/main/java/de/staropensource/sosengine/base/types/logging/LogLevel.java @@ -23,56 +23,56 @@ package de.staropensource.sosengine.base.types.logging; * Used for determining a log message's priority. * * @see de.staropensource.sosengine.base.logging.Logger - * @since 1-alpha0 + * @since v1-alpha0 */ @SuppressWarnings({ "unused" }) public enum LogLevel { /** * Indicates that the log message is diagnostic and solely provides debugging information. It is not important. * - * @since 1-alpha0 + * @since v1-alpha0 */ DIAGNOSTIC, /** * Indicates that the log message contains more details about some action. It is not important but nice to have. * - * @since 1-alpha0 + * @since v1-alpha0 */ VERBOSE, /** * Indicates that an unimportant warning occurred. * - * @since 1-alpha0 + * @since v1-alpha0 */ SILENT_WARNING, /** * Indicates that the log message provides useful information and is important. * - * @since 1-alpha0 + * @since v1-alpha0 */ INFORMATIONAL, /** * Indicates that an important warning occurred. * - * @since 1-alpha0 + * @since v1-alpha0 */ WARNING, /** * Indicates that a non-fatal error occurred. * - * @since 1-alpha0 + * @since v1-alpha0 */ ERROR, /** * Indicates that a fatal error occurred. * - * @since 1-alpha0 + * @since v1-alpha0 */ CRASH, } diff --git a/base/src/main/java/de/staropensource/sosengine/base/types/logging/LogRule.java b/base/src/main/java/de/staropensource/sosengine/base/types/logging/LogRule.java index dd5d8e3..eb56029 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/types/logging/LogRule.java +++ b/base/src/main/java/de/staropensource/sosengine/base/types/logging/LogRule.java @@ -25,7 +25,7 @@ import org.jetbrains.annotations.NotNull; /** * Defines a rule used during logging to allow or prevent certain log calls. * - * @since 1-alpha1 + * @since v1-alpha1 */ @SuppressWarnings({ "unused", "JavadocDeclaration", "JavadocBlankLines" }) @Getter @@ -34,14 +34,14 @@ public class LogRule { * Determines if the log rule should disallow or permit matching log calls. * * @see LogRuleType - * @since 1-alpha1 + * @since v1-alpha1 * * -- GETTER -- * Returns if the log rule should disallow or permit matching log calls. * * @return rule type * @see LogRuleType - * @since 1-alpha1 + * @since v1-alpha1 */ @NotNull private final LogRuleType type; diff --git a/base/src/main/java/de/staropensource/sosengine/base/types/logging/LogRuleType.java b/base/src/main/java/de/staropensource/sosengine/base/types/logging/LogRuleType.java index df9c0ed..d3159ca 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/types/logging/LogRuleType.java +++ b/base/src/main/java/de/staropensource/sosengine/base/types/logging/LogRuleType.java @@ -22,14 +22,14 @@ package de.staropensource.sosengine.base.types.logging; /** * Used for determining if a {@link LogRule} should allow (whitelist) or prevent (blacklist) log call processing. * - * @since 1-alpha1 + * @since v1-alpha1 */ @SuppressWarnings({ "unused" }) public enum LogRuleType { /** * Indicates that log calls matching this rule will always be allowed, even if blacklisted. * - * @since 1-alpha1 + * @since v1-alpha1 */ WHITELIST, @@ -37,7 +37,7 @@ public enum LogRuleType { * Indicates that log calls matching this will always be disallowed except when whitelisted. * * @see LogRuleType#WHITELIST - * @since 1-alpha1 + * @since v1-alpha1 */ BLACKLIST } diff --git a/base/src/main/java/de/staropensource/sosengine/base/types/logging/package-info.java b/base/src/main/java/de/staropensource/sosengine/base/types/logging/package-info.java index ca57a86..950bdf9 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/types/logging/package-info.java +++ b/base/src/main/java/de/staropensource/sosengine/base/types/logging/package-info.java @@ -20,6 +20,6 @@ /** * Contains logging-related data types. * - * @since 1-alpha1 + * @since v1-alpha1 */ package de.staropensource.sosengine.base.types.logging; diff --git a/base/src/main/java/de/staropensource/sosengine/base/types/package-info.java b/base/src/main/java/de/staropensource/sosengine/base/types/package-info.java index dab744c..b07a4c6 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/types/package-info.java +++ b/base/src/main/java/de/staropensource/sosengine/base/types/package-info.java @@ -20,6 +20,6 @@ /** * Contains various data types using {@link java.lang.Enum}s and regular {@code Class}es. * - * @since 1-alpha0 + * @since v1-alpha0 */ package de.staropensource.sosengine.base.types; diff --git a/base/src/main/java/de/staropensource/sosengine/base/types/vectors/Vec2.java b/base/src/main/java/de/staropensource/sosengine/base/types/vectors/Vec2.java index bb9761a..aca4a5d 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/types/vectors/Vec2.java +++ b/base/src/main/java/de/staropensource/sosengine/base/types/vectors/Vec2.java @@ -25,7 +25,7 @@ import lombok.Setter; /** * Represents a 2D float Vector. * - * @since 1-alpha0 + * @since v1-alpha0 */ @SuppressWarnings({ "unused", "JavadocDeclaration", "JavadocBlankLines" }) @Getter @@ -34,38 +34,38 @@ public class Vec2 { /** * The X axis value. * - * @since 1-alpha0 + * @since v1-alpha0 * * -- GETTER -- * Returns the X axis value. * * @return X axis value - * @since 1-alpha0 + * @since v1-alpha0 * * -- SETTER -- * Sets the X axis value. * * @param x X axis value - * @since 1-alpha0 + * @since v1-alpha0 */ private float x; /** * The Y axis value. * - * @since 1-alpha0 + * @since v1-alpha0 * * -- GETTER -- * Returns the Y axis value. * * @return Y axis value - * @since 1-alpha0 + * @since v1-alpha0 * * -- SETTER -- * Sets the Y axis value. * * @param y Y axis value - * @since 1-alpha0 + * @since v1-alpha0 */ private float y; @@ -74,7 +74,7 @@ public class Vec2 { * * @param x X axis value * @param y Y axis value - * @since 1-alpha0 + * @since v1-alpha0 */ public Vec2(float x, float y) { this.x = x; diff --git a/base/src/main/java/de/staropensource/sosengine/base/types/vectors/Vec2i.java b/base/src/main/java/de/staropensource/sosengine/base/types/vectors/Vec2i.java index f938f76..4f4eeb1 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/types/vectors/Vec2i.java +++ b/base/src/main/java/de/staropensource/sosengine/base/types/vectors/Vec2i.java @@ -25,7 +25,7 @@ import lombok.Setter; /** * Represents a 2D integer Vector. * - * @since 1-alpha0 + * @since v1-alpha0 */ @SuppressWarnings({ "unused", "JavadocDeclaration", "JavadocBlankLines" }) @Getter @@ -34,38 +34,38 @@ public class Vec2i { /** * The X axis value. * - * @since 1-alpha0 + * @since v1-alpha0 * * -- GETTER -- * Returns the X axis value. * * @return the X axis value - * @since 1-alpha0 + * @since v1-alpha0 * * -- SETTER -- * Sets the X axis value. * * @param x X axis value - * @since 1-alpha0 + * @since v1-alpha0 */ private int x; /** * The Y axis value. * - * @since 1-alpha0 + * @since v1-alpha0 * * -- GETTER -- * Returns the Y axis value. * * @return Y axis value - * @since 1-alpha0 + * @since v1-alpha0 * * -- SETTER -- * Sets the Y axis value. * * @param y Y axis value - * @since 1-alpha0 + * @since v1-alpha0 */ private int y; @@ -74,7 +74,7 @@ public class Vec2i { * * @param x X axis value * @param y Y axis value - * @since 1-alpha0 + * @since v1-alpha0 */ public Vec2i(int x, int y) { this.x = x; diff --git a/base/src/main/java/de/staropensource/sosengine/base/types/vectors/Vec3.java b/base/src/main/java/de/staropensource/sosengine/base/types/vectors/Vec3.java index aca5596..b332df4 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/types/vectors/Vec3.java +++ b/base/src/main/java/de/staropensource/sosengine/base/types/vectors/Vec3.java @@ -25,7 +25,7 @@ import lombok.Setter; /** * Represents a 3D float Vector. * - * @since 1-alpha0 + * @since v1-alpha0 */ @SuppressWarnings({ "unused", "JavadocDeclaration", "JavadocBlankLines" }) @Getter @@ -34,57 +34,57 @@ public class Vec3 { /** * The X axis value. * - * @since 1-alpha0 + * @since v1-alpha0 * * -- GETTER -- * Returns the X axis value. * * @return X axis value - * @since 1-alpha0 + * @since v1-alpha0 * * -- SETTER -- * Sets the X axis value. * * @param x X axis value - * @since 1-alpha0 + * @since v1-alpha0 */ private float x; /** * The Y axis value. * - * @since 1-alpha0 + * @since v1-alpha0 * * -- GETTER -- * Returns the Y axis value. * * @return Y axis value - * @since 1-alpha0 + * @since v1-alpha0 * * -- SETTER -- * Sets the Y axis value. * * @param y Y axis value - * @since 1-alpha0 + * @since v1-alpha0 */ private float y; /** * The Z axis value. * - * @since 1-alpha0 + * @since v1-alpha0 * * -- GETTER -- * Returns the Z axis value. * * @return Z axis value - * @since 1-alpha0 + * @since v1-alpha0 * * -- SETTER -- * Sets the Z axis value. * * @param z Z axis value - * @since 1-alpha0 + * @since v1-alpha0 */ private float z; @@ -94,7 +94,7 @@ public class Vec3 { * @param x X axis value * @param y Y axis value * @param z Z axis value - * @since 1-alpha0 + * @since v1-alpha0 */ public Vec3(float x, float y, float z) { this.x = x; diff --git a/base/src/main/java/de/staropensource/sosengine/base/types/vectors/Vec3i.java b/base/src/main/java/de/staropensource/sosengine/base/types/vectors/Vec3i.java index 3d834ae..465f8b9 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/types/vectors/Vec3i.java +++ b/base/src/main/java/de/staropensource/sosengine/base/types/vectors/Vec3i.java @@ -25,7 +25,7 @@ import lombok.Setter; /** * Represents a 3D integer Vector. * - * @since 1-alpha0 + * @since v1-alpha0 */ @SuppressWarnings({ "unused", "JavadocDeclaration", "JavadocBlankLines" }) @Getter @@ -34,57 +34,57 @@ public class Vec3i { /** * The X axis value. * - * @since 1-alpha0 + * @since v1-alpha0 * * -- GETTER -- * Returns the X axis value. * * @return X axis value - * @since 1-alpha0 + * @since v1-alpha0 * * -- SETTER -- * Sets the X axis value. * * @param x X axis value - * @since 1-alpha0 + * @since v1-alpha0 */ private int x; /** * The Y axis value. * - * @since 1-alpha0 + * @since v1-alpha0 * * -- GETTER -- * Returns the Y axis value. * * @return Y axis value - * @since 1-alpha0 + * @since v1-alpha0 * * -- SETTER -- * Sets the Y axis value. * * @param y Y axis value - * @since 1-alpha0 + * @since v1-alpha0 */ private int y; /** * The Z axis value. * - * @since 1-alpha0 + * @since v1-alpha0 * * -- GETTER -- * Returns the Z axis value. * * @return Z axis value - * @since 1-alpha0 + * @since v1-alpha0 * * -- SETTER -- * Sets the Z axis value. * * @param z Z axis value - * @since 1-alpha0 + * @since v1-alpha0 */ private int z; @@ -94,7 +94,7 @@ public class Vec3i { * @param x X axis value * @param y Y axis value * @param z Z axis value - * @since 1-alpha0 + * @since v1-alpha0 */ public Vec3i(int x, int y, int z) { this.x = x; diff --git a/base/src/main/java/de/staropensource/sosengine/base/types/vectors/package-info.java b/base/src/main/java/de/staropensource/sosengine/base/types/vectors/package-info.java index acc7d6f..522a406 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/types/vectors/package-info.java +++ b/base/src/main/java/de/staropensource/sosengine/base/types/vectors/package-info.java @@ -20,6 +20,6 @@ /** * Contains data types operating with numbers. * - * @since 1-alpha1 + * @since v1-alpha1 */ package de.staropensource.sosengine.base.types.vectors; diff --git a/base/src/main/java/de/staropensource/sosengine/base/utility/DependencyResolver.java b/base/src/main/java/de/staropensource/sosengine/base/utility/DependencyResolver.java index 787d830..3f713f5 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/utility/DependencyResolver.java +++ b/base/src/main/java/de/staropensource/sosengine/base/utility/DependencyResolver.java @@ -33,27 +33,27 @@ import java.util.*; /** * Resolves dependency vectors. * - * @since 1-alpha1 + * @since v1-alpha1 */ @SuppressWarnings({ "unused", "UnusedReturnValue" }) public final class DependencyResolver { /** * A list of {@link DependencyVector}s. * - * @since 1-alpha1 + * @since v1-alpha1 */ List vectors = new ArrayList<>(); /** * {@code true} if the current dependency vector list has been resolved successfully. * - * @since 1-alpha1 + * @since v1-alpha1 * * -- GETTER -- * Returns {@code true} if the current dependency vector list has been resolved successfully. * * @return if the current dependency vector list has been resolved - * @since 1-alpha1 + * @since v1-alpha1 */ @Getter private boolean resolved = false; @@ -68,7 +68,7 @@ public final class DependencyResolver { * * @param vector dependency vector to add * @return itself - * @since 1-alpha1 + * @since v1-alpha1 */ public synchronized DependencyResolver addVector(@NotNull DependencyVector vector) { vectors.add(vector); @@ -81,7 +81,7 @@ public final class DependencyResolver { * * @param vectors dependency vectors to add * @return itself - * @since 1-alpha1 + * @since v1-alpha1 */ public synchronized DependencyResolver addVectors(@NotNull DependencyVector[] vectors) { addVectors(Arrays.stream(vectors).toList()); @@ -94,7 +94,7 @@ public final class DependencyResolver { * * @param vectors dependency vectors to add * @return itself - * @since 1-alpha1 + * @since v1-alpha1 */ public synchronized DependencyResolver addVectors(@NotNull Collection vectors) { this.vectors.addAll(vectors); @@ -107,7 +107,7 @@ public final class DependencyResolver { * * @param vectors dependency vectors to add * @return itself - * @since 1-alpha1 + * @since v1-alpha1 */ public synchronized DependencyResolver addVectors(@NotNull List vectors) { this.vectors.addAll(vectors); @@ -120,7 +120,7 @@ public final class DependencyResolver { * * @param vectors dependency vectors to add * @return itself - * @since 1-alpha1 + * @since v1-alpha1 */ public synchronized DependencyResolver addVectors(@NotNull ImmutableArrayList vectors) { this.vectors.addAll(vectors); @@ -133,7 +133,7 @@ public final class DependencyResolver { * * @param vectors dependency vectors to add * @return itself - * @since 1-alpha1 + * @since v1-alpha1 */ public synchronized DependencyResolver addVectors(@NotNull ImmutableLinkedList vectors) { this.vectors.addAll(vectors); @@ -146,7 +146,7 @@ public final class DependencyResolver { * * @param vectors dependency vectors to add * @return itself - * @since 1-alpha1 + * @since v1-alpha1 */ public synchronized DependencyResolver addVectors(@NotNull Set vectors) { this.vectors.addAll(vectors); @@ -161,7 +161,7 @@ public final class DependencyResolver { * @return itself * @throws UnmetDependenciesException when dependencies are unmet * @throws UnexpectedThrowableException when some unknown error occurs - * @since 1-alpha1 + * @since v1-alpha1 */ @SuppressWarnings("JavaReflectionInvocation") public synchronized DependencyResolver resolve() throws UnmetDependenciesException, UnexpectedThrowableException { @@ -259,7 +259,7 @@ public final class DependencyResolver { * * @return {@link LinkedList} with dependencies first and dependents last * @throws IllegalStateException when the current dependency vector list has not been resolved yet. in this case, just invoke {@code resolve()} - * @since 1-alpha1 + * @since v1-alpha1 */ @ApiStatus.Experimental() // TODO public LinkedList getOrder() throws IllegalStateException { diff --git a/base/src/main/java/de/staropensource/sosengine/base/utility/ListFormatter.java b/base/src/main/java/de/staropensource/sosengine/base/utility/ListFormatter.java index ce0f72f..22ab54d 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/utility/ListFormatter.java +++ b/base/src/main/java/de/staropensource/sosengine/base/utility/ListFormatter.java @@ -31,7 +31,7 @@ import java.util.Set; * Converts various data types to {@link String}s. * This class is unfinished. * - * @since 1-alpha0 + * @since v1-alpha0 */ @SuppressWarnings({ "unused" }) public final class ListFormatter { diff --git a/base/src/main/java/de/staropensource/sosengine/base/utility/Miscellaneous.java b/base/src/main/java/de/staropensource/sosengine/base/utility/Miscellaneous.java index 472fe9c..7cccd01 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/utility/Miscellaneous.java +++ b/base/src/main/java/de/staropensource/sosengine/base/utility/Miscellaneous.java @@ -33,14 +33,14 @@ import java.util.stream.Collectors; /** * Contains smaller functions that don't fit into other utility classes. * - * @since 1-alpha0 + * @since v1-alpha0 */ @SuppressWarnings({ "unused" }) public final class Miscellaneous { /** * Constructs this class. * - * @since 1-alpha0 + * @since v1-alpha0 */ public Miscellaneous() {} @@ -50,7 +50,7 @@ public final class Miscellaneous { * @param number number * @param length length * @return the padded number - * @since 1-alpha0 + * @since v1-alpha0 */ @NotNull public static String padNumbers(long number, int length) { @@ -61,7 +61,7 @@ public final class Miscellaneous { * Forcefully invokes the garbage collector and blocks execution until finished.
    * If you want to run it in parallel to your program, consider running it in a {@link java.lang.VirtualThread}. * - * @since 1-alpha0 + * @since v1-alpha0 */ @SuppressWarnings("UnusedAssignment") public static void invokeGarbageCollector() { @@ -77,7 +77,7 @@ public final class Miscellaneous { * @param runnable {@link Runnable} to execute * @return execution time in milliseconds * @see Runnable - * @since 1-alpha0 + * @since v1-alpha0 */ public static long measureExecutionTime(@NotNull Runnable runnable) { long initTime = System.currentTimeMillis(); @@ -91,7 +91,7 @@ public final class Miscellaneous { * @param map map to use * @param value value to search for * @return all keys matching the specified value - * @since 1-alpha0 + * @since v1-alpha0 */ public static Set getMapValues(@NotNull Map map, @Nullable Object value) { return map @@ -106,7 +106,7 @@ public final class Miscellaneous { * * @param runnable {@link Runnable} to execute * @param identifier some identifier to distinguish {@link Runnable}s - * @since 1-alpha1 + * @since v1-alpha1 */ public static void executeSafely(@NotNull Runnable runnable, @NotNull String identifier) { try { @@ -134,7 +134,7 @@ public final class Miscellaneous { * @param separators separators to check * @param requiredOccurrences exact amount of occurrences for a separator to be deemed valid * @return separator to use or {@code null} - * @since 1-alpha1 + * @since v1-alpha1 */ @Nullable public static String getSeparator(@NotNull String string, String[] separators, int requiredOccurrences) { @@ -154,7 +154,7 @@ public final class Miscellaneous { * @param separators separators to check * @param minimumOccurrences minimum amount of occurrences for a separator to be deemed valid * @return separator to use or {@code null} - * @since 1-alpha1 + * @since v1-alpha1 */ @Nullable public static String getSeparator(@NotNull String string, List separators, Integer minimumOccurrences) { diff --git a/base/src/main/java/de/staropensource/sosengine/base/utility/PlaceholderEngine.java b/base/src/main/java/de/staropensource/sosengine/base/utility/PlaceholderEngine.java index 7e831e3..d45c837 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/utility/PlaceholderEngine.java +++ b/base/src/main/java/de/staropensource/sosengine/base/utility/PlaceholderEngine.java @@ -35,20 +35,20 @@ import java.util.List; * A modular and extensible placeholder engine. * * @see Placeholder - * @since 1-alpha0 + * @since v1-alpha0 */ @SuppressWarnings({ "unused", "JavadocDeclaration", "JavadocBlankLines" }) public final class PlaceholderEngine { /** * 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 PlaceholderEngine instance; @@ -57,12 +57,12 @@ public final class PlaceholderEngine { * Contains all global placeholders. * * @see Placeholder - * @since 1-alpha0 + * @since v1-alpha0 * -- GETTER -- * Returns the list containing all global placeholders. * * @return list of all global placeholders - * @since 1-alpha0 + * @since v1-alpha0 */ @SuppressWarnings("FieldMayBeFinal") @Getter @@ -72,7 +72,7 @@ public final class PlaceholderEngine { /** * Constructs this class. * - * @since 1-alpha0 + * @since v1-alpha0 */ public PlaceholderEngine() { // Only allow one instance @@ -141,7 +141,7 @@ public final class PlaceholderEngine { * @param text text to process * @param temporaryPlaceholders placeholders to process only for this run * @return the processed text - * @since 1-alpha0 + * @since v1-alpha0 */ @NotNull public String process(@NotNull String text, List<@NotNull Placeholder> temporaryPlaceholders) { @@ -163,7 +163,7 @@ public final class PlaceholderEngine { * * @param text text to process * @return the processed text - * @since 1-alpha0 + * @since v1-alpha0 */ @NotNull public String process(@NotNull String text) { @@ -173,7 +173,7 @@ public final class PlaceholderEngine { /** * Clears {@code instance}. Used in unit tests. * - * @since 1-alpha1 + * @since v1-alpha1 */ private static void clearInstance() { instance = null; diff --git a/base/src/main/java/de/staropensource/sosengine/base/utility/converter/AnsiShortcodeConverter.java b/base/src/main/java/de/staropensource/sosengine/base/utility/converter/AnsiShortcodeConverter.java index e2e08be..5080aa0 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/utility/converter/AnsiShortcodeConverter.java +++ b/base/src/main/java/de/staropensource/sosengine/base/utility/converter/AnsiShortcodeConverter.java @@ -27,7 +27,7 @@ import org.jetbrains.annotations.NotNull; * Converts shortcodes such as {@code } or {@code } into a usable {@link Ansi} escape sequence. * * @see ShortcodeParserSkeleton - * @since 1-alpha0 + * @since v1-alpha0 */ @SuppressWarnings({ "unused" }) public final class AnsiShortcodeConverter extends ShortcodeParserSkeleton { @@ -35,7 +35,7 @@ public final class AnsiShortcodeConverter extends ShortcodeParserSkeleton { * Constructs this class. * * @param string string to convert - * @since 1-alpha0 + * @since v1-alpha0 */ public AnsiShortcodeConverter(@NotNull String string) { super(string); @@ -45,7 +45,7 @@ public final class AnsiShortcodeConverter extends ShortcodeParserSkeleton { * Returns the parsed string as an {@link Ansi} sequence. * * @return {@link Ansi} sequence - * @since 1-alpha0 + * @since v1-alpha0 */ @NotNull public Ansi getAnsi() { diff --git a/base/src/main/java/de/staropensource/sosengine/base/utility/converter/EmptyShortcodeConverter.java b/base/src/main/java/de/staropensource/sosengine/base/utility/converter/EmptyShortcodeConverter.java index 1c3686a..ef70195 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/utility/converter/EmptyShortcodeConverter.java +++ b/base/src/main/java/de/staropensource/sosengine/base/utility/converter/EmptyShortcodeConverter.java @@ -26,7 +26,7 @@ import org.jetbrains.annotations.NotNull; * Cleans the string of any tags. * * @see ShortcodeParserSkeleton - * @since 1-alpha1 + * @since v1-alpha1 */ @SuppressWarnings({ "unused" }) public final class EmptyShortcodeConverter extends ShortcodeParserSkeleton { @@ -34,7 +34,7 @@ public final class EmptyShortcodeConverter extends ShortcodeParserSkeleton { * Constructs this class. * * @param string string to convert - * @since 1-alpha1 + * @since v1-alpha1 */ public EmptyShortcodeConverter(@NotNull String string) { super(string); @@ -44,7 +44,7 @@ public final class EmptyShortcodeConverter extends ShortcodeParserSkeleton { * Returns the parsed string without any tags. * * @return cleaned input string - * @since 1-alpha1 + * @since v1-alpha1 */ @NotNull public String getClean() { diff --git a/base/src/main/java/de/staropensource/sosengine/base/utility/converter/package-info.java b/base/src/main/java/de/staropensource/sosengine/base/utility/converter/package-info.java index 844a195..f60ccab 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/utility/converter/package-info.java +++ b/base/src/main/java/de/staropensource/sosengine/base/utility/converter/package-info.java @@ -20,6 +20,6 @@ /** * Classes in the package convert data to some other data. * - * @since 1-alpha1 + * @since v1-alpha1 */ package de.staropensource.sosengine.base.utility.converter; diff --git a/base/src/main/java/de/staropensource/sosengine/base/utility/package-info.java b/base/src/main/java/de/staropensource/sosengine/base/utility/package-info.java index 88d6b42..9d341a6 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/utility/package-info.java +++ b/base/src/main/java/de/staropensource/sosengine/base/utility/package-info.java @@ -21,6 +21,6 @@ * Provides (utility) classes specifically made for one task. * * @see de.staropensource.sosengine.base.utility.Miscellaneous - * @since 1-alpha0 + * @since v1-alpha0 */ package de.staropensource.sosengine.base.utility; diff --git a/base/src/main/java/de/staropensource/sosengine/base/utility/parser/PropertyParser.java b/base/src/main/java/de/staropensource/sosengine/base/utility/parser/PropertyParser.java index 1643305..77f6517 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/utility/parser/PropertyParser.java +++ b/base/src/main/java/de/staropensource/sosengine/base/utility/parser/PropertyParser.java @@ -32,7 +32,7 @@ import java.util.Properties; * Allows parsing various data types against a set of {@link Properties}. * * @see Properties - * @since 1-alpha0 + * @since v1-alpha0 */ @SuppressWarnings({ "unused", "JavadocDeclaration", "JavadocBlankLines" }) @NotNull @@ -41,14 +41,14 @@ public final class PropertyParser { * Contains an instance providing access to the JVM-wide properties. * * @see System#getProperties() - * @since 1-alpha0 + * @since v1-alpha0 * * -- GETTER -- * Returns an instance providing access to the JVM-wide properties. * * @return instance using the JVM-wide properties * @see System#getProperties() - * @since 1-alpha0 + * @since v1-alpha0 */ @NotNull @Getter @@ -57,14 +57,14 @@ public final class PropertyParser { * The {@link Properties} in use by this instance. * * @see Properties - * @since 1-alpha0 + * @since v1-alpha0 * * -- GETTER -- * Returns the {@link Properties} in use by this instance. * * @return the {@link Properties} in use by this instance * @see Properties - * @since 1-alpha0 + * @since v1-alpha0 */ @Getter private final @NotNull Properties properties; @@ -74,7 +74,7 @@ public final class PropertyParser { * Logger instance, * * @see LoggerInstance - * @since 1-alpha0 + * @since v1-alpha0 */ @NotNull private final LoggerInstance logger; @@ -83,7 +83,7 @@ public final class PropertyParser { * Creates a new {@link Properties} parser. * * @param properties {@link Properties} to use - * @since 1-alpha0 + * @since v1-alpha0 */ public PropertyParser(@NotNull Properties properties) { this.properties = properties; @@ -97,7 +97,7 @@ public final class PropertyParser { * @return a {@link String} * @throws NullPointerException if the specified property does not exist * @see String - * @since 1-alpha0 + * @since v1-alpha0 */ @NotNull public String getString(@NotNull String name) throws NullPointerException { @@ -115,7 +115,7 @@ public final class PropertyParser { * @return a {@link Boolean} * @throws NullPointerException if the specified property does not exist * @see Boolean - * @since 1-alpha0 + * @since v1-alpha0 */ @NotNull public Boolean getBoolean(@NotNull String name) { @@ -141,7 +141,7 @@ public final class PropertyParser { * @return a {@link Tristate} * @throws NullPointerException if the specified property does not exist * @see Tristate - * @since 1-alpha1 + * @since v1-alpha1 */ @NotNull public Tristate getTristate(@NotNull String name) { @@ -171,7 +171,7 @@ public final class PropertyParser { * @throws NullPointerException if the specified property does not exist * @throws NumberFormatException if the specified property cannot be parsed as a {@link Byte} * @see Byte - * @since 1-alpha0 + * @since v1-alpha0 */ @NotNull public Byte getByte(@NotNull String name) throws NullPointerException, NumberFormatException { @@ -196,7 +196,7 @@ public final class PropertyParser { * @throws NullPointerException if the specified property does not exist * @throws NumberFormatException if the specified property cannot be parsed as a {@link Short} * @see Short - * @since 1-alpha0 + * @since v1-alpha0 */ @NotNull public Short getShort(@NotNull String name) throws NumberFormatException { @@ -222,7 +222,7 @@ public final class PropertyParser { * @throws NullPointerException if the specified property does not exist * @throws NumberFormatException if the specified property cannot be parsed as an {@link Integer} * @see Integer - * @since 1-alpha0 + * @since v1-alpha0 */ @NotNull public Integer getInteger(@NotNull String name, boolean unsigned) throws NumberFormatException { @@ -251,7 +251,7 @@ public final class PropertyParser { * @throws NullPointerException if the specified property does not exist * @throws NumberFormatException if the specified property cannot be parsed as an {@link Long} * @see Long - * @since 1-alpha0 + * @since v1-alpha0 */ @NotNull public Long getLong(@NotNull String name, boolean unsigned) throws NumberFormatException { @@ -279,7 +279,7 @@ public final class PropertyParser { * @throws NullPointerException if the specified property does not exist * @throws NumberFormatException if the specified property cannot be parsed as an {@link Float} * @see Float - * @since 1-alpha0 + * @since v1-alpha0 */ @NotNull public Float getFloat(@NotNull String name) throws NullPointerException, NumberFormatException { @@ -304,7 +304,7 @@ public final class PropertyParser { * @throws NullPointerException if the specified property does not exist * @throws NumberFormatException if the specified property cannot be parsed as an {@link Double} * @see Double - * @since 1-alpha0 + * @since v1-alpha0 */ @NotNull public Double getDouble(@NotNull String name) throws NullPointerException, NumberFormatException { diff --git a/base/src/main/java/de/staropensource/sosengine/base/utility/parser/StackTraceParser.java b/base/src/main/java/de/staropensource/sosengine/base/utility/parser/StackTraceParser.java index cc97a06..4bac377 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/utility/parser/StackTraceParser.java +++ b/base/src/main/java/de/staropensource/sosengine/base/utility/parser/StackTraceParser.java @@ -27,7 +27,7 @@ import org.jetbrains.annotations.NotNull; * Parses the {@link StackTraceElement}s of an {@link Throwable} for use in {@link String}. * * @see Throwable - * @since 1-alpha0 + * @since v1-alpha0 */ @SuppressWarnings({ "unused", "JavadocBlankLines" }) public final class StackTraceParser { @@ -35,13 +35,13 @@ public final class StackTraceParser { * The throwable to use. * * @see Throwable - * @since 1-alpha0 + * @since v1-alpha0 * * -- GETTER -- * Returns the throwable to use. * * @see Throwable - * @since 1-alpha0 + * @since v1-alpha0 */ @Getter(AccessLevel.PROTECTED) private final @NotNull Throwable throwable; @@ -50,7 +50,7 @@ public final class StackTraceParser { * Constructs this class. * * @param throwable throwable to use - * @since 1-alpha0 + * @since v1-alpha0 */ public StackTraceParser(@NotNull Throwable throwable) { this.throwable = throwable; @@ -61,7 +61,7 @@ public final class StackTraceParser { * It looks like this: {@code Caused by java.lang.NullPointerThrowable: This application can crash!} * * @return the stack trace header - * @since 1-alpha0 + * @since v1-alpha0 */ @NotNull public String getHeader() { @@ -75,7 +75,7 @@ public final class StackTraceParser { * Returns the stack trace. * * @return the stack trace - * @since 1-alpha0 + * @since v1-alpha0 */ @NotNull public String getStackTrace() { diff --git a/base/src/main/java/de/staropensource/sosengine/base/utility/parser/package-info.java b/base/src/main/java/de/staropensource/sosengine/base/utility/parser/package-info.java index 3efd14e..b3f8cc9 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/utility/parser/package-info.java +++ b/base/src/main/java/de/staropensource/sosengine/base/utility/parser/package-info.java @@ -21,6 +21,6 @@ * Classes in this package handle parsing data * and providing that parsed data in simple ways. * - * @since 1-alpha1 + * @since v1-alpha1 */ package de.staropensource.sosengine.base.utility.parser; diff --git a/base/src/main/java/de/staropensource/sosengine/package-info.java b/base/src/main/java/de/staropensource/sosengine/package-info.java index 723511a..8a99b09 100644 --- a/base/src/main/java/de/staropensource/sosengine/package-info.java +++ b/base/src/main/java/de/staropensource/sosengine/package-info.java @@ -20,6 +20,6 @@ /** * Contains the code for the sos!engine and it's official subsystems. * - * @since 1-alpha0 + * @since v1-alpha0 */ package de.staropensource.sosengine; diff --git a/base/src/main/java/de/staropensource/sosengine/unittests/UnitConfig.java b/base/src/main/java/de/staropensource/sosengine/unittests/UnitConfig.java index cacd48d..28099ae 100644 --- a/base/src/main/java/de/staropensource/sosengine/unittests/UnitConfig.java +++ b/base/src/main/java/de/staropensource/sosengine/unittests/UnitConfig.java @@ -24,13 +24,13 @@ import de.staropensource.sosengine.base.types.logging.LogLevel; /** * Static configuration for the sos!engine unit testing helpers. * - * @since 1-alpha0 + * @since v1-alpha0 */ public class UnitConfig { /** * Constructs this class. * - * @since 1-alpha0 + * @since v1-alpha0 */ public UnitConfig() {} @@ -39,7 +39,7 @@ public class UnitConfig { * Note: The log level {@code SILENT_WARNING} has been repurposed for printing test calls. * * @see UnitLogger - * @since 1-alpha0 + * @since v1-alpha0 */ public static LogLevel loggerLevel = LogLevel.SILENT_WARNING; } diff --git a/base/src/main/java/de/staropensource/sosengine/unittests/UnitLogger.java b/base/src/main/java/de/staropensource/sosengine/unittests/UnitLogger.java index 84031c0..991d71f 100644 --- a/base/src/main/java/de/staropensource/sosengine/unittests/UnitLogger.java +++ b/base/src/main/java/de/staropensource/sosengine/unittests/UnitLogger.java @@ -28,14 +28,14 @@ import java.util.List; /** * Provides a extremely dead simple logging system for unit tests. * - * @since 1-alpha0 + * @since v1-alpha0 */ @SuppressWarnings("unused") public class UnitLogger { /** * The parent class. * - * @since 1-alpha0 + * @since v1-alpha0 */ private final Class clazz; @@ -43,7 +43,7 @@ public class UnitLogger { * Creates a new unit logger. * * @param clazz parent class - * @since 1-alpha0 + * @since v1-alpha0 */ public UnitLogger(Class clazz) { this.clazz = clazz; @@ -55,7 +55,7 @@ public class UnitLogger { * @param level log level * @param message log message * @param additionalStuff additional arguments - * @since 1-alpha0 + * @since v1-alpha0 */ private void log(@NotNull LogLevel level, @NotNull String message, List<@Nullable Object> additionalStuff) { String messageSingle = message; @@ -100,7 +100,7 @@ public class UnitLogger { * Prints a diagnostic message. * * @param message diagnostic log message - * @since 1-alpha0 + * @since v1-alpha0 */ public void diag(@NotNull String message) { log(LogLevel.DIAGNOSTIC, message, null); @@ -110,7 +110,7 @@ public class UnitLogger { * Prints a verbose message. * * @param message verbose log message - * @since 1-alpha0 + * @since v1-alpha0 */ public void verb(@NotNull String message) { log(LogLevel.VERBOSE, message, null); @@ -121,7 +121,7 @@ public class UnitLogger { * * @param methodName name of the test method called * @param methodArgs arguments of the test method called - * @since 1-alpha0 + * @since v1-alpha0 */ public void testCall(@NotNull String methodName, @Nullable Object ... methodArgs) { log(LogLevel.SILENT_WARNING, methodName, List.of(methodArgs)); @@ -131,7 +131,7 @@ public class UnitLogger { * Prints a informational message. * * @param message informational log message - * @since 1-alpha0 + * @since v1-alpha0 */ public void info(@NotNull String message) { log(LogLevel.INFORMATIONAL, message, null); @@ -141,7 +141,7 @@ public class UnitLogger { * Prints a warning message. * * @param message warning log message - * @since 1-alpha0 + * @since v1-alpha0 */ public void warn(@NotNull String message) { log(LogLevel.WARNING, message, null); @@ -151,7 +151,7 @@ public class UnitLogger { * Prints a error message. * * @param message error log message - * @since 1-alpha0 + * @since v1-alpha0 */ public void error(@NotNull String message) { log(LogLevel.ERROR, message, null); diff --git a/base/src/main/java/module-info.java b/base/src/main/java/module-info.java index 9abd19d..fd2b073 100644 --- a/base/src/main/java/module-info.java +++ b/base/src/main/java/module-info.java @@ -1,7 +1,7 @@ /** * Defines the core of the StarOpenSource Engine. * - * @since 1-alpha1 + * @since v1-alpha1 */ module sosengine.base { // Dependencies diff --git a/graphics/opengl/src/main/java/de/staropensource/sosengine/graphics/opengl/OpenGlManagement.java b/graphics/opengl/src/main/java/de/staropensource/sosengine/graphics/opengl/OpenGlManagement.java index 70b8a56..d657d8a 100644 --- a/graphics/opengl/src/main/java/de/staropensource/sosengine/graphics/opengl/OpenGlManagement.java +++ b/graphics/opengl/src/main/java/de/staropensource/sosengine/graphics/opengl/OpenGlManagement.java @@ -27,7 +27,7 @@ import org.jetbrains.annotations.NotNull; /** * The OpenGL API management class. * - * @since 1-alpha0 + * @since v1-alpha0 */ @SuppressWarnings({ "unused" }) public final class OpenGlManagement implements ApiManagementClass { diff --git a/graphics/opengl/src/main/java/de/staropensource/sosengine/graphics/opengl/OpenGlSubsystem.java b/graphics/opengl/src/main/java/de/staropensource/sosengine/graphics/opengl/OpenGlSubsystem.java index 710ba2e..648b532 100644 --- a/graphics/opengl/src/main/java/de/staropensource/sosengine/graphics/opengl/OpenGlSubsystem.java +++ b/graphics/opengl/src/main/java/de/staropensource/sosengine/graphics/opengl/OpenGlSubsystem.java @@ -45,7 +45,7 @@ import static org.lwjgl.glfw.GLFW.*; /** * The main object for the OpenGL Graphics API. * - * @since 1-alpha0 + * @since v1-alpha0 */ @SuppressWarnings({ "unused", "JavadocDeclaration", "JavadocBlankLines" }) @EngineSubsystem @@ -53,13 +53,13 @@ public final class OpenGlSubsystem implements ApiMainClass { /** * Contains the class instance. * - * @since 1-alpha0 + * @since v1-alpha0 * * -- GETTER -- * Returns the class instance. * * @return class instance unless the subsystem is uninitialized - * @since 1-alpha0 + * @since v1-alpha0 */ @Getter private static OpenGlSubsystem instance = null; @@ -68,7 +68,7 @@ public final class OpenGlSubsystem implements ApiMainClass { * Logger instance. * * @see LoggerInstance - * @since 1-alpha0 + * @since v1-alpha0 */ private final LoggerInstance logger = new LoggerInstance(new LogIssuer(getClass(), CodePart.ENGINE)); @@ -76,7 +76,7 @@ public final class OpenGlSubsystem implements ApiMainClass { * The Graphics API's management class. * * @see ApiManagementClass - * @since 1-alpha0 + * @since v1-alpha0 * * -- GETTER -- * {@inheritDoc} @@ -87,7 +87,7 @@ public final class OpenGlSubsystem implements ApiMainClass { /** * Constructs this subsystem. * - * @since 1-alpha0 + * @since v1-alpha0 */ public OpenGlSubsystem() { // Check if subsystem has already initialized @@ -161,7 +161,7 @@ public final class OpenGlSubsystem implements ApiMainClass { * Called when an OpenGL error occurs. This method just logs the error and returns. * * @param error graphics error - * @since 1-alpha0 + * @since v1-alpha0 */ @EventListener(event = GraphicsErrorEvent.class, priority = EventPriority.EXTREMELY_IMPORTANT) public static void onGraphicsError(String error) { @@ -172,7 +172,7 @@ public final class OpenGlSubsystem implements ApiMainClass { * Called when a Graphics API error occurs. This method just logs the error and returns. * * @param error Graphics API error - * @since 1-alpha0 + * @since v1-alpha0 */ @EventListener(event = GraphicsApiErrorEvent.class, priority = EventPriority.EXTREMELY_IMPORTANT) public static void onGraphicsApiError(String error) { @@ -182,7 +182,7 @@ public final class OpenGlSubsystem implements ApiMainClass { /** * Shuts the graphics subsystem down. * - * @since 1-alpha0 + * @since v1-alpha0 */ public static void shutdownApi() { LoggerInstance logger = instance.logger; diff --git a/graphics/opengl/src/main/java/de/staropensource/sosengine/graphics/opengl/classes/Window.java b/graphics/opengl/src/main/java/de/staropensource/sosengine/graphics/opengl/classes/Window.java index 6be78b0..f0ff7a0 100644 --- a/graphics/opengl/src/main/java/de/staropensource/sosengine/graphics/opengl/classes/Window.java +++ b/graphics/opengl/src/main/java/de/staropensource/sosengine/graphics/opengl/classes/Window.java @@ -37,20 +37,20 @@ import static org.lwjgl.system.MemoryUtil.NULL; /** * A window on your screen. * - * @since 1-alpha0 + * @since v1-alpha0 */ @SuppressWarnings({ "unused", "JavadocDeclaration", "JavadocBlankLines" }) public class Window implements de.staropensource.sosengine.graphics.classes.Window { /** * A set of all active windows. * - * @since 1-alpha0 + * @since v1-alpha0 * * -- GETTER -- * Returns a set of all active windows. * * @return set of all windows - * @since 1-alpha0 + * @since v1-alpha0 */ @Getter public static Set<@NotNull Window> windows = new HashSet<>(); @@ -59,20 +59,20 @@ public class Window implements de.staropensource.sosengine.graphics.classes.Wind * Logger instance. * * @see LoggerInstance - * @since 1-alpha0 + * @since v1-alpha0 */ private final LoggerInstance logger = new LoggerInstance(new LogIssuer(getClass(), CodePart.ENGINE)); /** * The window name. * - * @since 1-alpha0 + * @since v1-alpha0 * * -- GETTER -- * Returns the window name. * * @return window name - * @since 1-alpha0 + * @since v1-alpha0 */ @Getter private String windowName; @@ -80,12 +80,12 @@ public class Window implements de.staropensource.sosengine.graphics.classes.Wind /** * The window size. * - * @since 1-alpha0 + * @since v1-alpha0 * -- GETTER -- * Returns the window size. * * @return window size - * @since 1-alpha0 + * @since v1-alpha0 */ @Getter private Vec2i windowSize; diff --git a/graphics/opengl/src/main/java/de/staropensource/sosengine/graphics/opengl/events/GraphicsErrorEvent.java b/graphics/opengl/src/main/java/de/staropensource/sosengine/graphics/opengl/events/GraphicsErrorEvent.java index cc2618b..812f273 100644 --- a/graphics/opengl/src/main/java/de/staropensource/sosengine/graphics/opengl/events/GraphicsErrorEvent.java +++ b/graphics/opengl/src/main/java/de/staropensource/sosengine/graphics/opengl/events/GraphicsErrorEvent.java @@ -24,7 +24,7 @@ import org.lwjgl.glfw.GLFWErrorCallbackI; /** * Called when a graphics error occurs. * - * @since 1-alpha0 + * @since v1-alpha0 */ @SuppressWarnings({ "unused" }) public class GraphicsErrorEvent extends de.staropensource.sosengine.graphics.events.GraphicsErrorEvent implements GLFWErrorCallbackI { diff --git a/graphics/opengl/src/main/java/module-info.java b/graphics/opengl/src/main/java/module-info.java index 7199af9..58633d1 100644 --- a/graphics/opengl/src/main/java/module-info.java +++ b/graphics/opengl/src/main/java/module-info.java @@ -1,7 +1,7 @@ /** * Defines the OpenGL Graphics API and {@code opengl} subsystem, which allows for communicating with the graphics card via OpenGL. * - * @since 1-alpha1 + * @since v1-alpha1 */ module sosengine.graphics.opengl { // Dependencies diff --git a/graphics/src/main/java/de/staropensource/sosengine/graphics/GraphicsSubsystem.java b/graphics/src/main/java/de/staropensource/sosengine/graphics/GraphicsSubsystem.java index 6c2aa90..3cfb664 100644 --- a/graphics/src/main/java/de/staropensource/sosengine/graphics/GraphicsSubsystem.java +++ b/graphics/src/main/java/de/staropensource/sosengine/graphics/GraphicsSubsystem.java @@ -47,7 +47,7 @@ import java.util.Map; /** * The main object for sos!engine's graphics subsystem. * - * @since 1-alpha0 + * @since v1-alpha0 */ @SuppressWarnings({ "unused", "JavadocDeclaration", "JavadocBlankLines" }) @EngineSubsystem @@ -55,13 +55,13 @@ public final class GraphicsSubsystem implements SubsystemMainClass { /** * Contains the class instance. * - * @since 1-alpha0 + * @since v1-alpha0 * * -- GETTER -- * Returns the class instance. * * @return class instance unless the subsystem is uninitialized - * @since 1-alpha0 + * @since v1-alpha0 */ @Getter private static GraphicsSubsystem instance = null; @@ -70,7 +70,7 @@ public final class GraphicsSubsystem implements SubsystemMainClass { * Logger instance. * * @see LoggerInstance - * @since 1-alpha0 + * @since v1-alpha0 */ private final LoggerInstance logger = new LoggerInstance(new LogIssuer(getClass(), CodePart.ENGINE)); @@ -78,14 +78,14 @@ public final class GraphicsSubsystem implements SubsystemMainClass { * A list of all registered Graphics APIs. * * @see ApiMainClass - * @since 1-alpha0 + * @since v1-alpha0 * * -- GETTER -- * Returns a list of all registered Graphics APIs. * * @return list of all registered Graphics APIs * @see ApiMainClass - * @since 1-alpha0 + * @since v1-alpha0 */ @NotNull @Getter @@ -95,14 +95,14 @@ public final class GraphicsSubsystem implements SubsystemMainClass { * Reference to the active Graphics API main class. * * @see ApiMainClass - * @since 1-alpha0 + * @since v1-alpha0 * * -- GETTER -- * Returns the active Graphics API main class. * * @return active Graphics API main class * @see ApiMainClass - * @since 1-alpha0 + * @since v1-alpha0 */ @Getter private ApiMainClass api = null; @@ -110,7 +110,7 @@ public final class GraphicsSubsystem implements SubsystemMainClass { /** * Constructs this subsystem. * - * @since 1-alpha0 + * @since v1-alpha0 */ public GraphicsSubsystem() { // Check if subsystem has already initialized @@ -140,7 +140,7 @@ public final class GraphicsSubsystem implements SubsystemMainClass { /** * Precomputes all graphics subsystem events. * - * @since 1-alpha0 + * @since v1-alpha0 */ public static void precomputeEventListeners() { EventHelper.precomputeEventListeners(GraphicsApiShutdownEvent.class); @@ -157,7 +157,7 @@ public final class GraphicsSubsystem implements SubsystemMainClass { /** * Shuts the subsystem down. * - * @since 1-alpha0 + * @since v1-alpha0 */ @EventListener(event = InternalEngineShutdownEvent.class, priority = EventPriority.EXTREMELY_UNIMPORTANT) public static void shutdown() { @@ -173,7 +173,7 @@ public final class GraphicsSubsystem implements SubsystemMainClass { * Registers a Graphics API. * * @param mainClass main class of the subsystem - * @since 1-alpha0 + * @since v1-alpha0 */ public void registerGraphicsApi(@NotNull ApiMainClass mainClass) { logger.verb("Registering Graphics API " + mainClass.getApiName() + " (" + mainClass.getClass().getName() + ")"); @@ -189,7 +189,7 @@ public final class GraphicsSubsystem implements SubsystemMainClass { * * @return if a compatible Graphics API has been chosen * @see GraphicsSubsystem#setGraphicsApi(String) - * @since 1-alpha0 + * @since v1-alpha0 */ public boolean setGraphicsApi() { logger.verb("Choosing a compatible Graphics API"); @@ -230,7 +230,7 @@ public final class GraphicsSubsystem implements SubsystemMainClass { * * @param name name of the Graphics API * @see GraphicsSubsystem#setGraphicsApi() - * @since 1-alpha0 + * @since v1-alpha0 */ public void setGraphicsApi(@NotNull String name) { logger.verb("Setting Graphics API " + name); diff --git a/graphics/src/main/java/de/staropensource/sosengine/graphics/GraphicsSubsystemConfiguration.java b/graphics/src/main/java/de/staropensource/sosengine/graphics/GraphicsSubsystemConfiguration.java index 69884ea..8d8733d 100644 --- a/graphics/src/main/java/de/staropensource/sosengine/graphics/GraphicsSubsystemConfiguration.java +++ b/graphics/src/main/java/de/staropensource/sosengine/graphics/GraphicsSubsystemConfiguration.java @@ -34,7 +34,7 @@ import java.util.Properties; /** * Provides the subsystem configuration for all classes in a centralized place. * - * @since 1-alpha0 + * @since v1-alpha0 */ @SuppressWarnings({ "unused", "JavadocDeclaration", "JavadocBlankLines" }) @Getter @@ -42,13 +42,13 @@ public final class GraphicsSubsystemConfiguration implements SubsystemConfigurat /** * Contains the class instance. * - * @since 1-alpha0 + * @since v1-alpha0 * * -- GETTER -- * Returns the class instance. * * @return class instance unless {@link GraphicsSubsystem} is uninitialized - * @since 1-alpha0 + * @since v1-alpha0 */ @Getter private static GraphicsSubsystemConfiguration instance; @@ -56,13 +56,13 @@ public final class GraphicsSubsystemConfiguration implements SubsystemConfigurat /** * 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 @@ -72,14 +72,14 @@ public final class GraphicsSubsystemConfiguration implements SubsystemConfigurat * If enabled, allows for unintentional behaviour and excess logging.
    * Unless you want to debug or work on a sensitive part of the subsystem, don't enable this! * - * @since 1-alpha0 + * @since v1-alpha0 * * -- GETTER -- * Gets the value for {@code debug}. * * @return variable value * @see GraphicsSubsystemConfiguration#debug - * @since 1-alpha0 + * @since v1-alpha0 */ private boolean debug; @@ -87,14 +87,14 @@ public final class GraphicsSubsystemConfiguration implements SubsystemConfigurat * If enabled, graphical errors thrown by GLFW will be printed to the log by the subsystem. * * @see GraphicsErrorEvent - * @since 1-alpha0 + * @since v1-alpha0 * * -- GETTER -- * Gets the value for {@code errorGraphicsError}. * * @return variable value * @see GraphicsSubsystemConfiguration#errorGraphicsError - * @since 1-alpha0 + * @since v1-alpha0 */ private boolean errorGraphicsError; @@ -102,7 +102,7 @@ public final class GraphicsSubsystemConfiguration implements SubsystemConfigurat * Constructs this class. * * @see GraphicsSubsystem - * @since 1-alpha0 + * @since v1-alpha0 */ public GraphicsSubsystemConfiguration() { // Only allow one instance diff --git a/graphics/src/main/java/de/staropensource/sosengine/graphics/classes/ApiMainClass.java b/graphics/src/main/java/de/staropensource/sosengine/graphics/classes/ApiMainClass.java index 7fd826b..5a84fc3 100644 --- a/graphics/src/main/java/de/staropensource/sosengine/graphics/classes/ApiMainClass.java +++ b/graphics/src/main/java/de/staropensource/sosengine/graphics/classes/ApiMainClass.java @@ -30,14 +30,14 @@ import org.jetbrains.annotations.NotNull; /** * The interface for Graphics API main classes. * - * @since 1-alpha0 + * @since v1-alpha0 */ @SuppressWarnings({ "unused" }) public interface ApiMainClass extends SubsystemMainClass { /** * Initializes the Graphics API. * - * @since 1-alpha0 + * @since v1-alpha0 */ void initializeApi(); @@ -45,7 +45,7 @@ public interface ApiMainClass extends SubsystemMainClass { * Returns the name of the Graphics API. * * @return Graphics API name - * @since 1-alpha0 + * @since v1-alpha0 */ String getApiName(); @@ -54,7 +54,7 @@ public interface ApiMainClass extends SubsystemMainClass { * * @return a {@link ApiManagementClass} * @see ApiManagementClass - * @since 1-alpha0 + * @since v1-alpha0 */ @NotNull ApiManagementClass getManagement(); @@ -63,7 +63,7 @@ public interface ApiMainClass extends SubsystemMainClass { * Checks if the Graphics API is compatible with the underlying hardware. * * @return if the Graphics API is compatible - * @since 1-alpha0 + * @since v1-alpha0 */ boolean isCompatible(); @@ -71,7 +71,7 @@ public interface ApiMainClass extends SubsystemMainClass { * Called when a graphics error occurs. * * @param error graphics error - * @since 1-alpha0 + * @since v1-alpha0 */ @EventListener(event = GraphicsErrorEvent.class) static void onGraphicsError(String error) {} @@ -81,7 +81,7 @@ public interface ApiMainClass extends SubsystemMainClass { * * @see Engine#shutdown() * @see Engine#shutdown(int) - * @since 1-alpha0 + * @since v1-alpha0 */ @EventListener(event = InternalEngineShutdownEvent.class, priority = EventPriority.EXTREMELY_UNIMPORTANT) static void shutdownApi() {} diff --git a/graphics/src/main/java/de/staropensource/sosengine/graphics/classes/ApiManagementClass.java b/graphics/src/main/java/de/staropensource/sosengine/graphics/classes/ApiManagementClass.java index 2436b61..bd5719c 100644 --- a/graphics/src/main/java/de/staropensource/sosengine/graphics/classes/ApiManagementClass.java +++ b/graphics/src/main/java/de/staropensource/sosengine/graphics/classes/ApiManagementClass.java @@ -25,7 +25,7 @@ import org.jetbrains.annotations.NotNull; /** * The interface for Graphics API management classes. * - * @since 1-alpha0 + * @since v1-alpha0 */ @SuppressWarnings({ "unused" }) public interface ApiManagementClass { @@ -35,7 +35,7 @@ public interface ApiManagementClass { * @param title initial window title * @param size initial window size * @return new window - * @since 1-alpha0 + * @since v1-alpha0 */ @NotNull Window createWindow(String title, Vec2i size); diff --git a/graphics/src/main/java/de/staropensource/sosengine/graphics/classes/Window.java b/graphics/src/main/java/de/staropensource/sosengine/graphics/classes/Window.java index ab177c2..f99187c 100644 --- a/graphics/src/main/java/de/staropensource/sosengine/graphics/classes/Window.java +++ b/graphics/src/main/java/de/staropensource/sosengine/graphics/classes/Window.java @@ -29,14 +29,14 @@ import java.util.Set; /** * Interface for implementing windows. * - * @since 1-alpha0 + * @since v1-alpha0 */ @SuppressWarnings({ "unused" }) public interface Window { /** * A set of all active windows. * - * @since 1-alpha0 + * @since v1-alpha0 */ @NotNull Set windows = new HashSet<>(); @@ -44,7 +44,7 @@ public interface Window { /** * Contains the window identifier. * - * @since 1-alpha1 + * @since v1-alpha1 */ @NotNull String identifier = ""; @@ -52,7 +52,7 @@ public interface Window { /** * Determines the title of this window. * - * @since 1-alpha1 + * @since v1-alpha1 */ @NotNull String title = "sos!engine window (update this title)"; @@ -60,7 +60,7 @@ public interface Window { /** * Determines the size of this window. * - * @since 1-alpha1 + * @since v1-alpha1 */ @NotNull Vec2i size = new Vec2i(200, 200); @@ -68,28 +68,28 @@ public interface Window { /** * Determines in which {@link WindowMode} this window is in. * - * @since 1-alpha1 + * @since v1-alpha1 */ WindowMode mode = WindowMode.WINDOWED; /** * Determines if this window should have a border and decorations. * - * @since 1-alpha1 + * @since v1-alpha1 */ boolean borderless = false; /** * Determines if this window should be displayed on top of all other windows. * - * @since 1-alpha1 + * @since v1-alpha1 */ boolean onTop = false; /** * Determines if this window can be resized by the user. * - * @since 1-alpha1 + * @since v1-alpha1 */ boolean resizable = false; } diff --git a/graphics/src/main/java/de/staropensource/sosengine/graphics/events/GraphicsApiErrorEvent.java b/graphics/src/main/java/de/staropensource/sosengine/graphics/events/GraphicsApiErrorEvent.java index c613170..3a7c650 100644 --- a/graphics/src/main/java/de/staropensource/sosengine/graphics/events/GraphicsApiErrorEvent.java +++ b/graphics/src/main/java/de/staropensource/sosengine/graphics/events/GraphicsApiErrorEvent.java @@ -32,7 +32,7 @@ import java.lang.reflect.Method; /** * Called when a graphics error occurs. * - * @since 1-alpha0 + * @since v1-alpha0 */ @SuppressWarnings({ "unused" }) public class GraphicsApiErrorEvent implements Event { @@ -54,7 +54,7 @@ public class GraphicsApiErrorEvent implements Event { * Calls the event and notifies all annotated methods. * * @param error graphics error - * @since 1-alpha0 + * @since v1-alpha0 */ public void callEvent(@NotNull String error) { EventHelper.logCall(getClass()); diff --git a/graphics/src/main/java/de/staropensource/sosengine/graphics/events/GraphicsApiShutdownEvent.java b/graphics/src/main/java/de/staropensource/sosengine/graphics/events/GraphicsApiShutdownEvent.java index 453bac9..33d2b4e 100644 --- a/graphics/src/main/java/de/staropensource/sosengine/graphics/events/GraphicsApiShutdownEvent.java +++ b/graphics/src/main/java/de/staropensource/sosengine/graphics/events/GraphicsApiShutdownEvent.java @@ -25,7 +25,7 @@ import de.staropensource.sosengine.base.classes.helpers.EventHelper; /** * Called when the Graphics API shuts down. * - * @since 1-alpha0 + * @since v1-alpha0 */ @SuppressWarnings({ "unused" }) public class GraphicsApiShutdownEvent implements Event { diff --git a/graphics/src/main/java/de/staropensource/sosengine/graphics/events/GraphicsErrorEvent.java b/graphics/src/main/java/de/staropensource/sosengine/graphics/events/GraphicsErrorEvent.java index d110652..c465471 100644 --- a/graphics/src/main/java/de/staropensource/sosengine/graphics/events/GraphicsErrorEvent.java +++ b/graphics/src/main/java/de/staropensource/sosengine/graphics/events/GraphicsErrorEvent.java @@ -32,7 +32,7 @@ import java.lang.reflect.Method; /** * Called when a graphics error occurs. * - * @since 1-alpha0 + * @since v1-alpha0 */ @SuppressWarnings({ "unused" }) public class GraphicsErrorEvent implements Event { @@ -54,7 +54,7 @@ public class GraphicsErrorEvent implements Event { * Calls the event and notifies all annotated methods. * * @param error graphics error - * @since 1-alpha0 + * @since v1-alpha0 */ public void callEvent(@NotNull String error) { EventHelper.logCall(getClass()); diff --git a/graphics/src/main/java/de/staropensource/sosengine/graphics/types/WindowMode.java b/graphics/src/main/java/de/staropensource/sosengine/graphics/types/WindowMode.java index 66e12f2..9ad209a 100644 --- a/graphics/src/main/java/de/staropensource/sosengine/graphics/types/WindowMode.java +++ b/graphics/src/main/java/de/staropensource/sosengine/graphics/types/WindowMode.java @@ -22,14 +22,14 @@ package de.staropensource.sosengine.graphics.types; /** * Determines how a window should be displayed. * - * @since 1-alpha1 + * @since v1-alpha1 */ @SuppressWarnings({ "unused" }) public enum WindowMode { /** * Makes the window able to be dragged around. * - * @since 1-alpha1 + * @since v1-alpha1 */ WINDOWED, @@ -37,7 +37,7 @@ public enum WindowMode { * Same as {@code WINDOWED} mode, but the window will have * the same size as the monitor it is currently on. * - * @since 1-alpha1 + * @since v1-alpha1 */ BORDERLESS_FULLSCREEN, @@ -45,7 +45,7 @@ public enum WindowMode { * Makes the window occupy the entire monitor it is currently on * without allowing other windows to occupy the same space. * - * @since 1-alpha1 + * @since v1-alpha1 */ EXCLUSIVE_FULLSCREEN } diff --git a/graphics/src/main/java/module-info.java b/graphics/src/main/java/module-info.java index 7e5ef3e..5b4f4c4 100644 --- a/graphics/src/main/java/module-info.java +++ b/graphics/src/main/java/module-info.java @@ -1,7 +1,7 @@ /** * Defines the {@code graphics} subsystem, which allows creating windows and drawing pixels onto the screen. * - * @since 1-alpha1 + * @since v1-alpha1 */ module sosengine.graphics { // Dependencies diff --git a/graphics/vulkan/src/main/java/de/staropensource/sosengine/graphics/vulkan/VulkanManagement.java b/graphics/vulkan/src/main/java/de/staropensource/sosengine/graphics/vulkan/VulkanManagement.java index 442ff5e..15d9122 100644 --- a/graphics/vulkan/src/main/java/de/staropensource/sosengine/graphics/vulkan/VulkanManagement.java +++ b/graphics/vulkan/src/main/java/de/staropensource/sosengine/graphics/vulkan/VulkanManagement.java @@ -27,7 +27,7 @@ import org.jetbrains.annotations.NotNull; /** * The Vulkan API management class. * - * @since 1-alpha0 + * @since v1-alpha0 */ @SuppressWarnings({ "unused" }) public class VulkanManagement implements ApiManagementClass { diff --git a/graphics/vulkan/src/main/java/de/staropensource/sosengine/graphics/vulkan/VulkanSubsystem.java b/graphics/vulkan/src/main/java/de/staropensource/sosengine/graphics/vulkan/VulkanSubsystem.java index 01b425f..3725750 100644 --- a/graphics/vulkan/src/main/java/de/staropensource/sosengine/graphics/vulkan/VulkanSubsystem.java +++ b/graphics/vulkan/src/main/java/de/staropensource/sosengine/graphics/vulkan/VulkanSubsystem.java @@ -42,7 +42,7 @@ import static org.lwjgl.glfw.GLFW.*; /** * The main object for the Vulkan Graphics API. * - * @since 1-alpha0 + * @since v1-alpha0 */ @SuppressWarnings({ "unused", "JavadocDeclaration", "JavadocBlankLines" }) @EngineSubsystem @@ -50,13 +50,13 @@ public final class VulkanSubsystem implements ApiMainClass { /** * Contains the class instance. * - * @since 1-alpha0 + * @since v1-alpha0 * * -- GETTER -- * Returns the class instance. * * @return class instance unless the subsystem is uninitialized - * @since 1-alpha0 + * @since v1-alpha0 */ @Getter private static VulkanSubsystem instance = null; @@ -65,7 +65,7 @@ public final class VulkanSubsystem implements ApiMainClass { * Logger instance. * * @see LoggerInstance - * @since 1-alpha0 + * @since v1-alpha0 */ private final LoggerInstance logger = new LoggerInstance(new LogIssuer(getClass(), CodePart.ENGINE)); @@ -73,7 +73,7 @@ public final class VulkanSubsystem implements ApiMainClass { * The Graphics API management class. * * @see ApiManagementClass - * @since 1-alpha0 + * @since v1-alpha0 * * -- GETTER -- * {@inheritDoc} @@ -84,7 +84,7 @@ public final class VulkanSubsystem implements ApiMainClass { /** * Constructs this subsystem. * - * @since 1-alpha0 + * @since v1-alpha0 */ public VulkanSubsystem() { // Check if subsystem has already initialized @@ -147,7 +147,7 @@ public final class VulkanSubsystem implements ApiMainClass { * Called when a graphics error occurs. This method just logs the error and returns. * * @param error graphics error - * @since 1-alpha0 + * @since v1-alpha0 */ @EventListener(event = GraphicsErrorEvent.class, priority = EventPriority.EXTREMELY_IMPORTANT) public static void onGraphicsError(String error) { @@ -157,7 +157,7 @@ public final class VulkanSubsystem implements ApiMainClass { /** * Shuts the graphics subsystem down. * - * @since 1-alpha0 + * @since v1-alpha0 */ public static void shutdownApi() { LoggerInstance logger = instance.logger; diff --git a/graphics/vulkan/src/main/java/de/staropensource/sosengine/graphics/vulkan/events/GraphicsErrorEvent.java b/graphics/vulkan/src/main/java/de/staropensource/sosengine/graphics/vulkan/events/GraphicsErrorEvent.java index c218ab0..afd2706 100644 --- a/graphics/vulkan/src/main/java/de/staropensource/sosengine/graphics/vulkan/events/GraphicsErrorEvent.java +++ b/graphics/vulkan/src/main/java/de/staropensource/sosengine/graphics/vulkan/events/GraphicsErrorEvent.java @@ -24,7 +24,7 @@ import org.lwjgl.glfw.GLFWErrorCallbackI; /** * Called when a graphics error occurs. * - * @since 1-alpha0 + * @since v1-alpha0 */ @SuppressWarnings({ "unused" }) public class GraphicsErrorEvent extends de.staropensource.sosengine.graphics.events.GraphicsErrorEvent implements GLFWErrorCallbackI { diff --git a/graphics/vulkan/src/main/java/module-info.java b/graphics/vulkan/src/main/java/module-info.java index 33ed9f5..b759ce8 100644 --- a/graphics/vulkan/src/main/java/module-info.java +++ b/graphics/vulkan/src/main/java/module-info.java @@ -1,7 +1,7 @@ /** * Defines the Vulkan Graphics API and {@code vulkan} subsystem, which allows for communicating with the graphics card via Vulkan. * - * @since 1-alpha1 + * @since v1-alpha1 */ module sosengine.graphics.vulkan { // Dependencies diff --git a/slf4j-compat/src/main/java/de/staropensource/sosengine/slf4j_compat/CompatibilityLogger.java b/slf4j-compat/src/main/java/de/staropensource/sosengine/slf4j_compat/CompatibilityLogger.java index 637797b..cb138cc 100644 --- a/slf4j-compat/src/main/java/de/staropensource/sosengine/slf4j_compat/CompatibilityLogger.java +++ b/slf4j-compat/src/main/java/de/staropensource/sosengine/slf4j_compat/CompatibilityLogger.java @@ -37,7 +37,7 @@ import org.slf4j.helpers.NormalizedParameters; /** * A SLF4J Logger that redirects all log calls to sos!engine's logger. * - * @since 1-alpha0 + * @since v1-alpha0 */ @SuppressWarnings({ "unused" }) public class CompatibilityLogger extends LegacyAbstractLogger { @@ -45,7 +45,7 @@ public class CompatibilityLogger extends LegacyAbstractLogger { * Logger instance, used to print all log messages coming from SLF4J. * * @see LoggerInstance - * @since 1-alpha0 + * @since v1-alpha0 */ private final LoggerInstance logger = new LoggerInstance(new LogIssuer(getClass(), CodePart.ENGINE)); @@ -53,7 +53,7 @@ public class CompatibilityLogger extends LegacyAbstractLogger { * Protected access allows only {@link CompatibilityLoggerFactory} and also derived classes to instantiate * {@link CompatibilityLogger} instances. * - * @since 1-alpha0 + * @since v1-alpha0 */ protected CompatibilityLogger(String name) { this.name = name; @@ -63,7 +63,7 @@ public class CompatibilityLogger extends LegacyAbstractLogger { * Returns the fully qualified caller name. * * @return null - * @since 1-alpha0 + * @since v1-alpha0 */ @Nullable @Override @@ -76,7 +76,7 @@ public class CompatibilityLogger extends LegacyAbstractLogger { * * @return {@code LogLevel.DIAGNOSTIC} status * @see LogLevel#DIAGNOSTIC - * @since 1-alpha0 + * @since v1-alpha0 */ public boolean isTraceEnabled() { return isLevelAllowed(LogLevel.DIAGNOSTIC); @@ -87,7 +87,7 @@ public class CompatibilityLogger extends LegacyAbstractLogger { * * @return {@code LogLevel.VERBOSE} status * @see LogLevel#VERBOSE - * @since 1-alpha0 + * @since v1-alpha0 */ public boolean isDebugEnabled() { return isLevelAllowed(LogLevel.VERBOSE); @@ -98,7 +98,7 @@ public class CompatibilityLogger extends LegacyAbstractLogger { * * @return {@code LogLevel.INFORMATIONAL} status * @see LogLevel#INFORMATIONAL - * @since 1-alpha0 + * @since v1-alpha0 */ public boolean isInfoEnabled() { return isLevelAllowed(LogLevel.INFORMATIONAL); @@ -109,7 +109,7 @@ public class CompatibilityLogger extends LegacyAbstractLogger { * * @return {@code LogLevel.WARNING} status * @see LogLevel#WARNING - * @since 1-alpha0 + * @since v1-alpha0 */ public boolean isWarnEnabled() { return isLevelAllowed(LogLevel.WARNING); @@ -120,7 +120,7 @@ public class CompatibilityLogger extends LegacyAbstractLogger { * * @return {@code LogLevel.ERROR} status * @see LogLevel#ERROR - * @since 1-alpha0 + * @since v1-alpha0 */ public boolean isErrorEnabled() { return isLevelAllowed(LogLevel.ERROR); @@ -135,7 +135,7 @@ public class CompatibilityLogger extends LegacyAbstractLogger { * @param arguments array of arguments to be formatted, may be null * @param throwable exception whose stack trace should be logged, may be null * @see CompatibilityLogger#forwardLogCall(Level, String, Object[], Throwable) - * @since 1-alpha0 + * @since v1-alpha0 */ @Override protected void handleNormalizedLoggingCall(Level level, Marker marker, String messagePattern, Object[] arguments, Throwable throwable) { @@ -147,7 +147,7 @@ public class CompatibilityLogger extends LegacyAbstractLogger { * * @param event a {@link LoggingEvent} * @see CompatibilityLogger#forwardLogCall(Level, String, Object[], Throwable) - * @since 1-alpha0 + * @since v1-alpha0 */ @SuppressWarnings("unused") public void log(@NotNull LoggingEvent event) { @@ -160,7 +160,7 @@ public class CompatibilityLogger extends LegacyAbstractLogger { * * @param level log level to check * @return whether the logger is enabled for the given level - * @since 1-alpha0 + * @since v1-alpha0 */ protected boolean isLevelAllowed(LogLevel level) { if (Engine.getInstance() == null || EngineConfiguration.getInstance() == null) @@ -176,7 +176,7 @@ public class CompatibilityLogger extends LegacyAbstractLogger { * @param pattern message pattern * @param arguments unused * @param throwable throwable - * @since 1-alpha0 + * @since v1-alpha0 */ private void forwardLogCall(Level level, String pattern, Object[] arguments, Throwable throwable) { String message = MessageFormatter.basicArrayFormat(pattern, arguments); diff --git a/slf4j-compat/src/main/java/de/staropensource/sosengine/slf4j_compat/CompatibilityLoggerFactory.java b/slf4j-compat/src/main/java/de/staropensource/sosengine/slf4j_compat/CompatibilityLoggerFactory.java index f113523..2c2a601 100644 --- a/slf4j-compat/src/main/java/de/staropensource/sosengine/slf4j_compat/CompatibilityLoggerFactory.java +++ b/slf4j-compat/src/main/java/de/staropensource/sosengine/slf4j_compat/CompatibilityLoggerFactory.java @@ -29,7 +29,7 @@ import java.util.concurrent.ConcurrentMap; /** * A factory for {@link CompatibilityLogger}. * - * @since 1-alpha0 + * @since v1-alpha0 */ @SuppressWarnings({ "unused", "JavadocBlankLines" }) public class CompatibilityLoggerFactory implements ILoggerFactory { @@ -38,7 +38,7 @@ public class CompatibilityLoggerFactory implements ILoggerFactory { /** * Constructs this class. * - * @since 1-alpha0 + * @since v1-alpha0 */ public CompatibilityLoggerFactory() { loggerMap = new ConcurrentHashMap<>(); @@ -50,7 +50,7 @@ public class CompatibilityLoggerFactory implements ILoggerFactory { * This method will call {@link #createLogger(String)} if the logger * has not been created yet. * - * @since 1-alpha0 + * @since v1-alpha0 */ public Logger getLogger(String name) { return loggerMap.computeIfAbsent(name, this::createLogger); @@ -59,7 +59,7 @@ public class CompatibilityLoggerFactory implements ILoggerFactory { /** * Actually creates the logger for the given name. * - * @since 1-alpha0 + * @since v1-alpha0 */ protected Logger createLogger(String name) { return new CompatibilityLogger(name); diff --git a/slf4j-compat/src/main/java/de/staropensource/sosengine/slf4j_compat/CompatibilityLoggerProvider.java b/slf4j-compat/src/main/java/de/staropensource/sosengine/slf4j_compat/CompatibilityLoggerProvider.java index 2320dd7..8578a90 100644 --- a/slf4j-compat/src/main/java/de/staropensource/sosengine/slf4j_compat/CompatibilityLoggerProvider.java +++ b/slf4j-compat/src/main/java/de/staropensource/sosengine/slf4j_compat/CompatibilityLoggerProvider.java @@ -30,7 +30,7 @@ import org.slf4j.spi.SLF4JServiceProvider; /** * Provider for {@link CompatibilityLogger}. * - * @since 1-alpha0 + * @since v1-alpha0 */ @SuppressWarnings({ "unused", "JavadocBlankLines" }) @Getter @@ -39,26 +39,26 @@ public class CompatibilityLoggerProvider implements SLF4JServiceProvider { * Declare the version of the SLF4J API this implementation is compiled against. * The value of this field is modified with each major release. * - * @since 1-alpha0 + * @since v1-alpha0 * * -- GETTER -- * {@inheritDoc} * - * @since 1-alpha0 + * @since v1-alpha0 */ public String requestedApiVersion = "2.0.99"; /** * Contains a {@link CompatibilityLoggerFactory}. * - * @since 1-alpha0 + * @since v1-alpha0 */ private ILoggerFactory loggerFactory; /** * Contains a {@link BasicMarkerFactory}. * - * @since 1-alpha0 + * @since v1-alpha0 * * -- GETTER -- * {@inheritDoc} @@ -68,19 +68,19 @@ public class CompatibilityLoggerProvider implements SLF4JServiceProvider { /** * Contains a {@link NOPMDCAdapter}. * - * @since 1-alpha0 + * @since v1-alpha0 * * -- GETTER -- * {@inheritDoc} * - * @since 1-alpha0 + * @since v1-alpha0 */ private MDCAdapter mDCAdapter; /** * Constructs this class. * - * @since 1-alpha0 + * @since v1-alpha0 */ public CompatibilityLoggerProvider() {} diff --git a/slf4j-compat/src/main/java/de/staropensource/sosengine/slf4j_compat/Slf4jCompatibilitySubsystem.java b/slf4j-compat/src/main/java/de/staropensource/sosengine/slf4j_compat/Slf4jCompatibilitySubsystem.java index 4920cf8..98196d8 100644 --- a/slf4j-compat/src/main/java/de/staropensource/sosengine/slf4j_compat/Slf4jCompatibilitySubsystem.java +++ b/slf4j-compat/src/main/java/de/staropensource/sosengine/slf4j_compat/Slf4jCompatibilitySubsystem.java @@ -37,7 +37,7 @@ import org.slf4j.LoggerFactory; * Main object for the SLF4J Compatibility subsystem.
    * Note: Forwarded SLF4J messages do not trigger {@link LogEvent}s to prevent stack overflows. * - * @since 1-alpha0 + * @since v1-alpha0 */ @SuppressWarnings({ "unused", "JavadocDeclaration", "JavadocBlankLines" }) @EngineSubsystem @@ -45,13 +45,13 @@ public class Slf4jCompatibilitySubsystem implements SubsystemMainClass { /** * Contains the class instance. * - * @since 1-alpha0 + * @since v1-alpha0 * * -- GETTER -- * Returns the class instance. * * @return class instance unless the subsystem is uninitialized - * @since 1-alpha0 + * @since v1-alpha0 */ @Getter private static Slf4jCompatibilitySubsystem instance = null; diff --git a/slf4j-compat/src/main/java/module-info.java b/slf4j-compat/src/main/java/module-info.java index 476371c..d9fabcf 100644 --- a/slf4j-compat/src/main/java/module-info.java +++ b/slf4j-compat/src/main/java/module-info.java @@ -1,7 +1,7 @@ /** * Defines the {@code slf4j-compat} subsystem, which helps bridging the gap between SLF4J and the sos!engine by forwarding all SLF4J calls to the engine you love. * - * @since 1-alpha1 + * @since v1-alpha1 */ module sosengine.slf4j_compat { // Dependencies diff --git a/testapp/src/main/java/de/staropensource/sosengine/testapp/Main.java b/testapp/src/main/java/de/staropensource/sosengine/testapp/Main.java index bac35c3..4ac355a 100644 --- a/testapp/src/main/java/de/staropensource/sosengine/testapp/Main.java +++ b/testapp/src/main/java/de/staropensource/sosengine/testapp/Main.java @@ -38,13 +38,13 @@ public class Main { /** * Contains the class instance. * - * @since 1-alpha0 + * @since v1-alpha0 * * -- GETTER -- * Returns the class instance. * * @return class instance - * @since 1-alpha0 + * @since v1-alpha0 */ @Getter private static final Main instance = new Main(); diff --git a/testapp/src/main/java/module-info.java b/testapp/src/main/java/module-info.java index c56b0a9..ff96361 100644 --- a/testapp/src/main/java/module-info.java +++ b/testapp/src/main/java/module-info.java @@ -2,7 +2,7 @@ * Defines the sos!engine test application, used by engine developers to test their changes. * This module is very uninteresting for non-engine developers. * - * @since 1-alpha1 + * @since v1-alpha1 */ open module sosengine.testapp { // Dependencies