From 0075b465cdc9676abf7b467b0ee4f7de7fcb6cfa Mon Sep 17 00:00:00 2001 From: JeremyStarTM Date: Sat, 28 Sep 2024 21:45:09 +0200 Subject: [PATCH] Update Javadoc and class constructors --- .../engine/ansi/AnsiLoggingAdapter.java | 2 +- .../engine/ansi/AnsiShortcodeConverter.java | 2 +- .../engine/ansi/AnsiSubsystem.java | 4 +-- .../de/staropensource/engine/base/Engine.java | 18 ++++++++++--- .../engine/base/EngineConfiguration.java | 12 +++------ .../engine/base/EngineInternals.java | 6 ++--- .../engine/base/event/EngineCrashEvent.java | 2 +- .../base/event/EngineShutdownEvent.java | 2 +- .../base/event/EngineSoftCrashEvent.java | 2 +- .../engine/base/event/LogEvent.java | 2 +- .../base/event/ThrowableCatchEvent.java | 2 +- .../exception/IllegalAccessException.java | 4 +-- .../base/exception/ParserException.java | 2 +- .../TristateConversionException.java | 2 +- .../UnexpectedCheckEndException.java | 4 +-- .../dependency/DependencyCycleException.java | 2 +- .../UnmetDependenciesException.java | 2 +- .../reflection/IncompatibleTypeException.java | 4 +-- ...tanceMethodFromStaticContextException.java | 2 +- .../reflection/InvalidFieldException.java | 2 +- .../reflection/InvalidMethodException.java | 2 +- .../InvalidMethodSignatureException.java | 2 +- .../reflection/NoAccessException.java | 2 +- .../StaticInitializerException.java | 2 +- ...IncompatibleVersioningSystemException.java | 2 +- .../InvalidVersionStringException.java | 8 +++--- .../base/implementable/Configuration.java | 4 +-- .../base/implementable/EventListenerCode.java | 4 +-- .../base/implementable/ShortcodeParser.java | 4 +-- .../base/implementable/SubsystemClass.java | 16 ++++++------ .../implementable/helper/EventHelper.java | 2 +- .../logging/PlainLoggingAdapter.java | 2 +- .../logging/QuietLoggingAdapter.java | 2 +- .../logging/RawLoggingAdapter.java | 2 +- .../shortcode/EmptyShortcodeConverter.java | 2 +- .../FourNumberVersioningSystem.java | 3 ++- .../versioning/OneNumberVersioningSystem.java | 3 ++- .../versioning/SemanticVersioningSystem.java | 3 ++- .../StarOpenSourceVersioningSystem.java | 3 ++- .../ThreeNumberVersioningSystem.java | 3 ++- .../versioning/TwoNumberVersioningSystem.java | 3 ++- .../event/InternalEngineShutdownEvent.java | 2 +- .../implementation/EventListenerMethod.java | 2 +- .../implementation/placeholder/DateDay.java | 2 +- .../implementation/placeholder/DateMonth.java | 2 +- .../implementation/placeholder/DateYear.java | 2 +- .../placeholder/EngineDependencyJansi.java | 2 +- .../placeholder/EngineDependencyLwjgl.java | 2 +- .../EngineDependencyReflections.java | 2 +- .../placeholder/EngineDependencySlf4j.java | 2 +- .../placeholder/EngineGitBranch.java | 2 +- .../placeholder/EngineGitCommitHeader.java | 2 +- .../placeholder/EngineGitCommitIdLong.java | 2 +- .../placeholder/EngineGitCommitIdShort.java | 2 +- .../placeholder/EngineGitCommitTimeDay.java | 2 +- .../placeholder/EngineGitCommitTimeHour.java | 2 +- .../EngineGitCommitTimeMinute.java | 2 +- .../placeholder/EngineGitCommitTimeMonth.java | 2 +- .../EngineGitCommitTimeSecond.java | 2 +- .../placeholder/EngineGitCommitTimeYear.java | 2 +- .../placeholder/EngineGitCommits.java | 2 +- .../placeholder/EngineGitCommitterEmail.java | 2 +- .../placeholder/EngineGitCommitterName.java | 2 +- .../placeholder/EngineGitDirty.java | 2 +- .../placeholder/EngineVersion.java | 2 +- .../placeholder/EngineVersionFork.java | 2 +- .../placeholder/EngineVersionType.java | 2 +- .../placeholder/EngineVersionTyperelease.java | 2 +- .../placeholder/EngineVersionVersion.java | 2 +- .../placeholder/JvmArguments.java | 2 +- .../placeholder/JvmImplementationName.java | 2 +- .../placeholder/JvmImplementationVendor.java | 2 +- .../placeholder/JvmImplementationVersion.java | 2 +- .../implementation/placeholder/JvmJava.java | 2 +- .../implementation/placeholder/JvmUptime.java | 2 +- .../implementation/placeholder/TimeEpoch.java | 2 +- .../implementation/placeholder/TimeHour.java | 2 +- .../placeholder/TimeMinute.java | 2 +- .../placeholder/TimeSecond.java | 2 +- .../implementation/placeholder/TimeZone.java | 2 +- .../crashhandler/CrashMessage.java | 4 +-- .../placeholder/crashhandler/IssuerClass.java | 4 +-- .../crashhandler/IssuerMetadata.java | 4 +-- .../crashhandler/IssuerOrigin.java | 4 +-- .../crashhandler/IssuerPackage.java | 4 +-- .../placeholder/crashhandler/IssuerPath.java | 4 +-- .../placeholder/crashhandler/Stacktrace.java | 4 +-- .../crashhandler/StacktraceAll.java | 2 +- .../placeholder/logger/LogClass.java | 4 +-- .../placeholder/logger/LogColorPrimary.java | 4 +-- .../placeholder/logger/LogColorSecondary.java | 4 +-- .../placeholder/logger/LogMetadata.java | 4 +-- .../placeholder/logger/LogOrigin.java | 4 +-- .../placeholder/logger/LogPackage.java | 4 +-- .../placeholder/logger/LogPath.java | 4 +-- .../reflection/ReflectionAccessWidener.java | 4 +-- .../type/DependencySubsystemVector.java | 3 ++- .../base/internal/type/QueuedLogMessage.java | 2 +- .../engine/base/logging/CrashHandler.java | 6 ++--- .../engine/base/logging/InitLogger.java | 9 ++++--- .../engine/base/logging/Logger.java | 6 ++--- .../engine/base/logging/LoggerInstance.java | 2 +- .../engine/base/logging/LoggingThread.java | 5 ++-- .../base/logging/PrintStreamService.java | 4 +-- .../base/reflection/ClasspathAccess.java | 4 +-- .../engine/base/reflection/Reflect.java | 4 +-- .../base/reflection/ReflectionClass.java | 2 +- .../base/reflection/ReflectionField.java | 3 +-- .../base/reflection/ReflectionMethod.java | 4 +-- .../engine/base/type/Color.java | 2 +- .../engine/base/type/DependencyVector.java | 2 +- .../type/immutable/ImmutableArrayList.java | 3 ++- .../base/type/immutable/ImmutableHashMap.java | 3 ++- .../base/type/immutable/ImmutableHashSet.java | 3 ++- .../immutable/ImmutableLinkedHashMap.java | 3 ++- .../type/immutable/ImmutableLinkedList.java | 3 ++- .../engine/base/type/logging/LogRule.java | 2 +- .../engine/base/type/vector/Vec2d.java | 2 +- .../engine/base/type/vector/Vec2f.java | 2 +- .../engine/base/type/vector/Vec2i.java | 2 +- .../engine/base/type/vector/Vec3d.java | 2 +- .../engine/base/type/vector/Vec3f.java | 2 +- .../engine/base/type/vector/Vec3i.java | 2 +- .../engine/base/type/vector/Vec4d.java | 2 +- .../engine/base/type/vector/Vec4f.java | 2 +- .../engine/base/type/vector/Vec4i.java | 2 +- .../base/utility/DependencyResolver.java | 2 +- .../engine/base/utility/ListFormatter.java | 6 ++--- .../engine/base/utility/Math.java | 6 ++--- .../engine/base/utility/Miscellaneous.java | 6 ++--- .../base/utility/PlaceholderEngine.java | 25 +++++++++++-------- .../engine/base/utility/PropertiesReader.java | 2 +- .../information/EngineInformation.java | 6 ++--- .../utility/information/JvmInformation.java | 6 ++--- .../slf4j_compat/CompatibilityLogger.java | 7 +++--- .../CompatibilityLoggerFactory.java | 4 +-- .../CompatibilityLoggerProvider.java | 2 +- .../slf4j_compat/Slf4jCompatSubsystem.java | 2 +- .../staropensource/engine/testapp/Main.java | 24 +++++------------- .../engine/testing/TestBase.java | 2 +- .../engine/testing/UnitConfig.java | 6 ++--- .../engine/testing/UnitLogger.java | 2 +- .../engine/windowing/glfw/GlfwSubsystem.java | 2 +- .../glfw/GlfwSubsystemConfiguration.java | 14 +++++------ .../windowing/glfw/callback/KeyCallback.java | 4 +-- .../glfw/callback/MouseButtonCallback.java | 2 +- .../glfw/implementable/GlfwInternalClass.java | 2 +- .../implementable/GlfwManagementClass.java | 4 +-- .../glfw/implementable/GlfwMonitor.java | 2 +- .../glfw/implementable/GlfwWindow.java | 2 +- .../glfw/implementable/WindowCallback.java | 2 +- .../engine/windowing/WindowingSubsystem.java | 4 +-- .../WindowingSubsystemConfiguration.java | 8 +++--- .../engine/windowing/event/InputEvent.java | 2 +- .../windowing/event/RenderingErrorEvent.java | 2 +- .../windowing/event/WindowingErrorEvent.java | 2 +- .../event/WindowingShutdownEvent.java | 2 +- .../exception/InvalidMonitorException.java | 2 +- .../exception/NoMonitorsFoundException.java | 2 +- .../exception/NotOnMainThreadException.java | 2 +- .../WindowCreationFailureException.java | 4 +-- .../windowing/implementable/Monitor.java | 2 +- .../windowing/implementable/Window.java | 2 +- .../windowing/implementable/api/ApiClass.java | 4 +-- .../implementable/api/ApiInternalClass.java | 4 ++- .../implementable/api/ApiManagementClass.java | 5 ++-- 166 files changed, 293 insertions(+), 281 deletions(-) diff --git a/ansi/src/main/java/de/staropensource/engine/ansi/AnsiLoggingAdapter.java b/ansi/src/main/java/de/staropensource/engine/ansi/AnsiLoggingAdapter.java index 1a47938a..7400d060 100644 --- a/ansi/src/main/java/de/staropensource/engine/ansi/AnsiLoggingAdapter.java +++ b/ansi/src/main/java/de/staropensource/engine/ansi/AnsiLoggingAdapter.java @@ -37,7 +37,7 @@ import org.jetbrains.annotations.Nullable; */ public class AnsiLoggingAdapter implements LoggingAdapter { /** - * Constructs this class. + * Creates and initializes an instance of this class. * * @since v1-alpha2 */ diff --git a/ansi/src/main/java/de/staropensource/engine/ansi/AnsiShortcodeConverter.java b/ansi/src/main/java/de/staropensource/engine/ansi/AnsiShortcodeConverter.java index 9f247c4c..ff1d8cf8 100644 --- a/ansi/src/main/java/de/staropensource/engine/ansi/AnsiShortcodeConverter.java +++ b/ansi/src/main/java/de/staropensource/engine/ansi/AnsiShortcodeConverter.java @@ -35,7 +35,7 @@ import java.util.Set; */ public final class AnsiShortcodeConverter extends ShortcodeParser { /** - * Constructs this class. + * Creates and initializes an instance of this class. * * @param string string to convert * @param ignoreInvalidEscapes will ignore invalid escapes and print treat them like regular text diff --git a/ansi/src/main/java/de/staropensource/engine/ansi/AnsiSubsystem.java b/ansi/src/main/java/de/staropensource/engine/ansi/AnsiSubsystem.java index aec4e31d..0fa10201 100644 --- a/ansi/src/main/java/de/staropensource/engine/ansi/AnsiSubsystem.java +++ b/ansi/src/main/java/de/staropensource/engine/ansi/AnsiSubsystem.java @@ -29,7 +29,7 @@ import lombok.Getter; import org.jetbrains.annotations.NotNull; /** - * Main object for the ANSI Compatibility subsystem. + * Main class of the ANSI Compatibility subsystem. * * @since v1-alpha2 */ @@ -50,7 +50,7 @@ public final class AnsiSubsystem extends SubsystemClass { private static AnsiSubsystem instance = null; /** - * Constructs this subsystem. + * Initializes this subsystem. * * @since v1-alpha2 */ diff --git a/base/src/main/java/de/staropensource/engine/base/Engine.java b/base/src/main/java/de/staropensource/engine/base/Engine.java index f3b6fe6c..98c992dd 100644 --- a/base/src/main/java/de/staropensource/engine/base/Engine.java +++ b/base/src/main/java/de/staropensource/engine/base/Engine.java @@ -183,9 +183,9 @@ public final class Engine extends SubsystemClass { * Initializes the StarOpenSource Engine. * * @throws IllegalStateException when running in an incompatible environment - * @since v1-alpha0 + * @since v1-alpha6 */ - public Engine() throws IllegalStateException { + private Engine() throws IllegalStateException { if (instance == null) instance = this; else @@ -227,6 +227,18 @@ public final class Engine extends SubsystemClass { logger.info("Initialized sos!engine %engine_version% (commit %engine_git_commit_id_long%-%engine_git_branch%, dirty %engine_git_dirty%) in " + initTime + "ms\nThe StarOpenSource Engine is licensed under the GNU AGPL v3. Copyright (c) 2024 The StarOpenSource Engine Authors."); } + /** + * Initializes the StarOpenSource + * Engine, if it isn't already. + * + * @throws IllegalStateException when running in an incompatible environment + * @since v1-alpha6 + */ + public static void initialize() throws IllegalStateException { + if (instance == null) + instance = new Engine(); + } + /** * Initializes all classes. * @@ -235,7 +247,7 @@ public final class Engine extends SubsystemClass { private void initializeClasses() { logger.verb("Initializing engine classes"); new EngineInternals(); - new PlaceholderEngine(); + PlaceholderEngine.initialize(); EngineInformation.update(); PrintStreamService.initializeStreams(); diff --git a/base/src/main/java/de/staropensource/engine/base/EngineConfiguration.java b/base/src/main/java/de/staropensource/engine/base/EngineConfiguration.java index 18cde1fe..59fd8475 100644 --- a/base/src/main/java/de/staropensource/engine/base/EngineConfiguration.java +++ b/base/src/main/java/de/staropensource/engine/base/EngineConfiguration.java @@ -361,16 +361,12 @@ public final class EngineConfiguration extends Configuration { * Constructs this class. * * @see Engine - * @since v1-alpha0 + * @since v1-alpha6 */ - public EngineConfiguration() { - super("ENGINE"); // TODO Wait for flexible constructor bodies (JEP 482) to be implemented into the JVM as a stable feature. We don't want to use preview features in production code. + EngineConfiguration() { + super("ENGINE"); - // Only allow one instance - if (instance == null) - instance = this; - else - logger.crash("Only one instance of this class is allowed, use getInstance() instead of creating a new instance"); + instance = this; // Load default configuration loadDefaultConfiguration(); diff --git a/base/src/main/java/de/staropensource/engine/base/EngineInternals.java b/base/src/main/java/de/staropensource/engine/base/EngineInternals.java index d96b3dba..63a06c9a 100644 --- a/base/src/main/java/de/staropensource/engine/base/EngineInternals.java +++ b/base/src/main/java/de/staropensource/engine/base/EngineInternals.java @@ -91,11 +91,11 @@ public final class EngineInternals { private boolean reflectiveClasspathScanning = true; /** - * Constructs this class. + * Creates and initializes an instance of this class. * - * @since v1-alpha4 + * @since v1-alpha6 */ - public EngineInternals() { + EngineInternals() { // Only allow one instance if (instance == null && Engine.getInstance() != null) instance = this; diff --git a/base/src/main/java/de/staropensource/engine/base/event/EngineCrashEvent.java b/base/src/main/java/de/staropensource/engine/base/event/EngineCrashEvent.java index b9667a4e..ea9a3652 100644 --- a/base/src/main/java/de/staropensource/engine/base/event/EngineCrashEvent.java +++ b/base/src/main/java/de/staropensource/engine/base/event/EngineCrashEvent.java @@ -29,7 +29,7 @@ import de.staropensource.engine.base.implementable.helper.EventHelper; */ public final class EngineCrashEvent implements Event { /** - * Constructs this event. + * Creates and initializes an instance of this event. * * @since v1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/engine/base/event/EngineShutdownEvent.java b/base/src/main/java/de/staropensource/engine/base/event/EngineShutdownEvent.java index 845e8249..1f1910a9 100644 --- a/base/src/main/java/de/staropensource/engine/base/event/EngineShutdownEvent.java +++ b/base/src/main/java/de/staropensource/engine/base/event/EngineShutdownEvent.java @@ -29,7 +29,7 @@ import de.staropensource.engine.base.implementable.helper.EventHelper; */ public final class EngineShutdownEvent implements Event { /** - * Constructs this event. + * Creates and initializes an instance of this event. * * @since v1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/engine/base/event/EngineSoftCrashEvent.java b/base/src/main/java/de/staropensource/engine/base/event/EngineSoftCrashEvent.java index 9f5e6ec5..743cc771 100644 --- a/base/src/main/java/de/staropensource/engine/base/event/EngineSoftCrashEvent.java +++ b/base/src/main/java/de/staropensource/engine/base/event/EngineSoftCrashEvent.java @@ -33,7 +33,7 @@ import de.staropensource.engine.base.logging.Logger; */ public final class EngineSoftCrashEvent implements Event { /** - * Constructs this event. + * Creates and initializes an instance of this event. * * @since v1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/engine/base/event/LogEvent.java b/base/src/main/java/de/staropensource/engine/base/event/LogEvent.java index 5378bb3c..6de307fb 100644 --- a/base/src/main/java/de/staropensource/engine/base/event/LogEvent.java +++ b/base/src/main/java/de/staropensource/engine/base/event/LogEvent.java @@ -32,7 +32,7 @@ import org.jetbrains.annotations.Nullable; */ public final class LogEvent implements Event { /** - * Constructs this event. + * Creates and initializes an instance of this event. * * @since v1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/engine/base/event/ThrowableCatchEvent.java b/base/src/main/java/de/staropensource/engine/base/event/ThrowableCatchEvent.java index 5ed9642e..93082ce2 100644 --- a/base/src/main/java/de/staropensource/engine/base/event/ThrowableCatchEvent.java +++ b/base/src/main/java/de/staropensource/engine/base/event/ThrowableCatchEvent.java @@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull; */ public final class ThrowableCatchEvent implements Event { /** - * Constructs this event. + * Creates and initializes an instance of this event. * * @since v1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/engine/base/exception/IllegalAccessException.java b/base/src/main/java/de/staropensource/engine/base/exception/IllegalAccessException.java index 04ffb01d..3e61dded 100644 --- a/base/src/main/java/de/staropensource/engine/base/exception/IllegalAccessException.java +++ b/base/src/main/java/de/staropensource/engine/base/exception/IllegalAccessException.java @@ -28,14 +28,14 @@ import org.jetbrains.annotations.NotNull; */ public class IllegalAccessException extends RuntimeException { /** - * Constructs this exception. + * Creates and initializes an instance of this exception. * * @since v1-alpha2 */ public IllegalAccessException() {} /** - * Constructs this exception. + * Creates and initializes an instance of this exception. * * @param message message * @since v1-alpha2 diff --git a/base/src/main/java/de/staropensource/engine/base/exception/ParserException.java b/base/src/main/java/de/staropensource/engine/base/exception/ParserException.java index 8ce49a14..9b39d1d5 100644 --- a/base/src/main/java/de/staropensource/engine/base/exception/ParserException.java +++ b/base/src/main/java/de/staropensource/engine/base/exception/ParserException.java @@ -28,7 +28,7 @@ import org.jetbrains.annotations.NotNull; */ public class ParserException extends RuntimeException { /** - * Constructs this exception. + * Creates and initializes an instance of this exception. * * @param message parsing error * @since v1-alpha2 diff --git a/base/src/main/java/de/staropensource/engine/base/exception/TristateConversionException.java b/base/src/main/java/de/staropensource/engine/base/exception/TristateConversionException.java index 1c3ec2b3..858b9353 100644 --- a/base/src/main/java/de/staropensource/engine/base/exception/TristateConversionException.java +++ b/base/src/main/java/de/staropensource/engine/base/exception/TristateConversionException.java @@ -32,7 +32,7 @@ import de.staropensource.engine.base.type.Tristate; */ public class TristateConversionException extends RuntimeException { /** - * Constructs this exception. + * Creates and initializes an instance of this exception. * * @since v1-alpha2 */ diff --git a/base/src/main/java/de/staropensource/engine/base/exception/UnexpectedCheckEndException.java b/base/src/main/java/de/staropensource/engine/base/exception/UnexpectedCheckEndException.java index 0820d386..072130da 100644 --- a/base/src/main/java/de/staropensource/engine/base/exception/UnexpectedCheckEndException.java +++ b/base/src/main/java/de/staropensource/engine/base/exception/UnexpectedCheckEndException.java @@ -28,7 +28,7 @@ import org.jetbrains.annotations.NotNull; */ public class UnexpectedCheckEndException extends RuntimeException { /** - * Constructs this exception. + * Creates and initializes an instance of this exception. * * @param checkOccurrence the sequence of checks that failed * @since v1-alpha2 @@ -38,7 +38,7 @@ public class UnexpectedCheckEndException extends RuntimeException { } /** - * Constructs this exception. + * Creates and initializes an instance of this exception. * * @since v1-alpha2 */ diff --git a/base/src/main/java/de/staropensource/engine/base/exception/dependency/DependencyCycleException.java b/base/src/main/java/de/staropensource/engine/base/exception/dependency/DependencyCycleException.java index b22b922e..10a7fb16 100644 --- a/base/src/main/java/de/staropensource/engine/base/exception/dependency/DependencyCycleException.java +++ b/base/src/main/java/de/staropensource/engine/base/exception/dependency/DependencyCycleException.java @@ -29,7 +29,7 @@ import org.jetbrains.annotations.NotNull; */ public class DependencyCycleException extends RuntimeException { /** - * Constructs this exception. + * Creates and initializes an instance of this exception. * * @param path cycle path * @since v1-alpha1 diff --git a/base/src/main/java/de/staropensource/engine/base/exception/dependency/UnmetDependenciesException.java b/base/src/main/java/de/staropensource/engine/base/exception/dependency/UnmetDependenciesException.java index 8558fbdd..d76654e6 100644 --- a/base/src/main/java/de/staropensource/engine/base/exception/dependency/UnmetDependenciesException.java +++ b/base/src/main/java/de/staropensource/engine/base/exception/dependency/UnmetDependenciesException.java @@ -48,7 +48,7 @@ public class UnmetDependenciesException extends Exception { private final @NotNull List<@NotNull String> unmetDependencies; /** - * Constructs this exception. + * Creates and initializes an instance of this event. * * @param unmetDependencies map of all unmet dependencies * @see #unmetDependencies diff --git a/base/src/main/java/de/staropensource/engine/base/exception/reflection/IncompatibleTypeException.java b/base/src/main/java/de/staropensource/engine/base/exception/reflection/IncompatibleTypeException.java index 92618610..6f78f06a 100644 --- a/base/src/main/java/de/staropensource/engine/base/exception/reflection/IncompatibleTypeException.java +++ b/base/src/main/java/de/staropensource/engine/base/exception/reflection/IncompatibleTypeException.java @@ -30,7 +30,7 @@ import org.jetbrains.annotations.NotNull; */ public class IncompatibleTypeException extends RuntimeException { /** - * Constructs this exception. + * Creates and initializes an instance of this exception. * * @param methodName name of the method that failed * @param requiredClassType class type received by the method @@ -41,7 +41,7 @@ public class IncompatibleTypeException extends RuntimeException { } /** - * Constructs this exception. + * Creates and initializes an instance of this exception. * * @param methodName name of the method that failed * @param requiredClassType class type received by the method diff --git a/base/src/main/java/de/staropensource/engine/base/exception/reflection/InstanceMethodFromStaticContextException.java b/base/src/main/java/de/staropensource/engine/base/exception/reflection/InstanceMethodFromStaticContextException.java index ead795d4..791af768 100644 --- a/base/src/main/java/de/staropensource/engine/base/exception/reflection/InstanceMethodFromStaticContextException.java +++ b/base/src/main/java/de/staropensource/engine/base/exception/reflection/InstanceMethodFromStaticContextException.java @@ -28,7 +28,7 @@ import org.jetbrains.annotations.NotNull; */ public class InstanceMethodFromStaticContextException extends Exception { /** - * Constructs this exception. + * Creates and initializes an instance of this exception. * * @param methodName name of the method * @since v1-alpha2 diff --git a/base/src/main/java/de/staropensource/engine/base/exception/reflection/InvalidFieldException.java b/base/src/main/java/de/staropensource/engine/base/exception/reflection/InvalidFieldException.java index 7b460a52..010171d7 100644 --- a/base/src/main/java/de/staropensource/engine/base/exception/reflection/InvalidFieldException.java +++ b/base/src/main/java/de/staropensource/engine/base/exception/reflection/InvalidFieldException.java @@ -29,7 +29,7 @@ import org.jetbrains.annotations.NotNull; */ public class InvalidFieldException extends Exception { /** - * Constructs this exception. + * Creates and initializes an instance of this exception. * * @param clazz caller {@link ReflectionClass} * @param fieldName name of the invalid field diff --git a/base/src/main/java/de/staropensource/engine/base/exception/reflection/InvalidMethodException.java b/base/src/main/java/de/staropensource/engine/base/exception/reflection/InvalidMethodException.java index d1d723d7..0f84ace5 100644 --- a/base/src/main/java/de/staropensource/engine/base/exception/reflection/InvalidMethodException.java +++ b/base/src/main/java/de/staropensource/engine/base/exception/reflection/InvalidMethodException.java @@ -29,7 +29,7 @@ import org.jetbrains.annotations.NotNull; */ public class InvalidMethodException extends Exception { /** - * Constructs this exception. + * Creates and initializes an instance of this exception. * * @param clazz caller {@link ReflectionClass} * @param fieldName name of the invalid method diff --git a/base/src/main/java/de/staropensource/engine/base/exception/reflection/InvalidMethodSignatureException.java b/base/src/main/java/de/staropensource/engine/base/exception/reflection/InvalidMethodSignatureException.java index 7f86ea40..8fd1a8b8 100644 --- a/base/src/main/java/de/staropensource/engine/base/exception/reflection/InvalidMethodSignatureException.java +++ b/base/src/main/java/de/staropensource/engine/base/exception/reflection/InvalidMethodSignatureException.java @@ -28,7 +28,7 @@ import org.jetbrains.annotations.NotNull; */ public class InvalidMethodSignatureException extends Exception { /** - * Constructs this exception. + * Creates and initializes an instance of this exception. * * @param methodName method name * @since v1-alpha5 diff --git a/base/src/main/java/de/staropensource/engine/base/exception/reflection/NoAccessException.java b/base/src/main/java/de/staropensource/engine/base/exception/reflection/NoAccessException.java index b6120b3b..f2cb0644 100644 --- a/base/src/main/java/de/staropensource/engine/base/exception/reflection/NoAccessException.java +++ b/base/src/main/java/de/staropensource/engine/base/exception/reflection/NoAccessException.java @@ -28,7 +28,7 @@ import org.jetbrains.annotations.NotNull; */ public class NoAccessException extends Exception { /** - * Constructs this exception. + * Creates and initializes an instance of this exception. * * @param type {@code class}, {@code method} or {@code field} * @param name class, method or field name diff --git a/base/src/main/java/de/staropensource/engine/base/exception/reflection/StaticInitializerException.java b/base/src/main/java/de/staropensource/engine/base/exception/reflection/StaticInitializerException.java index 2b2baf1a..8c4f9af1 100644 --- a/base/src/main/java/de/staropensource/engine/base/exception/reflection/StaticInitializerException.java +++ b/base/src/main/java/de/staropensource/engine/base/exception/reflection/StaticInitializerException.java @@ -43,7 +43,7 @@ public class StaticInitializerException extends Exception { private final @NotNull Throwable throwable; /** - * Constructs this exception. + * Creates and initializes an instance of this exception. * * @param throwable throwable thrown by the static initializer * @since v1-alpha2 diff --git a/base/src/main/java/de/staropensource/engine/base/exception/versioning/IncompatibleVersioningSystemException.java b/base/src/main/java/de/staropensource/engine/base/exception/versioning/IncompatibleVersioningSystemException.java index 2777b9b9..eeb2fe92 100644 --- a/base/src/main/java/de/staropensource/engine/base/exception/versioning/IncompatibleVersioningSystemException.java +++ b/base/src/main/java/de/staropensource/engine/base/exception/versioning/IncompatibleVersioningSystemException.java @@ -29,7 +29,7 @@ import de.staropensource.engine.base.implementable.VersioningSystem; */ public class IncompatibleVersioningSystemException extends RuntimeException { /** - * Constructs this exception. + * Creates and initializes an instance of this exception. * * @param required required versioning system ie. the versioning system throwing this error * @param found found versioning system ie. the incompatible one diff --git a/base/src/main/java/de/staropensource/engine/base/exception/versioning/InvalidVersionStringException.java b/base/src/main/java/de/staropensource/engine/base/exception/versioning/InvalidVersionStringException.java index 5b47b3f6..545b3041 100644 --- a/base/src/main/java/de/staropensource/engine/base/exception/versioning/InvalidVersionStringException.java +++ b/base/src/main/java/de/staropensource/engine/base/exception/versioning/InvalidVersionStringException.java @@ -51,7 +51,7 @@ public class InvalidVersionStringException extends Exception { private final @Nullable Throwable throwable; /** - * Constructs this exception. + * Creates and initializes an instance of this exception. * * @param versioningSystem versioning system that is unable to parse version strings * @param versionString version string {@code a} @@ -65,7 +65,7 @@ public class InvalidVersionStringException extends Exception { } /** - * Constructs this exception. + * Creates and initializes an instance of this exception. * * @param versioningSystem versioning system that is unable to parse version strings * @param versionString version string {@code a} @@ -78,7 +78,7 @@ public class InvalidVersionStringException extends Exception { } /** - * Constructs this exception. + * Creates and initializes an instance of this exception. * * @param versioningSystem versioning system that is unable to parse version strings * @param versionString version string {@code a} @@ -91,7 +91,7 @@ public class InvalidVersionStringException extends Exception { } /** - * Constructs this exception. + * Creates and initializes an instance of this exception. * * @param versioningSystem versioning system that is unable to parse version strings * @param versionString version string {@code a} diff --git a/base/src/main/java/de/staropensource/engine/base/implementable/Configuration.java b/base/src/main/java/de/staropensource/engine/base/implementable/Configuration.java index f8a26337..f8c33fad 100644 --- a/base/src/main/java/de/staropensource/engine/base/implementable/Configuration.java +++ b/base/src/main/java/de/staropensource/engine/base/implementable/Configuration.java @@ -45,12 +45,12 @@ public abstract class Configuration { protected final @NotNull LoggerInstance logger; /** - * Constructs this class. + * Initializes this abstract class. * * @param origin see {@link LoggerInstance.Builder#setOrigin(String)} * @since v1-alpha2 */ - public Configuration(@NotNull String origin) { + protected Configuration(@NotNull String origin) { // Set logger instance logger = new LoggerInstance.Builder().setClazz(getClass()).setOrigin(origin).build(); diff --git a/base/src/main/java/de/staropensource/engine/base/implementable/EventListenerCode.java b/base/src/main/java/de/staropensource/engine/base/implementable/EventListenerCode.java index 9a3fb9a8..67f3a634 100644 --- a/base/src/main/java/de/staropensource/engine/base/implementable/EventListenerCode.java +++ b/base/src/main/java/de/staropensource/engine/base/implementable/EventListenerCode.java @@ -42,11 +42,11 @@ public abstract class EventListenerCode { public @NotNull EventPriority priority = EventPriority.DEFAULT; /** - * Constructs this class. + * Initializes this abstract class. * * @since v1-alpha5 */ - public EventListenerCode() {} + protected EventListenerCode() {} /** * Invokes the event listener. diff --git a/base/src/main/java/de/staropensource/engine/base/implementable/ShortcodeParser.java b/base/src/main/java/de/staropensource/engine/base/implementable/ShortcodeParser.java index 6d6a2bd8..055ed7c3 100644 --- a/base/src/main/java/de/staropensource/engine/base/implementable/ShortcodeParser.java +++ b/base/src/main/java/de/staropensource/engine/base/implementable/ShortcodeParser.java @@ -72,14 +72,14 @@ public abstract class ShortcodeParser { protected final @NotNull LinkedList components; /** - * Constructs this class. + * Initializes this abstract class. * * @param string string to parse * @param ignoreInvalidEscapes if {@code true}, will ignore and treat invalid escapes as text * @throws ParserException on error * @since v1-alpha2 */ - public ShortcodeParser(@NotNull String string, boolean ignoreInvalidEscapes) throws ParserException { + protected ShortcodeParser(@NotNull String string, boolean ignoreInvalidEscapes) throws ParserException { logger = new LoggerInstance.Builder().setClazz(getClass()).setOrigin("ENGINE").build(); components = parse(string, ignoreInvalidEscapes); } diff --git a/base/src/main/java/de/staropensource/engine/base/implementable/SubsystemClass.java b/base/src/main/java/de/staropensource/engine/base/implementable/SubsystemClass.java index b3e1d287..be40e6cf 100644 --- a/base/src/main/java/de/staropensource/engine/base/implementable/SubsystemClass.java +++ b/base/src/main/java/de/staropensource/engine/base/implementable/SubsystemClass.java @@ -28,19 +28,12 @@ import de.staropensource.engine.base.type.DependencyVector; import org.jetbrains.annotations.NotNull; /** - * Interface for building subsystem main classes. + * Abstract class for building subsystem main classes. * * @see EngineSubsystem * @since v1-alpha0 */ public abstract class SubsystemClass { - /** - * Constructs this class. - * - * @since v1-alpha2 - */ - public SubsystemClass() {} - /** * Contains the {@link LoggerInstance} for this instance. * @@ -49,6 +42,13 @@ public abstract class SubsystemClass { */ public final LoggerInstance logger = new LoggerInstance.Builder().setClazz(getClass()).setOrigin("ENGINE").build(); + /** + * Initializes this abstract class. + * + * @since v1-alpha2 + */ + protected SubsystemClass() {} + /** * Returns the name of the subsystem. * diff --git a/base/src/main/java/de/staropensource/engine/base/implementable/helper/EventHelper.java b/base/src/main/java/de/staropensource/engine/base/implementable/helper/EventHelper.java index 941e1474..d19eca62 100644 --- a/base/src/main/java/de/staropensource/engine/base/implementable/helper/EventHelper.java +++ b/base/src/main/java/de/staropensource/engine/base/implementable/helper/EventHelper.java @@ -68,7 +68,7 @@ public final class EventHelper { private static final @NotNull Map<@NotNull Class, LinkedList<@NotNull EventListenerCode>> cachedEventListeners = new HashMap<>(); /** - * Constructs this class. + * Creates and initializes an instance of this class. * * @since v1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/engine/base/implementation/logging/PlainLoggingAdapter.java b/base/src/main/java/de/staropensource/engine/base/implementation/logging/PlainLoggingAdapter.java index 057e5ec9..1d954876 100644 --- a/base/src/main/java/de/staropensource/engine/base/implementation/logging/PlainLoggingAdapter.java +++ b/base/src/main/java/de/staropensource/engine/base/implementation/logging/PlainLoggingAdapter.java @@ -36,7 +36,7 @@ import org.jetbrains.annotations.Nullable; */ public class PlainLoggingAdapter implements LoggingAdapter { /** - * Constructs this class. + * Creates and initializes an instance of this class. * * @since v1-alpha1 */ diff --git a/base/src/main/java/de/staropensource/engine/base/implementation/logging/QuietLoggingAdapter.java b/base/src/main/java/de/staropensource/engine/base/implementation/logging/QuietLoggingAdapter.java index 9e6560ca..e3cc034b 100644 --- a/base/src/main/java/de/staropensource/engine/base/implementation/logging/QuietLoggingAdapter.java +++ b/base/src/main/java/de/staropensource/engine/base/implementation/logging/QuietLoggingAdapter.java @@ -32,7 +32,7 @@ import org.jetbrains.annotations.Nullable; */ public class QuietLoggingAdapter implements LoggingAdapter { /** - * Constructs this class. + * Creates and initializes an instance of this class. * * @since v1-alpha4 */ diff --git a/base/src/main/java/de/staropensource/engine/base/implementation/logging/RawLoggingAdapter.java b/base/src/main/java/de/staropensource/engine/base/implementation/logging/RawLoggingAdapter.java index 594e5cee..7822aa42 100644 --- a/base/src/main/java/de/staropensource/engine/base/implementation/logging/RawLoggingAdapter.java +++ b/base/src/main/java/de/staropensource/engine/base/implementation/logging/RawLoggingAdapter.java @@ -36,7 +36,7 @@ import org.jetbrains.annotations.Nullable; */ public class RawLoggingAdapter implements LoggingAdapter { /** - * Constructs this class. + * Creates and initializes an instance of this class. * * @since v1-alpha1 */ diff --git a/base/src/main/java/de/staropensource/engine/base/implementation/shortcode/EmptyShortcodeConverter.java b/base/src/main/java/de/staropensource/engine/base/implementation/shortcode/EmptyShortcodeConverter.java index f264e49b..20ccc58b 100644 --- a/base/src/main/java/de/staropensource/engine/base/implementation/shortcode/EmptyShortcodeConverter.java +++ b/base/src/main/java/de/staropensource/engine/base/implementation/shortcode/EmptyShortcodeConverter.java @@ -31,7 +31,7 @@ import org.jetbrains.annotations.NotNull; */ public final class EmptyShortcodeConverter extends ShortcodeParser { /** - * Constructs this class. + * Creates and initializes an instance of this class. * * @param string string to parse * @param ignoreInvalidEscapes if {@code true}, will ignore and treat invalid escapes as text diff --git a/base/src/main/java/de/staropensource/engine/base/implementation/versioning/FourNumberVersioningSystem.java b/base/src/main/java/de/staropensource/engine/base/implementation/versioning/FourNumberVersioningSystem.java index 087a49c8..262df00f 100644 --- a/base/src/main/java/de/staropensource/engine/base/implementation/versioning/FourNumberVersioningSystem.java +++ b/base/src/main/java/de/staropensource/engine/base/implementation/versioning/FourNumberVersioningSystem.java @@ -90,7 +90,8 @@ public final class FourNumberVersioningSystem implements VersioningSystem { } /** - * Parses a four number-based version string. + * Tries to parse the specified version string + * and if successful, return a new instance. * * @param versionString version string to parse * @throws InvalidVersionStringException if the version string is invalid diff --git a/base/src/main/java/de/staropensource/engine/base/implementation/versioning/OneNumberVersioningSystem.java b/base/src/main/java/de/staropensource/engine/base/implementation/versioning/OneNumberVersioningSystem.java index c6ad90fe..68bfbce1 100644 --- a/base/src/main/java/de/staropensource/engine/base/implementation/versioning/OneNumberVersioningSystem.java +++ b/base/src/main/java/de/staropensource/engine/base/implementation/versioning/OneNumberVersioningSystem.java @@ -53,7 +53,8 @@ public final class OneNumberVersioningSystem implements VersioningSystem { } /** - * Parses a one number-based version string. + * Tries to parse the specified version string + * and if successful, return a new instance. * * @param versionString version string to parse * @throws InvalidVersionStringException if the version string is invalid diff --git a/base/src/main/java/de/staropensource/engine/base/implementation/versioning/SemanticVersioningSystem.java b/base/src/main/java/de/staropensource/engine/base/implementation/versioning/SemanticVersioningSystem.java index 9627063a..333bd0c1 100644 --- a/base/src/main/java/de/staropensource/engine/base/implementation/versioning/SemanticVersioningSystem.java +++ b/base/src/main/java/de/staropensource/engine/base/implementation/versioning/SemanticVersioningSystem.java @@ -109,7 +109,8 @@ public final class SemanticVersioningSystem implements VersioningSystem { } /** - * Parses a semantic versioning string. + * Tries to parse the specified version string + * and if successful, return a new instance. * * @param versionString version string to parse * @throws InvalidVersionStringException if the version string is invalid diff --git a/base/src/main/java/de/staropensource/engine/base/implementation/versioning/StarOpenSourceVersioningSystem.java b/base/src/main/java/de/staropensource/engine/base/implementation/versioning/StarOpenSourceVersioningSystem.java index 7ee647d3..71cc948d 100644 --- a/base/src/main/java/de/staropensource/engine/base/implementation/versioning/StarOpenSourceVersioningSystem.java +++ b/base/src/main/java/de/staropensource/engine/base/implementation/versioning/StarOpenSourceVersioningSystem.java @@ -110,7 +110,8 @@ public final class StarOpenSourceVersioningSystem implements VersioningSystem { } /** - * Parses a StarOpenSource versioning string. + * Tries to parse the specified version string + * and if successful, return a new instance. * * @param versionString version string to parse * @throws InvalidVersionStringException if the version string is invalid diff --git a/base/src/main/java/de/staropensource/engine/base/implementation/versioning/ThreeNumberVersioningSystem.java b/base/src/main/java/de/staropensource/engine/base/implementation/versioning/ThreeNumberVersioningSystem.java index baafdc48..754f2937 100644 --- a/base/src/main/java/de/staropensource/engine/base/implementation/versioning/ThreeNumberVersioningSystem.java +++ b/base/src/main/java/de/staropensource/engine/base/implementation/versioning/ThreeNumberVersioningSystem.java @@ -78,7 +78,8 @@ public final class ThreeNumberVersioningSystem implements VersioningSystem { } /** - * Parses a three number-based version string. + * Tries to parse the specified version string + * and if successful, return a new instance. * * @param versionString version string to parse * @throws InvalidVersionStringException if the version string is invalid diff --git a/base/src/main/java/de/staropensource/engine/base/implementation/versioning/TwoNumberVersioningSystem.java b/base/src/main/java/de/staropensource/engine/base/implementation/versioning/TwoNumberVersioningSystem.java index 10f97d58..4aa4e26f 100644 --- a/base/src/main/java/de/staropensource/engine/base/implementation/versioning/TwoNumberVersioningSystem.java +++ b/base/src/main/java/de/staropensource/engine/base/implementation/versioning/TwoNumberVersioningSystem.java @@ -66,7 +66,8 @@ public final class TwoNumberVersioningSystem implements VersioningSystem { } /** - * Parses a two number-based version string. + * Tries to parse the specified version string + * and if successful, return a new instance. * * @param versionString version string to parse * @throws InvalidVersionStringException if the version string is invalid diff --git a/base/src/main/java/de/staropensource/engine/base/internal/event/InternalEngineShutdownEvent.java b/base/src/main/java/de/staropensource/engine/base/internal/event/InternalEngineShutdownEvent.java index fb7cf13b..5985927b 100644 --- a/base/src/main/java/de/staropensource/engine/base/internal/event/InternalEngineShutdownEvent.java +++ b/base/src/main/java/de/staropensource/engine/base/internal/event/InternalEngineShutdownEvent.java @@ -31,7 +31,7 @@ import de.staropensource.engine.base.implementable.helper.EventHelper; */ public final class InternalEngineShutdownEvent implements Event { /** - * Constructs this event. + * Creates and initializes an instance of this event. * * @since v1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/engine/base/internal/implementation/EventListenerMethod.java b/base/src/main/java/de/staropensource/engine/base/internal/implementation/EventListenerMethod.java index 7682d196..0ae711b2 100644 --- a/base/src/main/java/de/staropensource/engine/base/internal/implementation/EventListenerMethod.java +++ b/base/src/main/java/de/staropensource/engine/base/internal/implementation/EventListenerMethod.java @@ -42,7 +42,7 @@ public final class EventListenerMethod extends EventListenerCode { private final @NotNull ReflectionMethod method; /** - * Constructs this class. + * Creates and initializes an instance of this class. * * @param method method to execute * @since v1-alpha5 diff --git a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/DateDay.java b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/DateDay.java index 00415942..a4a5df77 100644 --- a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/DateDay.java +++ b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/DateDay.java @@ -34,7 +34,7 @@ import java.util.Calendar; @SuppressWarnings({ "unused" }) public final class DateDay implements Placeholder { /** - * Constructs this class. + * Creates and initializes an instance of this event. * * @since v1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/DateMonth.java b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/DateMonth.java index 9ceb08cb..5686fe65 100644 --- a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/DateMonth.java +++ b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/DateMonth.java @@ -34,7 +34,7 @@ import java.util.Calendar; @SuppressWarnings({ "unused" }) public final class DateMonth implements Placeholder { /** - * Constructs this class. + * Creates and initializes an instance of this event. * * @since v1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/DateYear.java b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/DateYear.java index f52fbb54..f04f894d 100644 --- a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/DateYear.java +++ b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/DateYear.java @@ -34,7 +34,7 @@ import java.util.Calendar; @SuppressWarnings({ "unused" }) public final class DateYear implements Placeholder { /** - * Constructs this class. + * Creates and initializes an instance of this event. * * @since v1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineDependencyJansi.java b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineDependencyJansi.java index 647e85f4..5d2d3ec9 100644 --- a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineDependencyJansi.java +++ b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineDependencyJansi.java @@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull; @SuppressWarnings({ "unused" }) public final class EngineDependencyJansi implements Placeholder { /** - * Constructs this class. + * Creates and initializes an instance of this event. * * @since v1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineDependencyLwjgl.java b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineDependencyLwjgl.java index 7bda0127..fce4cfbc 100644 --- a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineDependencyLwjgl.java +++ b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineDependencyLwjgl.java @@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull; @SuppressWarnings({ "unused" }) public final class EngineDependencyLwjgl implements Placeholder { /** - * Constructs this class. + * Creates and initializes an instance of this event. * * @since v1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineDependencyReflections.java b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineDependencyReflections.java index 15b7be76..5ad768be 100644 --- a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineDependencyReflections.java +++ b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineDependencyReflections.java @@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull; @SuppressWarnings({ "unused" }) public final class EngineDependencyReflections implements Placeholder { /** - * Constructs this class. + * Creates and initializes an instance of this event. * * @since v1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineDependencySlf4j.java b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineDependencySlf4j.java index dac3c474..76b94c76 100644 --- a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineDependencySlf4j.java +++ b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineDependencySlf4j.java @@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull; @SuppressWarnings({ "unused" }) public final class EngineDependencySlf4j implements Placeholder { /** - * Constructs this class. + * Creates and initializes an instance of this event. * * @since v1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineGitBranch.java b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineGitBranch.java index 8baabd4d..30333dc3 100644 --- a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineGitBranch.java +++ b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineGitBranch.java @@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull; @SuppressWarnings({ "unused" }) public final class EngineGitBranch implements Placeholder { /** - * Constructs this class. + * Creates and initializes an instance of this event. * * @since v1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineGitCommitHeader.java b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineGitCommitHeader.java index 8cb8b57e..d7ab4e08 100644 --- a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineGitCommitHeader.java +++ b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineGitCommitHeader.java @@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull; @SuppressWarnings({ "unused" }) public final class EngineGitCommitHeader implements Placeholder { /** - * Constructs this class. + * Creates and initializes an instance of this event. * * @since v1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineGitCommitIdLong.java b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineGitCommitIdLong.java index b8a3d6a6..84e378b6 100644 --- a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineGitCommitIdLong.java +++ b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineGitCommitIdLong.java @@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull; @SuppressWarnings({ "unused" }) public final class EngineGitCommitIdLong implements Placeholder { /** - * Constructs this class. + * Creates and initializes an instance of this event. * * @since v1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineGitCommitIdShort.java b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineGitCommitIdShort.java index 0743a4bb..b7afd830 100644 --- a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineGitCommitIdShort.java +++ b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineGitCommitIdShort.java @@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull; @SuppressWarnings({ "unused" }) public final class EngineGitCommitIdShort implements Placeholder { /** - * Constructs this class. + * Creates and initializes an instance of this event. * * @since v1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineGitCommitTimeDay.java b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineGitCommitTimeDay.java index 978262cc..084311fb 100644 --- a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineGitCommitTimeDay.java +++ b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineGitCommitTimeDay.java @@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull; @SuppressWarnings({ "unused" }) public final class EngineGitCommitTimeDay implements Placeholder { /** - * Constructs this class. + * Creates and initializes an instance of this event. * * @since v1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineGitCommitTimeHour.java b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineGitCommitTimeHour.java index 72775f95..75e19af9 100644 --- a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineGitCommitTimeHour.java +++ b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineGitCommitTimeHour.java @@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull; @SuppressWarnings({ "unused" }) public final class EngineGitCommitTimeHour implements Placeholder { /** - * Constructs this class. + * Creates and initializes an instance of this event. * * @since v1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineGitCommitTimeMinute.java b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineGitCommitTimeMinute.java index af973166..f0ec3149 100644 --- a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineGitCommitTimeMinute.java +++ b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineGitCommitTimeMinute.java @@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull; @SuppressWarnings({ "unused" }) public final class EngineGitCommitTimeMinute implements Placeholder { /** - * Constructs this class. + * Creates and initializes an instance of this event. * * @since v1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineGitCommitTimeMonth.java b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineGitCommitTimeMonth.java index a09e1c59..8cb1ad4d 100644 --- a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineGitCommitTimeMonth.java +++ b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineGitCommitTimeMonth.java @@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull; @SuppressWarnings({ "unused" }) public final class EngineGitCommitTimeMonth implements Placeholder { /** - * Constructs this class. + * Creates and initializes an instance of this event. * * @since v1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineGitCommitTimeSecond.java b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineGitCommitTimeSecond.java index 88df83ea..6c39f0d9 100644 --- a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineGitCommitTimeSecond.java +++ b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineGitCommitTimeSecond.java @@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull; @SuppressWarnings({ "unused" }) public final class EngineGitCommitTimeSecond implements Placeholder { /** - * Constructs this class. + * Creates and initializes an instance of this event. * * @since v1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineGitCommitTimeYear.java b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineGitCommitTimeYear.java index 390007be..1ababba4 100644 --- a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineGitCommitTimeYear.java +++ b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineGitCommitTimeYear.java @@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull; @SuppressWarnings({ "unused" }) public final class EngineGitCommitTimeYear implements Placeholder { /** - * Constructs this class. + * Creates and initializes an instance of this event. * * @since v1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineGitCommits.java b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineGitCommits.java index 55cf423a..2ae07cd2 100644 --- a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineGitCommits.java +++ b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineGitCommits.java @@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull; @SuppressWarnings({ "unused" }) public final class EngineGitCommits implements Placeholder { /** - * Constructs this class. + * Creates and initializes an instance of this event. * * @since v1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineGitCommitterEmail.java b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineGitCommitterEmail.java index 39b81f9d..3ccc2804 100644 --- a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineGitCommitterEmail.java +++ b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineGitCommitterEmail.java @@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull; @SuppressWarnings({ "unused" }) public final class EngineGitCommitterEmail implements Placeholder { /** - * Constructs this class. + * Creates and initializes an instance of this event. * * @since v1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineGitCommitterName.java b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineGitCommitterName.java index 5b75d6a6..ffa57c3c 100644 --- a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineGitCommitterName.java +++ b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineGitCommitterName.java @@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull; @SuppressWarnings({ "unused" }) public final class EngineGitCommitterName implements Placeholder { /** - * Constructs this class. + * Creates and initializes an instance of this event. * * @since v1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineGitDirty.java b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineGitDirty.java index 7584e7e5..664fd951 100644 --- a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineGitDirty.java +++ b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineGitDirty.java @@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull; @SuppressWarnings({ "unused" }) public final class EngineGitDirty implements Placeholder { /** - * Constructs this class. + * Creates and initializes an instance of this event. * * @since v1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineVersion.java b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineVersion.java index 92a3e1cf..9caf29e8 100644 --- a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineVersion.java +++ b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineVersion.java @@ -31,7 +31,7 @@ import org.jetbrains.annotations.NotNull; @SuppressWarnings({ "unused" }) public final class EngineVersion implements Placeholder { /** - * Constructs this class. + * Creates and initializes an instance of this event. * * @since v1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineVersionFork.java b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineVersionFork.java index 89bf1dcb..56e0bab0 100644 --- a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineVersionFork.java +++ b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineVersionFork.java @@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull; @SuppressWarnings({ "unused" }) public final class EngineVersionFork implements Placeholder { /** - * Constructs this class. + * Creates and initializes an instance of this event. * * @since v1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineVersionType.java b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineVersionType.java index 57bf1f21..ae61aa34 100644 --- a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineVersionType.java +++ b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineVersionType.java @@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull; @SuppressWarnings({ "unused" }) public final class EngineVersionType implements Placeholder { /** - * Constructs this class. + * Creates and initializes an instance of this event. * * @since v1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineVersionTyperelease.java b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineVersionTyperelease.java index a4607a14..98e35555 100644 --- a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineVersionTyperelease.java +++ b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineVersionTyperelease.java @@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull; @SuppressWarnings({ "unused" }) public final class EngineVersionTyperelease implements Placeholder { /** - * Constructs this class. + * Creates and initializes an instance of this event. * * @since v1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineVersionVersion.java b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineVersionVersion.java index ba10f5ff..5b7f91dc 100644 --- a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineVersionVersion.java +++ b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/EngineVersionVersion.java @@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull; @SuppressWarnings({ "unused" }) public final class EngineVersionVersion implements Placeholder { /** - * Constructs this class. + * Creates and initializes an instance of this event. * * @since v1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/JvmArguments.java b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/JvmArguments.java index 55ddfe5a..57bc57be 100644 --- a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/JvmArguments.java +++ b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/JvmArguments.java @@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull; @SuppressWarnings({ "unused" }) public final class JvmArguments implements Placeholder { /** - * Constructs this class. + * Creates and initializes an instance of this event. * * @since v1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/JvmImplementationName.java b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/JvmImplementationName.java index 05287064..1cbf832e 100644 --- a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/JvmImplementationName.java +++ b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/JvmImplementationName.java @@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull; @SuppressWarnings({ "unused" }) public final class JvmImplementationName implements Placeholder { /** - * Constructs this class. + * Creates and initializes an instance of this event. * * @since v1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/JvmImplementationVendor.java b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/JvmImplementationVendor.java index 36cba6cd..9f9c2531 100644 --- a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/JvmImplementationVendor.java +++ b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/JvmImplementationVendor.java @@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull; @SuppressWarnings({ "unused" }) public final class JvmImplementationVendor implements Placeholder { /** - * Constructs this class. + * Creates and initializes an instance of this event. * * @since v1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/JvmImplementationVersion.java b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/JvmImplementationVersion.java index 5ae3a742..64efe6a2 100644 --- a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/JvmImplementationVersion.java +++ b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/JvmImplementationVersion.java @@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull; @SuppressWarnings({ "unused" }) public final class JvmImplementationVersion implements Placeholder { /** - * Constructs this class. + * Creates and initializes an instance of this event. * * @since v1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/JvmJava.java b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/JvmJava.java index c586d409..4fe7f451 100644 --- a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/JvmJava.java +++ b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/JvmJava.java @@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull; @SuppressWarnings({ "unused" }) public final class JvmJava implements Placeholder { /** - * Constructs this class. + * Creates and initializes an instance of this event. * * @since v1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/JvmUptime.java b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/JvmUptime.java index e7e4b6d5..f9b0d3fb 100644 --- a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/JvmUptime.java +++ b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/JvmUptime.java @@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull; @SuppressWarnings({ "unused" }) public final class JvmUptime implements Placeholder { /** - * Constructs this class. + * Creates and initializes an instance of this event. * * @since v1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/TimeEpoch.java b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/TimeEpoch.java index e95d05e6..442381fb 100644 --- a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/TimeEpoch.java +++ b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/TimeEpoch.java @@ -33,7 +33,7 @@ import org.jetbrains.annotations.NotNull; @SuppressWarnings({ "unused" }) public final class TimeEpoch implements Placeholder { /** - * Constructs this class. + * Creates and initializes an instance of this event. * * @since v1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/TimeHour.java b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/TimeHour.java index 67b0db40..ef1222be 100644 --- a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/TimeHour.java +++ b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/TimeHour.java @@ -34,7 +34,7 @@ import java.util.Calendar; @SuppressWarnings({ "unused" }) public final class TimeHour implements Placeholder { /** - * Constructs this class. + * Creates and initializes an instance of this event. * * @since v1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/TimeMinute.java b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/TimeMinute.java index 2ac3b32b..34edb125 100644 --- a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/TimeMinute.java +++ b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/TimeMinute.java @@ -34,7 +34,7 @@ import java.util.Calendar; @SuppressWarnings({ "unused" }) public final class TimeMinute implements Placeholder { /** - * Constructs this class. + * Creates and initializes an instance of this event. * * @since v1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/TimeSecond.java b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/TimeSecond.java index 195041af..2daa6d18 100644 --- a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/TimeSecond.java +++ b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/TimeSecond.java @@ -34,7 +34,7 @@ import java.util.Calendar; @SuppressWarnings({ "unused" }) public final class TimeSecond implements Placeholder { /** - * Constructs this class. + * Creates and initializes an instance of this event. * * @since v1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/TimeZone.java b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/TimeZone.java index b4ef8eb3..5a7a3d44 100644 --- a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/TimeZone.java +++ b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/TimeZone.java @@ -33,7 +33,7 @@ import java.util.Locale; @SuppressWarnings({ "unused" }) public final class TimeZone implements Placeholder { /** - * Constructs this class. + * Creates and initializes an instance of this event. * * @since v1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/crashhandler/CrashMessage.java b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/crashhandler/CrashMessage.java index 4aa7518b..a128f6b3 100644 --- a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/crashhandler/CrashMessage.java +++ b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/crashhandler/CrashMessage.java @@ -31,7 +31,7 @@ import org.jetbrains.annotations.NotNull; @SuppressWarnings({ "unused" }) public final class CrashMessage implements Placeholder { /** - * The message to use. + * Contains the message to use. * * @since v1-alpha0 */ @@ -39,7 +39,7 @@ public final class CrashMessage implements Placeholder { private final String message; /** - * Constructs this class. + * Creates and initializes an instance of this event. * * @param message message to use * @since v1-alpha0 diff --git a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/crashhandler/IssuerClass.java b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/crashhandler/IssuerClass.java index 3ff947b6..59a7a64d 100644 --- a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/crashhandler/IssuerClass.java +++ b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/crashhandler/IssuerClass.java @@ -31,14 +31,14 @@ import org.jetbrains.annotations.NotNull; @SuppressWarnings({ "unused" }) public final class IssuerClass implements Placeholder { /** - * Issuer class to use. + * Contains the issuer class to use. * * @since v1-alpha2 */ private final @NotNull Class issuerClass; /** - * Constructs this class. + * Creates and initializes an instance of this event. * * @param issuerClass issuer class to use * @since v1-alpha0 diff --git a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/crashhandler/IssuerMetadata.java b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/crashhandler/IssuerMetadata.java index aedda35a..596f0b29 100644 --- a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/crashhandler/IssuerMetadata.java +++ b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/crashhandler/IssuerMetadata.java @@ -32,14 +32,14 @@ import org.jetbrains.annotations.Nullable; @SuppressWarnings({ "unused" }) public final class IssuerMetadata implements Placeholder { /** - * Issuer metadata to use. + * Contains the issuer metadata to use. * * @since v1-alpha0 */ private final @Nullable String issuerMetadata; /** - * Constructs this class. + * Creates and initializes an instance of this event. * * @param issuerMetadata issuer metadata to use * @since v1-alpha0 diff --git a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/crashhandler/IssuerOrigin.java b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/crashhandler/IssuerOrigin.java index ea1c6cc8..791bd4ba 100644 --- a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/crashhandler/IssuerOrigin.java +++ b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/crashhandler/IssuerOrigin.java @@ -33,14 +33,14 @@ import java.util.Locale; @SuppressWarnings({ "unused" }) public final class IssuerOrigin implements Placeholder { /** - * Issuer origin to use. + * Contains the issuer origin to use. * * @since v1-alpha2 */ private final @NotNull String issuerOrigin; /** - * Constructs this class. + * Creates and initializes an instance of this event. * * @param issuerOrigin issuer origin to use * @since v1-alpha0 diff --git a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/crashhandler/IssuerPackage.java b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/crashhandler/IssuerPackage.java index 460f0123..ad1a5694 100644 --- a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/crashhandler/IssuerPackage.java +++ b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/crashhandler/IssuerPackage.java @@ -31,14 +31,14 @@ import org.jetbrains.annotations.NotNull; @SuppressWarnings({ "unused" }) public final class IssuerPackage implements Placeholder { /** - * Issuer class to use. + * Contains the issuer class to use. * * @since v1-alpha2 */ private final @NotNull Class issuerClass; /** - * Constructs this class. + * Creates and initializes an instance of this event. * * @param issuerClass issuer class to use * @since v1-alpha0 diff --git a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/crashhandler/IssuerPath.java b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/crashhandler/IssuerPath.java index 5fbe48e4..68b081e6 100644 --- a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/crashhandler/IssuerPath.java +++ b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/crashhandler/IssuerPath.java @@ -31,14 +31,14 @@ import org.jetbrains.annotations.NotNull; @SuppressWarnings({ "unused" }) public final class IssuerPath implements Placeholder { /** - * Issuer class to use. + * Contains the issuer class to use. * * @since v1-alpha2 */ private final @NotNull Class issuerClass; /** - * Constructs this class. + * Creates and initializes an instance of this event. * * @param issuerClass issuer class to use * @since v1-alpha0 diff --git a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/crashhandler/Stacktrace.java b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/crashhandler/Stacktrace.java index 1be27af5..9a8966a9 100644 --- a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/crashhandler/Stacktrace.java +++ b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/crashhandler/Stacktrace.java @@ -35,14 +35,14 @@ import java.lang.reflect.InvocationTargetException; @SuppressWarnings({ "unused" }) public final class Stacktrace implements Placeholder { /** - * The {@link Throwable} to use. + * Contains the {@link Throwable} to use. * * @since v1-alpha0 */ private final @Nullable Throwable throwable; /** - * Constructs this class. + * Creates and initializes an instance of this event. * * @param throwable {@link Throwable} to use * @since v1-alpha0 diff --git a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/crashhandler/StacktraceAll.java b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/crashhandler/StacktraceAll.java index 88595db5..8c7e7147 100644 --- a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/crashhandler/StacktraceAll.java +++ b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/crashhandler/StacktraceAll.java @@ -34,7 +34,7 @@ import java.util.Map; @SuppressWarnings({ "unused" }) public final class StacktraceAll implements Placeholder { /** - * Constructs this class. + * Creates and initializes an instance of this event. * * @since v1-alpha2 */ diff --git a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/logger/LogClass.java b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/logger/LogClass.java index 79efb257..14878ac2 100644 --- a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/logger/LogClass.java +++ b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/logger/LogClass.java @@ -31,14 +31,14 @@ import org.jetbrains.annotations.NotNull; @SuppressWarnings({ "unused" }) public final class LogClass implements Placeholder { /** - * Issuer class to use. + * Contains the issuer class to use. * * @since v1-alpha0 */ private final @NotNull Class issuerClass; /** - * Constructs this class. + * Creates and initializes an instance of this event. * * @param issuerClass issuer class to use * @since v1-alpha0 diff --git a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/logger/LogColorPrimary.java b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/logger/LogColorPrimary.java index 19313ec5..ec0e03b8 100644 --- a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/logger/LogColorPrimary.java +++ b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/logger/LogColorPrimary.java @@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull; @SuppressWarnings({ "unused" }) public final class LogColorPrimary implements Placeholder { /** - * The {@link LogLevel} to use. + * Contains the {@link LogLevel} to use. * * @since v1-alpha0 */ @@ -40,7 +40,7 @@ public final class LogColorPrimary implements Placeholder { private final LogLevel level; /** - * Constructs this class. + * Creates and initializes an instance of this event. * * @param level {@link LogLevel} to use * @since v1-alpha0 diff --git a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/logger/LogColorSecondary.java b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/logger/LogColorSecondary.java index ddf065d1..bb387df7 100644 --- a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/logger/LogColorSecondary.java +++ b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/logger/LogColorSecondary.java @@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull; @SuppressWarnings({ "unused" }) public final class LogColorSecondary implements Placeholder { /** - * The {@link LogLevel} to use. + * Contains the {@link LogLevel} to use. * * @since v1-alpha0 */ @@ -40,7 +40,7 @@ public final class LogColorSecondary implements Placeholder { private final LogLevel level; /** - * Constructs this class. + * Creates and initializes an instance of this event. * * @param level {@link LogLevel} to use * @since v1-alpha0 diff --git a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/logger/LogMetadata.java b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/logger/LogMetadata.java index 8e5072d6..f16c4526 100644 --- a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/logger/LogMetadata.java +++ b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/logger/LogMetadata.java @@ -32,14 +32,14 @@ import org.jetbrains.annotations.Nullable; @SuppressWarnings({ "unused" }) public final class LogMetadata implements Placeholder { /** - * Issuer metadata to use + * Contains the issuer metadata to use * * @since v1-alpha0 */ private final @Nullable String issuerMetadata; /** - * Constructs this class. + * Creates and initializes an instance of this event. * * @param issuerMetadata issuer metadata to use * @since v1-alpha0 diff --git a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/logger/LogOrigin.java b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/logger/LogOrigin.java index 3226c638..d51fab12 100644 --- a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/logger/LogOrigin.java +++ b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/logger/LogOrigin.java @@ -33,14 +33,14 @@ import java.util.Locale; @SuppressWarnings({ "unused" }) public final class LogOrigin implements Placeholder { /** - * Issuer origin to use. + * Contains the issuer origin to use. * * @since v1-alpha0 */ private final @NotNull String issuerOrigin; /** - * Constructs this class. + * Creates and initializes an instance of this event. * * @param issuerOrigin issuer origin to use * @since v1-alpha0 diff --git a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/logger/LogPackage.java b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/logger/LogPackage.java index 60f1503e..2e05bc52 100644 --- a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/logger/LogPackage.java +++ b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/logger/LogPackage.java @@ -31,14 +31,14 @@ import org.jetbrains.annotations.NotNull; @SuppressWarnings({ "unused" }) public final class LogPackage implements Placeholder { /** - * Issuer class to use. + * Contains the issuer class to use. * * @since v1-alpha0 */ private final @NotNull Class issuerClass; /** - * Constructs this class. + * Creates and initializes an instance of this event. * * @param issuerClass issuer class to use * @since v1-alpha0 diff --git a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/logger/LogPath.java b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/logger/LogPath.java index 0cdeb3fd..bd6137b1 100644 --- a/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/logger/LogPath.java +++ b/base/src/main/java/de/staropensource/engine/base/internal/implementation/placeholder/logger/LogPath.java @@ -31,7 +31,7 @@ import org.jetbrains.annotations.NotNull; @SuppressWarnings({ "unused" }) public final class LogPath implements Placeholder { /** - * Issuer class to use. + * Contains the issuer class to use. * * @since v1-alpha0 */ @@ -39,7 +39,7 @@ public final class LogPath implements Placeholder { private final Class issuerClass; /** - * Constructs this class. + * Creates and initializes an instance of this event. * * @param issuerClass issuer class to use * @since v1-alpha0 diff --git a/base/src/main/java/de/staropensource/engine/base/internal/reflection/ReflectionAccessWidener.java b/base/src/main/java/de/staropensource/engine/base/internal/reflection/ReflectionAccessWidener.java index 9b5509ca..a5fcab47 100644 --- a/base/src/main/java/de/staropensource/engine/base/internal/reflection/ReflectionAccessWidener.java +++ b/base/src/main/java/de/staropensource/engine/base/internal/reflection/ReflectionAccessWidener.java @@ -32,11 +32,11 @@ import java.lang.reflect.*; */ public final class ReflectionAccessWidener { /** - * Constructs this class. + * Creates and initializes an instance of this class. * * @since v1-alpha2 */ - public ReflectionAccessWidener() {} + private ReflectionAccessWidener() {} /** * Allows access to an {@link AccessibleObject}. diff --git a/base/src/main/java/de/staropensource/engine/base/internal/type/DependencySubsystemVector.java b/base/src/main/java/de/staropensource/engine/base/internal/type/DependencySubsystemVector.java index bf24717e..f69e7870 100644 --- a/base/src/main/java/de/staropensource/engine/base/internal/type/DependencySubsystemVector.java +++ b/base/src/main/java/de/staropensource/engine/base/internal/type/DependencySubsystemVector.java @@ -47,7 +47,8 @@ public final class DependencySubsystemVector extends DependencyVector { private final SubsystemClass subsystemClass; /** - * Reuses an existing {@link DependencyVector} to create a new {@link DependencySubsystemVector}. + * Creates and initializes an instance of this class. + * Reuses an existing {@link DependencyVector}. * * @param vector existing dependency vector to reuse * @param subsystemClass {@link SubsystemClass} to associate diff --git a/base/src/main/java/de/staropensource/engine/base/internal/type/QueuedLogMessage.java b/base/src/main/java/de/staropensource/engine/base/internal/type/QueuedLogMessage.java index 9408ac5c..5e1f14bb 100644 --- a/base/src/main/java/de/staropensource/engine/base/internal/type/QueuedLogMessage.java +++ b/base/src/main/java/de/staropensource/engine/base/internal/type/QueuedLogMessage.java @@ -38,7 +38,7 @@ import org.jetbrains.annotations.Nullable; @SuppressWarnings({ "unused" }) public record QueuedLogMessage(@NotNull LogLevel level, @NotNull Class issuerClass, @NotNull String issuerOrigin, @Nullable String issuerMetadata, @NotNull String message) { /** - * Creates a new queued log message. + * Creates and initializes an instance of this class. * * @param level level * @param issuerClass class of the issuer diff --git a/base/src/main/java/de/staropensource/engine/base/logging/CrashHandler.java b/base/src/main/java/de/staropensource/engine/base/logging/CrashHandler.java index ff34049b..d47aa374 100644 --- a/base/src/main/java/de/staropensource/engine/base/logging/CrashHandler.java +++ b/base/src/main/java/de/staropensource/engine/base/logging/CrashHandler.java @@ -99,11 +99,11 @@ Dear developer: FIX YOUR GODDAMN SHIT! Please check if your code or 3rd party su private static final @NotNull LinkedHashMap<@NotNull Object, @NotNull Object> crashContent = new LinkedHashMap<>(); /** - * Constructs this class. + * Creates and initializes an instance of this class. * - * @since v1-alpha0 + * @since v1-alpha6 */ - public CrashHandler() {} + private CrashHandler() {} /** * Handles a crash. diff --git a/base/src/main/java/de/staropensource/engine/base/logging/InitLogger.java b/base/src/main/java/de/staropensource/engine/base/logging/InitLogger.java index 336cdca6..5f4edd4c 100644 --- a/base/src/main/java/de/staropensource/engine/base/logging/InitLogger.java +++ b/base/src/main/java/de/staropensource/engine/base/logging/InitLogger.java @@ -20,6 +20,7 @@ package de.staropensource.engine.base.logging; import de.staropensource.engine.base.EngineConfiguration; +import de.staropensource.engine.base.internal.implementation.placeholder.logger.LogLevelEvent; import de.staropensource.engine.base.internal.implementation.placeholder.logger.LogPath; import de.staropensource.engine.base.type.logging.LogLevel; import org.jetbrains.annotations.NotNull; @@ -39,11 +40,11 @@ public final class InitLogger { private static final @NotNull String template = "%log_level% %log_path% %log_message%"; /** - * Constructs this class. + * Creates and initializes an instance of this class. * - * @since v1-alpha4 + * @since v1-alpha6 */ - public InitLogger() {} + private InitLogger() {} /** * {@link Logger#log(LogLevel, Class, String, String, String)} and {@link Logger#processLogMessage(LogLevel, Class, String, String, String)} combined into one method. @@ -67,7 +68,7 @@ public final class InitLogger { // Replace placeholders // This is done manually to avoid depending on PlaceholderEngine - base = new de.staropensource.engine.base.internal.implementation.placeholder.logger.LogLevel(level).replace(base); + base = new LogLevelEvent(level).replace(base); base = new LogPath(issuerClass).replace(base); base = base.replace("%log_message%", message.replace("\n", "")); diff --git a/base/src/main/java/de/staropensource/engine/base/logging/Logger.java b/base/src/main/java/de/staropensource/engine/base/logging/Logger.java index 03169d2c..b24e5bed 100644 --- a/base/src/main/java/de/staropensource/engine/base/logging/Logger.java +++ b/base/src/main/java/de/staropensource/engine/base/logging/Logger.java @@ -95,11 +95,11 @@ public final class Logger { private static final List activeRules = new ArrayList<>(); /** - * Constructs this class. + * Creates and initializes an instance of this class. * - * @since v1-alpha0 + * @since v1-alpha6 */ - public Logger() {} + private Logger() {} /** * Prints all queued log messages. diff --git a/base/src/main/java/de/staropensource/engine/base/logging/LoggerInstance.java b/base/src/main/java/de/staropensource/engine/base/logging/LoggerInstance.java index cdc2dccf..478d3426 100644 --- a/base/src/main/java/de/staropensource/engine/base/logging/LoggerInstance.java +++ b/base/src/main/java/de/staropensource/engine/base/logging/LoggerInstance.java @@ -70,7 +70,7 @@ public final class LoggerInstance { private final @NotNull String origin; /** - * Creates a new logger instance. + * Creates and initializes an instance of this class. * * @param clazz class of the issuer * @param origin origin of the issuer diff --git a/base/src/main/java/de/staropensource/engine/base/logging/LoggingThread.java b/base/src/main/java/de/staropensource/engine/base/logging/LoggingThread.java index b187d50d..887a2941 100644 --- a/base/src/main/java/de/staropensource/engine/base/logging/LoggingThread.java +++ b/base/src/main/java/de/staropensource/engine/base/logging/LoggingThread.java @@ -31,7 +31,6 @@ import org.jetbrains.annotations.NotNull; * @since v1-alpha4 */ @Slf4j -@SuppressWarnings({ "JavadocDeclaration" }) public class LoggingThread { /** * Contains the {@link LoggerInstance} for this instance. @@ -74,11 +73,11 @@ public class LoggingThread { private static Thread loggingThread; /** - * Constructs this class. + * Creates and initializes an instance of this class * * @since v1-alpha4 */ - public LoggingThread() {} + private LoggingThread() {} /** * Reconstructs the {@link #loggingThread} thread. diff --git a/base/src/main/java/de/staropensource/engine/base/logging/PrintStreamService.java b/base/src/main/java/de/staropensource/engine/base/logging/PrintStreamService.java index 0f8eb631..7805fc8c 100644 --- a/base/src/main/java/de/staropensource/engine/base/logging/PrintStreamService.java +++ b/base/src/main/java/de/staropensource/engine/base/logging/PrintStreamService.java @@ -164,11 +164,11 @@ public final class PrintStreamService { private static PrintStream crash = null; /** - * Constructs this class. + * Creates and initializes an instance of this class. * * @since v1-alpha4 */ - public PrintStreamService() {} + private PrintStreamService() {} /** * Initializes all {@link PrintStream}s offered by this class. diff --git a/base/src/main/java/de/staropensource/engine/base/reflection/ClasspathAccess.java b/base/src/main/java/de/staropensource/engine/base/reflection/ClasspathAccess.java index caee985b..884815ef 100644 --- a/base/src/main/java/de/staropensource/engine/base/reflection/ClasspathAccess.java +++ b/base/src/main/java/de/staropensource/engine/base/reflection/ClasspathAccess.java @@ -48,11 +48,11 @@ public final class ClasspathAccess { private static final @NotNull LoggerInstance logger = new LoggerInstance.Builder().setClazz(ClasspathAccess.class).setOrigin("ENGINE").build(); /** - * Constructs this class. + * Creates and initializes an instance of this class. * * @since v1-alpha2 */ - public ClasspathAccess() {} + private ClasspathAccess() {} /** * Returns the classpath as a collection of {@link URL}s. diff --git a/base/src/main/java/de/staropensource/engine/base/reflection/Reflect.java b/base/src/main/java/de/staropensource/engine/base/reflection/Reflect.java index 4a1550a4..0fb1aede 100644 --- a/base/src/main/java/de/staropensource/engine/base/reflection/Reflect.java +++ b/base/src/main/java/de/staropensource/engine/base/reflection/Reflect.java @@ -31,11 +31,11 @@ import java.lang.reflect.Method; */ public final class Reflect { /** - * Constructs this class. + * Creates and initializes an instance of this class. * * @since v1-alpha2 */ - public Reflect() {} + private Reflect() {} /** * Reflect on a {@link Class}. diff --git a/base/src/main/java/de/staropensource/engine/base/reflection/ReflectionClass.java b/base/src/main/java/de/staropensource/engine/base/reflection/ReflectionClass.java index 60a4c721..9c3e806f 100644 --- a/base/src/main/java/de/staropensource/engine/base/reflection/ReflectionClass.java +++ b/base/src/main/java/de/staropensource/engine/base/reflection/ReflectionClass.java @@ -39,7 +39,7 @@ import java.lang.reflect.Modifier; @SuppressWarnings({ "unused" }) public record ReflectionClass(Class clazz) { /** - * Constructs this class. + * Creates and initializes an instance of this class. * * @param clazz class to reflect on * @since v1-alpha2 diff --git a/base/src/main/java/de/staropensource/engine/base/reflection/ReflectionField.java b/base/src/main/java/de/staropensource/engine/base/reflection/ReflectionField.java index dcbc1b9a..bd3eb5db 100644 --- a/base/src/main/java/de/staropensource/engine/base/reflection/ReflectionField.java +++ b/base/src/main/java/de/staropensource/engine/base/reflection/ReflectionField.java @@ -39,7 +39,6 @@ import java.lang.reflect.Modifier; @Getter @SuppressWarnings({ "unused", "JavadocDeclaration" }) public final class ReflectionField { - /** * Contains a reference to the parent class. * @@ -65,7 +64,7 @@ public final class ReflectionField { private final @NotNull Field field; /** - * Constructs this class. + * Creates and initializes an instance of this class. * * @param field field to reflect on */ diff --git a/base/src/main/java/de/staropensource/engine/base/reflection/ReflectionMethod.java b/base/src/main/java/de/staropensource/engine/base/reflection/ReflectionMethod.java index fd7510cd..7b61a269 100644 --- a/base/src/main/java/de/staropensource/engine/base/reflection/ReflectionMethod.java +++ b/base/src/main/java/de/staropensource/engine/base/reflection/ReflectionMethod.java @@ -69,7 +69,7 @@ public final class ReflectionMethod { private final Method method; /** - * Constructs this class. + * Creates and initializes an instance of this class. * * @param method method to reflect on */ @@ -79,7 +79,7 @@ public final class ReflectionMethod { } /** - * Constructs this class. + * Creates and initializes an instance of this class. * * @param parentClass parent class of method * @param method method to reflect on diff --git a/base/src/main/java/de/staropensource/engine/base/type/Color.java b/base/src/main/java/de/staropensource/engine/base/type/Color.java index a49321cb..9c933106 100644 --- a/base/src/main/java/de/staropensource/engine/base/type/Color.java +++ b/base/src/main/java/de/staropensource/engine/base/type/Color.java @@ -109,7 +109,7 @@ public final class Color { private @Range(from = 0, to = 255) int alpha; /** - * Creates a new instance. + * Creates and initializes an instance of this class. * * @param red red color value * @param green green color value diff --git a/base/src/main/java/de/staropensource/engine/base/type/DependencyVector.java b/base/src/main/java/de/staropensource/engine/base/type/DependencyVector.java index cc428be8..26c88274 100644 --- a/base/src/main/java/de/staropensource/engine/base/type/DependencyVector.java +++ b/base/src/main/java/de/staropensource/engine/base/type/DependencyVector.java @@ -99,7 +99,7 @@ public class DependencyVector { protected @NotNull Set<@NotNull String> provides; /** - * Creates a new dependency vector. + * Creates and initializes an instance of this class. * * @param identifier identifier (name for example) * @param versioningSystem versioning system to use diff --git a/base/src/main/java/de/staropensource/engine/base/type/immutable/ImmutableArrayList.java b/base/src/main/java/de/staropensource/engine/base/type/immutable/ImmutableArrayList.java index d8fcd31d..9cd84911 100644 --- a/base/src/main/java/de/staropensource/engine/base/type/immutable/ImmutableArrayList.java +++ b/base/src/main/java/de/staropensource/engine/base/type/immutable/ImmutableArrayList.java @@ -33,13 +33,14 @@ import java.util.function.UnaryOperator; @SuppressWarnings({ "unused" }) public class ImmutableArrayList extends ArrayList { /** - * Creates a new immutable array list. + * Creates and initializes an instance of this class. * * @since v1-alpha1 */ public ImmutableArrayList() {} /** + * Creates and initializes an instance of this class. * Converts a {@link LinkedList} into an {@link ImmutableArrayList}. * * @param list {@link List} to convert diff --git a/base/src/main/java/de/staropensource/engine/base/type/immutable/ImmutableHashMap.java b/base/src/main/java/de/staropensource/engine/base/type/immutable/ImmutableHashMap.java index b11eb6c0..df1fc195 100644 --- a/base/src/main/java/de/staropensource/engine/base/type/immutable/ImmutableHashMap.java +++ b/base/src/main/java/de/staropensource/engine/base/type/immutable/ImmutableHashMap.java @@ -36,13 +36,14 @@ import java.util.function.BiFunction; @SuppressWarnings({ "unused" }) public class ImmutableHashMap extends HashMap { /** - * Creates a new immutable hash map. + * Creates and initializes an instance of this class. * * @since v1-alpha1 */ public ImmutableHashMap() {} /** + * Creates and initializes an instance of this class. * Converts a {@link Map} into an {@link ImmutableHashMap}. * * @param map {@link Map} to convert diff --git a/base/src/main/java/de/staropensource/engine/base/type/immutable/ImmutableHashSet.java b/base/src/main/java/de/staropensource/engine/base/type/immutable/ImmutableHashSet.java index 481dc69c..cf6df2a2 100644 --- a/base/src/main/java/de/staropensource/engine/base/type/immutable/ImmutableHashSet.java +++ b/base/src/main/java/de/staropensource/engine/base/type/immutable/ImmutableHashSet.java @@ -35,13 +35,14 @@ import java.util.function.Predicate; @SuppressWarnings({ "unused" }) public class ImmutableHashSet extends HashSet { /** - * Creates a new immutable hash set. + * Creates and initializes an instance of this class. * * @since v1-alpha2 */ public ImmutableHashSet() {} /** + * Creates and initializes an instance of this class. * Converts a {@link Set} into an {@link ImmutableHashSet}. * * @param set {@link Set} to convert diff --git a/base/src/main/java/de/staropensource/engine/base/type/immutable/ImmutableLinkedHashMap.java b/base/src/main/java/de/staropensource/engine/base/type/immutable/ImmutableLinkedHashMap.java index b8ff41c6..dd0b6eec 100644 --- a/base/src/main/java/de/staropensource/engine/base/type/immutable/ImmutableLinkedHashMap.java +++ b/base/src/main/java/de/staropensource/engine/base/type/immutable/ImmutableLinkedHashMap.java @@ -36,13 +36,14 @@ import java.util.function.BiFunction; @SuppressWarnings({ "unused" }) public class ImmutableLinkedHashMap extends LinkedHashMap { /** - * Creates a new immutable linked hash map. + * Creates and initializes an instance of this class. * * @since v1-alpha1 */ public ImmutableLinkedHashMap() {} /** + * Creates and initializes an instance of this class. * Converts a {@link Map} into an {@link ImmutableLinkedHashMap}. * * @param map {@link Map} to convert diff --git a/base/src/main/java/de/staropensource/engine/base/type/immutable/ImmutableLinkedList.java b/base/src/main/java/de/staropensource/engine/base/type/immutable/ImmutableLinkedList.java index fc4fc73f..4fe5246d 100644 --- a/base/src/main/java/de/staropensource/engine/base/type/immutable/ImmutableLinkedList.java +++ b/base/src/main/java/de/staropensource/engine/base/type/immutable/ImmutableLinkedList.java @@ -33,13 +33,14 @@ import java.util.function.UnaryOperator; @SuppressWarnings({ "unused" }) public class ImmutableLinkedList extends LinkedList { /** - * Creates a new immutable linked list. + * Creates and initializes an instance of this class. * * @since v1-alpha1 */ public ImmutableLinkedList() {} /** + * Creates and initializes an instance of this class. * Converts a {@link LinkedList} into an {@link ImmutableLinkedList}. * * @param list {@link List} to convert diff --git a/base/src/main/java/de/staropensource/engine/base/type/logging/LogRule.java b/base/src/main/java/de/staropensource/engine/base/type/logging/LogRule.java index 9a64526b..8e483b3b 100644 --- a/base/src/main/java/de/staropensource/engine/base/type/logging/LogRule.java +++ b/base/src/main/java/de/staropensource/engine/base/type/logging/LogRule.java @@ -46,7 +46,7 @@ public abstract class LogRule { private final @NotNull LogRuleType type; /** - * Creates a new log rule. + * Initializes this abstract class. * * @param type rule type */ diff --git a/base/src/main/java/de/staropensource/engine/base/type/vector/Vec2d.java b/base/src/main/java/de/staropensource/engine/base/type/vector/Vec2d.java index 65500cba..d5c70ee8 100644 --- a/base/src/main/java/de/staropensource/engine/base/type/vector/Vec2d.java +++ b/base/src/main/java/de/staropensource/engine/base/type/vector/Vec2d.java @@ -69,7 +69,7 @@ public final class Vec2d { private double y; /** - * Creates a new 2D vector. + * Creates and initializes a new 2D double vector. * * @param x X axis value * @param y Y axis value diff --git a/base/src/main/java/de/staropensource/engine/base/type/vector/Vec2f.java b/base/src/main/java/de/staropensource/engine/base/type/vector/Vec2f.java index d304fa69..63e5c4d5 100644 --- a/base/src/main/java/de/staropensource/engine/base/type/vector/Vec2f.java +++ b/base/src/main/java/de/staropensource/engine/base/type/vector/Vec2f.java @@ -69,7 +69,7 @@ public final class Vec2f { private float y; /** - * Creates a new 2D vector. + * Creates and initializes a new 2D float vector. * * @param x X axis value * @param y Y axis value diff --git a/base/src/main/java/de/staropensource/engine/base/type/vector/Vec2i.java b/base/src/main/java/de/staropensource/engine/base/type/vector/Vec2i.java index 5ae1217b..e7a6f0d6 100644 --- a/base/src/main/java/de/staropensource/engine/base/type/vector/Vec2i.java +++ b/base/src/main/java/de/staropensource/engine/base/type/vector/Vec2i.java @@ -69,7 +69,7 @@ public final class Vec2i implements Cloneable { private int y; /** - * Creates a new 2D integer vector. + * Creates and initializes a new 2D integer vector. * * @param x X axis value * @param y Y axis value diff --git a/base/src/main/java/de/staropensource/engine/base/type/vector/Vec3d.java b/base/src/main/java/de/staropensource/engine/base/type/vector/Vec3d.java index 901d1887..c679d87b 100644 --- a/base/src/main/java/de/staropensource/engine/base/type/vector/Vec3d.java +++ b/base/src/main/java/de/staropensource/engine/base/type/vector/Vec3d.java @@ -86,7 +86,7 @@ public final class Vec3d { private double z; /** - * Constructs this 3D vector. + * Creates and initializes a new 3D double vector. * * @param x X axis value * @param y Y axis value diff --git a/base/src/main/java/de/staropensource/engine/base/type/vector/Vec3f.java b/base/src/main/java/de/staropensource/engine/base/type/vector/Vec3f.java index 91846926..89040c28 100644 --- a/base/src/main/java/de/staropensource/engine/base/type/vector/Vec3f.java +++ b/base/src/main/java/de/staropensource/engine/base/type/vector/Vec3f.java @@ -86,7 +86,7 @@ public final class Vec3f { private float z; /** - * Constructs this 3D vector. + * Creates and initializes a new 3D float vector. * * @param x X axis value * @param y Y axis value diff --git a/base/src/main/java/de/staropensource/engine/base/type/vector/Vec3i.java b/base/src/main/java/de/staropensource/engine/base/type/vector/Vec3i.java index bc0f39ce..598a7963 100644 --- a/base/src/main/java/de/staropensource/engine/base/type/vector/Vec3i.java +++ b/base/src/main/java/de/staropensource/engine/base/type/vector/Vec3i.java @@ -86,7 +86,7 @@ public final class Vec3i { private int z; /** - * Constructs this 3D integer vector. + * Creates and initializes a new 3D integer vector. * * @param x X axis value * @param y Y axis value diff --git a/base/src/main/java/de/staropensource/engine/base/type/vector/Vec4d.java b/base/src/main/java/de/staropensource/engine/base/type/vector/Vec4d.java index c0717df0..65863b0c 100644 --- a/base/src/main/java/de/staropensource/engine/base/type/vector/Vec4d.java +++ b/base/src/main/java/de/staropensource/engine/base/type/vector/Vec4d.java @@ -103,7 +103,7 @@ public final class Vec4d { private double w; /** - * Constructs this 3D vector. + * Creates and initializes a new 4D double vector. * * @param x X axis value * @param y Y axis value diff --git a/base/src/main/java/de/staropensource/engine/base/type/vector/Vec4f.java b/base/src/main/java/de/staropensource/engine/base/type/vector/Vec4f.java index d799f3e5..ed5b3377 100644 --- a/base/src/main/java/de/staropensource/engine/base/type/vector/Vec4f.java +++ b/base/src/main/java/de/staropensource/engine/base/type/vector/Vec4f.java @@ -103,7 +103,7 @@ public final class Vec4f { private float w; /** - * Constructs this 3D vector. + * Creates and initializes a new 4D float vector. * * @param x X axis value * @param y Y axis value diff --git a/base/src/main/java/de/staropensource/engine/base/type/vector/Vec4i.java b/base/src/main/java/de/staropensource/engine/base/type/vector/Vec4i.java index c8f5f9ed..a25c846e 100644 --- a/base/src/main/java/de/staropensource/engine/base/type/vector/Vec4i.java +++ b/base/src/main/java/de/staropensource/engine/base/type/vector/Vec4i.java @@ -103,7 +103,7 @@ public final class Vec4i { private int w; /** - * Constructs this 3D integer vector. + * Creates and initializes a new 4D integer vector. * * @param x X axis value * @param y Y axis value diff --git a/base/src/main/java/de/staropensource/engine/base/utility/DependencyResolver.java b/base/src/main/java/de/staropensource/engine/base/utility/DependencyResolver.java index 82d367a6..303479ac 100644 --- a/base/src/main/java/de/staropensource/engine/base/utility/DependencyResolver.java +++ b/base/src/main/java/de/staropensource/engine/base/utility/DependencyResolver.java @@ -68,7 +68,7 @@ public final class DependencyResolver { private boolean resolved = false; /** - * Constructs this class. + * Creates and initializes an instance of this class. * * @since v1-alpha1 */ diff --git a/base/src/main/java/de/staropensource/engine/base/utility/ListFormatter.java b/base/src/main/java/de/staropensource/engine/base/utility/ListFormatter.java index bf2a6331..e9b579c3 100644 --- a/base/src/main/java/de/staropensource/engine/base/utility/ListFormatter.java +++ b/base/src/main/java/de/staropensource/engine/base/utility/ListFormatter.java @@ -32,11 +32,11 @@ import java.util.Set; */ public final class ListFormatter { /** - * Constructs this class. + * Creates and initializes an instance of this class. * - * @since v1-alpha4 + * @since v1-alpha6 */ - public ListFormatter() {} + private ListFormatter() {} /** * Converts an array to a {@link String}. diff --git a/base/src/main/java/de/staropensource/engine/base/utility/Math.java b/base/src/main/java/de/staropensource/engine/base/utility/Math.java index e2850018..5ecc0dde 100644 --- a/base/src/main/java/de/staropensource/engine/base/utility/Math.java +++ b/base/src/main/java/de/staropensource/engine/base/utility/Math.java @@ -34,11 +34,11 @@ import java.util.LinkedList; @SuppressWarnings({ "unused" }) public final class Math { /** - * Constructs this class. + * Creates and initializes an instance of this class * - * @since v1-alpha2 + * @since v1-alpha6 */ - public Math() {} + private Math() {} /** * Adds padding zeros to a number. diff --git a/base/src/main/java/de/staropensource/engine/base/utility/Miscellaneous.java b/base/src/main/java/de/staropensource/engine/base/utility/Miscellaneous.java index e0995a7e..b0b1cf1f 100644 --- a/base/src/main/java/de/staropensource/engine/base/utility/Miscellaneous.java +++ b/base/src/main/java/de/staropensource/engine/base/utility/Miscellaneous.java @@ -38,11 +38,11 @@ import java.util.stream.Collectors; @SuppressWarnings({ "unused" }) public final class Miscellaneous { /** - * Constructs this class. + * Creates and initializes an instance of this class. * - * @since v1-alpha0 + * @since v1-alpha6 */ - public Miscellaneous() {} + private Miscellaneous() {} /** * Converts a boolean into an integer. diff --git a/base/src/main/java/de/staropensource/engine/base/utility/PlaceholderEngine.java b/base/src/main/java/de/staropensource/engine/base/utility/PlaceholderEngine.java index 650b6590..4629d139 100644 --- a/base/src/main/java/de/staropensource/engine/base/utility/PlaceholderEngine.java +++ b/base/src/main/java/de/staropensource/engine/base/utility/PlaceholderEngine.java @@ -74,19 +74,11 @@ public final class PlaceholderEngine { private @NotNull List<@NotNull Placeholder> placeholders = new ArrayList<>(); /** - * Constructs this class. + * Creates and initializes an instance of this class. * - * @since v1-alpha0 + * @since v1-alpha6 */ - public PlaceholderEngine() { - // Only allow one instance - if (instance == null) - instance = this; - else { - logger.crash("Tried reinitializing " + getClass().getName() + " twice"); - return; - } - + private PlaceholderEngine() { // Add default placeholders. // date_* placeholders.add(new DateDay()); @@ -134,6 +126,17 @@ public final class PlaceholderEngine { placeholders.add(new TimeZone()); } + /** + * Creates and initializes a new instance + * of this class if none already exists. + * + * @since v1-alpha6 + */ + public static void initialize() { + if (instance == null) + instance = new PlaceholderEngine(); + } + /** * Process all placeholders for a given {@code text}. * diff --git a/base/src/main/java/de/staropensource/engine/base/utility/PropertiesReader.java b/base/src/main/java/de/staropensource/engine/base/utility/PropertiesReader.java index a68652a1..9606e975 100644 --- a/base/src/main/java/de/staropensource/engine/base/utility/PropertiesReader.java +++ b/base/src/main/java/de/staropensource/engine/base/utility/PropertiesReader.java @@ -73,7 +73,7 @@ public final class PropertiesReader { private final @NotNull Properties properties; /** - * Creates a new {@link PropertiesReader} instance. + * Creates and initializes an instance of this class. * * @param properties {@link Properties} to use * @since v1-alpha0 diff --git a/base/src/main/java/de/staropensource/engine/base/utility/information/EngineInformation.java b/base/src/main/java/de/staropensource/engine/base/utility/information/EngineInformation.java index 3a81b1e8..6c950abd 100644 --- a/base/src/main/java/de/staropensource/engine/base/utility/information/EngineInformation.java +++ b/base/src/main/java/de/staropensource/engine/base/utility/information/EngineInformation.java @@ -333,11 +333,11 @@ public final class EngineInformation { private static String dependencyLwjgl; /** - * Constructs this class. + * Creates and initializes an instance of this class. * - * @since v1-alpha0 + * @since v1-alpha6 */ - public EngineInformation() {} + private EngineInformation() {} /** * Updates all variables. diff --git a/base/src/main/java/de/staropensource/engine/base/utility/information/JvmInformation.java b/base/src/main/java/de/staropensource/engine/base/utility/information/JvmInformation.java index f113810c..1ca639aa 100644 --- a/base/src/main/java/de/staropensource/engine/base/utility/information/JvmInformation.java +++ b/base/src/main/java/de/staropensource/engine/base/utility/information/JvmInformation.java @@ -42,11 +42,11 @@ public final class JvmInformation { private static final @NotNull LoggerInstance logger = new LoggerInstance.Builder().setClazz(JvmInformation.class).setOrigin("ENGINE").build(); /** - * Constructs this class. + * Creates and initializes an instance of this class. * - * @since v1-alpha0 + * @since v1-alpha6 */ - public JvmInformation() {} + private JvmInformation() {} /** * Returns the Java version this JVM implements. diff --git a/slf4j-compat/src/main/java/de/staropensource/engine/slf4j_compat/CompatibilityLogger.java b/slf4j-compat/src/main/java/de/staropensource/engine/slf4j_compat/CompatibilityLogger.java index e90a3c7c..6076c86a 100644 --- a/slf4j-compat/src/main/java/de/staropensource/engine/slf4j_compat/CompatibilityLogger.java +++ b/slf4j-compat/src/main/java/de/staropensource/engine/slf4j_compat/CompatibilityLogger.java @@ -44,12 +44,11 @@ public final class CompatibilityLogger extends LegacyAbstractLogger { private final LoggerInstance logger = new LoggerInstance.Builder().setClazz(getClass()).setOrigin("ENGINE").build(); /** - * Protected access allows only {@link CompatibilityLoggerFactory} and also derived classes to instantiate - * {@link CompatibilityLogger} instances. + * Creates and initializes an instance of this class. * - * @since v1-alpha0 + * @since v1-alpha6 */ - protected CompatibilityLogger(String name) { + CompatibilityLogger(String name) { this.name = name; } diff --git a/slf4j-compat/src/main/java/de/staropensource/engine/slf4j_compat/CompatibilityLoggerFactory.java b/slf4j-compat/src/main/java/de/staropensource/engine/slf4j_compat/CompatibilityLoggerFactory.java index 5ab155fe..6fbdfc8d 100644 --- a/slf4j-compat/src/main/java/de/staropensource/engine/slf4j_compat/CompatibilityLoggerFactory.java +++ b/slf4j-compat/src/main/java/de/staropensource/engine/slf4j_compat/CompatibilityLoggerFactory.java @@ -35,7 +35,7 @@ public final class CompatibilityLoggerFactory implements ILoggerFactory { ConcurrentMap<@NotNull String, @NotNull Logger> loggerMap; /** - * Constructs this class. + * Creates and initializes an instance of this class. * * @since v1-alpha0 */ @@ -62,7 +62,7 @@ public final class CompatibilityLoggerFactory implements ILoggerFactory { * @param name name * @since v1-alpha0 */ - protected Logger createLogger(String name) { + private Logger createLogger(String name) { return new CompatibilityLogger(name); } } diff --git a/slf4j-compat/src/main/java/de/staropensource/engine/slf4j_compat/CompatibilityLoggerProvider.java b/slf4j-compat/src/main/java/de/staropensource/engine/slf4j_compat/CompatibilityLoggerProvider.java index 328d8212..da3a2103 100644 --- a/slf4j-compat/src/main/java/de/staropensource/engine/slf4j_compat/CompatibilityLoggerProvider.java +++ b/slf4j-compat/src/main/java/de/staropensource/engine/slf4j_compat/CompatibilityLoggerProvider.java @@ -64,7 +64,7 @@ public final class CompatibilityLoggerProvider implements SLF4JServiceProvider { private MDCAdapter mDCAdapter; /** - * Constructs this class. + * Creates and initializes an instance of this class. * * @since v1-alpha0 */ diff --git a/slf4j-compat/src/main/java/de/staropensource/engine/slf4j_compat/Slf4jCompatSubsystem.java b/slf4j-compat/src/main/java/de/staropensource/engine/slf4j_compat/Slf4jCompatSubsystem.java index b8234530..602c9b91 100644 --- a/slf4j-compat/src/main/java/de/staropensource/engine/slf4j_compat/Slf4jCompatSubsystem.java +++ b/slf4j-compat/src/main/java/de/staropensource/engine/slf4j_compat/Slf4jCompatSubsystem.java @@ -57,7 +57,7 @@ public final class Slf4jCompatSubsystem extends SubsystemClass { private static Slf4jCompatSubsystem instance = null; /** - * Constructs this subsystem. + * Initializes this subsystem. * * @since v1-alpha0 */ diff --git a/testapp/src/main/java/de/staropensource/engine/testapp/Main.java b/testapp/src/main/java/de/staropensource/engine/testapp/Main.java index 455191ef..eaf5a85d 100644 --- a/testapp/src/main/java/de/staropensource/engine/testapp/Main.java +++ b/testapp/src/main/java/de/staropensource/engine/testapp/Main.java @@ -58,19 +58,6 @@ public final class Main { @Getter private static final Main instance = new Main(); - /** - * Reference to the main engine object. - * - * @see Engine - * -- GETTER -- - * Returns the main engine object. - * - * @return sos!engine object - * @see Engine - */ - @Getter - private Engine engine; - /** * Contains the {@link LoggerInstance} for this instance. * @@ -80,18 +67,19 @@ public final class Main { private final @NotNull LoggerInstance logger = new LoggerInstance.Builder().setClazz(getClass()).build(); /** - * Used for terminating the render loop. + * Contains whether or not the + * render loop shall be terminated. * * @since v1-alpha2 */ private boolean shutdown; /** - * Constructs this class. + * Creates and initializes an instance of this class. * - * @since v1-alpha0 + * @since v1-alpha6 */ - public Main() {} + private Main() {} /** * The program's entrypoint. @@ -124,7 +112,7 @@ public final class Main { ); // Initialize sos!engine - engine = new Engine(); + Engine.initialize(); // Register events EventHelper.registerEvent(InputEvent.class, new EventListenerCode() { diff --git a/testing/src/main/java/de/staropensource/engine/testing/TestBase.java b/testing/src/main/java/de/staropensource/engine/testing/TestBase.java index 28105366..dcf1d1d4 100644 --- a/testing/src/main/java/de/staropensource/engine/testing/TestBase.java +++ b/testing/src/main/java/de/staropensource/engine/testing/TestBase.java @@ -92,7 +92,7 @@ public class TestBase { private boolean controlWarning; /** - * Constructs this class. + * Creates and initializes an instance of this class. * * @since v1-alpha4 */ diff --git a/testing/src/main/java/de/staropensource/engine/testing/UnitConfig.java b/testing/src/main/java/de/staropensource/engine/testing/UnitConfig.java index 0898f898..3b5e937e 100644 --- a/testing/src/main/java/de/staropensource/engine/testing/UnitConfig.java +++ b/testing/src/main/java/de/staropensource/engine/testing/UnitConfig.java @@ -28,11 +28,11 @@ import de.staropensource.engine.base.type.logging.LogLevel; */ public class UnitConfig { /** - * Constructs this class. + * Creates and initializes an instance of this class. * - * @since v1-alpha4 + * @since v1-alpha6 */ - public UnitConfig() {} + private UnitConfig() {} /** * Configures the {@link LogLevel} for the {@link UnitLogger}. diff --git a/testing/src/main/java/de/staropensource/engine/testing/UnitLogger.java b/testing/src/main/java/de/staropensource/engine/testing/UnitLogger.java index 014f576e..fafa298d 100644 --- a/testing/src/main/java/de/staropensource/engine/testing/UnitLogger.java +++ b/testing/src/main/java/de/staropensource/engine/testing/UnitLogger.java @@ -37,7 +37,7 @@ public class UnitLogger { private final Class clazz; /** - * Creates a new unit logger. + * Creates and initializes an instance of this class. * * @param clazz parent class * @since v1-alpha4 diff --git a/windowing/glfw/src/main/java/de/staropensource/engine/windowing/glfw/GlfwSubsystem.java b/windowing/glfw/src/main/java/de/staropensource/engine/windowing/glfw/GlfwSubsystem.java index 828ccc91..66bba72b 100644 --- a/windowing/glfw/src/main/java/de/staropensource/engine/windowing/glfw/GlfwSubsystem.java +++ b/windowing/glfw/src/main/java/de/staropensource/engine/windowing/glfw/GlfwSubsystem.java @@ -111,7 +111,7 @@ public final class GlfwSubsystem extends ApiClass { }); /** - * Constructs this subsystem. + * Initializes this subsystem. * * @since v1-alpha2 */ diff --git a/windowing/glfw/src/main/java/de/staropensource/engine/windowing/glfw/GlfwSubsystemConfiguration.java b/windowing/glfw/src/main/java/de/staropensource/engine/windowing/glfw/GlfwSubsystemConfiguration.java index ace93d26..aeef1b3a 100644 --- a/windowing/glfw/src/main/java/de/staropensource/engine/windowing/glfw/GlfwSubsystemConfiguration.java +++ b/windowing/glfw/src/main/java/de/staropensource/engine/windowing/glfw/GlfwSubsystemConfiguration.java @@ -37,12 +37,12 @@ public final class GlfwSubsystemConfiguration extends Configuration { /** * Contains the class instance. * - * @since v1-alpha0 + * @since v1-alpha2 * -- GETTER -- * Returns the class instance. * * @return class instance unless {@link GlfwSubsystem} is uninitialized - * @since v1-alpha0 + * @since v1-alpha2 */ @Getter private static GlfwSubsystemConfiguration instance; @@ -50,12 +50,12 @@ public final class GlfwSubsystemConfiguration extends Configuration { /** * Defines prefix properties must begin with. * - * @since v1-alpha0 + * @since v1-alpha2 * -- GETTER -- * Returns prefix properties must begin with. * * @return property group - * @since v1-alpha0 + * @since v1-alpha2 */ private final @NotNull String group = "sosengine.windowing.glfw."; @@ -89,12 +89,12 @@ public final class GlfwSubsystemConfiguration extends Configuration { private boolean disableLibdecor; /** - * Constructs this class. + * Creates and initializes an instance of this class. * * @see GlfwSubsystem - * @since v1-alpha0 + * @since v1-alpha6 */ - public GlfwSubsystemConfiguration() { + GlfwSubsystemConfiguration() { super("ENGINE"); // TODO Wait for flexible constructor bodies (JEP 482) to be implemented into the JVM as a stable feature. We don't want to use preview features in production code. // Only allow one instance diff --git a/windowing/glfw/src/main/java/de/staropensource/engine/windowing/glfw/callback/KeyCallback.java b/windowing/glfw/src/main/java/de/staropensource/engine/windowing/glfw/callback/KeyCallback.java index 582496fe..00b288f7 100644 --- a/windowing/glfw/src/main/java/de/staropensource/engine/windowing/glfw/callback/KeyCallback.java +++ b/windowing/glfw/src/main/java/de/staropensource/engine/windowing/glfw/callback/KeyCallback.java @@ -30,7 +30,7 @@ import org.lwjgl.glfw.GLFWKeyCallbackI; import static org.lwjgl.glfw.GLFW.*; /** - * A {@link GLFWKeyCallbackI} implementation, which forward them to {@link InputEvent}. + * A {@link GLFWKeyCallbackI} implementation, which emits {@link InputEvent}. * * @since v1-alpha2 */ @@ -45,7 +45,7 @@ public final class KeyCallback extends WindowCallback implements GLFWKeyCallback private static final InputEvent event = new InputEvent(); /** - * Constructs this class. + * Creates and initializes an instance of this class. * * @param window {@link Window} class * @since v1-alpha2 diff --git a/windowing/glfw/src/main/java/de/staropensource/engine/windowing/glfw/callback/MouseButtonCallback.java b/windowing/glfw/src/main/java/de/staropensource/engine/windowing/glfw/callback/MouseButtonCallback.java index dd3ab229..44164848 100644 --- a/windowing/glfw/src/main/java/de/staropensource/engine/windowing/glfw/callback/MouseButtonCallback.java +++ b/windowing/glfw/src/main/java/de/staropensource/engine/windowing/glfw/callback/MouseButtonCallback.java @@ -45,7 +45,7 @@ public final class MouseButtonCallback extends WindowCallback implements GLFWMou private static final InputEvent event = new InputEvent(); /** - * Constructs this class. + * Creates and initializes an instance of this class. * * @param window {@link Window} class * @since v1-alpha2 diff --git a/windowing/glfw/src/main/java/de/staropensource/engine/windowing/glfw/implementable/GlfwInternalClass.java b/windowing/glfw/src/main/java/de/staropensource/engine/windowing/glfw/implementable/GlfwInternalClass.java index 9512932c..5e8443ef 100644 --- a/windowing/glfw/src/main/java/de/staropensource/engine/windowing/glfw/implementable/GlfwInternalClass.java +++ b/windowing/glfw/src/main/java/de/staropensource/engine/windowing/glfw/implementable/GlfwInternalClass.java @@ -71,7 +71,7 @@ public final class GlfwInternalClass implements ApiInternalClass { private @NotNull Class windowClass = GlfwWindow.class; /** - * Constructs this class. + * Creates and initializes an instance of this class. * * @since v1-alpha2 */ diff --git a/windowing/glfw/src/main/java/de/staropensource/engine/windowing/glfw/implementable/GlfwManagementClass.java b/windowing/glfw/src/main/java/de/staropensource/engine/windowing/glfw/implementable/GlfwManagementClass.java index c2482174..0afe5b22 100644 --- a/windowing/glfw/src/main/java/de/staropensource/engine/windowing/glfw/implementable/GlfwManagementClass.java +++ b/windowing/glfw/src/main/java/de/staropensource/engine/windowing/glfw/implementable/GlfwManagementClass.java @@ -43,10 +43,10 @@ public final class GlfwManagementClass extends ApiManagementClass { * * @since v1-alpha2 */ - protected LoggerInstance logger = new LoggerInstance.Builder().setClazz(getClass()).setOrigin("ENGINE").build(); + private final LoggerInstance logger = new LoggerInstance.Builder().setClazz(getClass()).setOrigin("ENGINE").build(); /** - * Constructs this class. + * Creates and initializes an instance of this class. * * @since v1-alpha2 */ diff --git a/windowing/glfw/src/main/java/de/staropensource/engine/windowing/glfw/implementable/GlfwMonitor.java b/windowing/glfw/src/main/java/de/staropensource/engine/windowing/glfw/implementable/GlfwMonitor.java index 2985a15f..12fd6e15 100644 --- a/windowing/glfw/src/main/java/de/staropensource/engine/windowing/glfw/implementable/GlfwMonitor.java +++ b/windowing/glfw/src/main/java/de/staropensource/engine/windowing/glfw/implementable/GlfwMonitor.java @@ -50,7 +50,7 @@ public final class GlfwMonitor extends Monitor { private final long identifierLong; /** - * Constructs this class. + * Creates and initializes an instance of this class. * * @param identifier glfw monitor pointer * @since v1-alpha2 diff --git a/windowing/glfw/src/main/java/de/staropensource/engine/windowing/glfw/implementable/GlfwWindow.java b/windowing/glfw/src/main/java/de/staropensource/engine/windowing/glfw/implementable/GlfwWindow.java index 78889172..77a8def7 100644 --- a/windowing/glfw/src/main/java/de/staropensource/engine/windowing/glfw/implementable/GlfwWindow.java +++ b/windowing/glfw/src/main/java/de/staropensource/engine/windowing/glfw/implementable/GlfwWindow.java @@ -80,7 +80,7 @@ public class GlfwWindow extends Window { // ------------------------------------------------ [ Window (de)initialization ] ------------------------------------------------ // /** - * Creates a new window. + * Creates and initializes an instance of this class. * * @param name name * @param title title diff --git a/windowing/glfw/src/main/java/de/staropensource/engine/windowing/glfw/implementable/WindowCallback.java b/windowing/glfw/src/main/java/de/staropensource/engine/windowing/glfw/implementable/WindowCallback.java index e6fd6445..44824f9d 100644 --- a/windowing/glfw/src/main/java/de/staropensource/engine/windowing/glfw/implementable/WindowCallback.java +++ b/windowing/glfw/src/main/java/de/staropensource/engine/windowing/glfw/implementable/WindowCallback.java @@ -47,7 +47,7 @@ public class WindowCallback { private final @NotNull Window attachedWindow; /** - * Constructs this class. + * Initializes this abstract class. * * @param window {@link Window} class * @since v1-alpha2 diff --git a/windowing/src/main/java/de/staropensource/engine/windowing/WindowingSubsystem.java b/windowing/src/main/java/de/staropensource/engine/windowing/WindowingSubsystem.java index 1417f5b8..6655c878 100644 --- a/windowing/src/main/java/de/staropensource/engine/windowing/WindowingSubsystem.java +++ b/windowing/src/main/java/de/staropensource/engine/windowing/WindowingSubsystem.java @@ -41,7 +41,7 @@ import java.util.HashMap; import java.util.Map; /** - * The main class of the windowing subsystem. + * Main class of the {@code windowing} subsystem. * * @since v1-alpha0 */ @@ -92,7 +92,7 @@ public final class WindowingSubsystem extends SubsystemClass { private ApiClass api = null; /** - * Constructs this subsystem. + * Initializes this subsystem. * * @since v1-alpha0 */ diff --git a/windowing/src/main/java/de/staropensource/engine/windowing/WindowingSubsystemConfiguration.java b/windowing/src/main/java/de/staropensource/engine/windowing/WindowingSubsystemConfiguration.java index 07ca395c..ab7bfebf 100644 --- a/windowing/src/main/java/de/staropensource/engine/windowing/WindowingSubsystemConfiguration.java +++ b/windowing/src/main/java/de/staropensource/engine/windowing/WindowingSubsystemConfiguration.java @@ -29,7 +29,7 @@ import org.jetbrains.annotations.NotNull; import org.jetbrains.annotations.Nullable; /** - * Provides the windowing subsystem configuration. + * Provides the configuration of the windowing subsystem. * * @since v1-alpha0 */ @@ -165,12 +165,12 @@ public final class WindowingSubsystemConfiguration extends Configuration { private int maximumFramesPerSecond; /** - * Constructs this class. + * Creates and initializes an instance of this class. * * @see WindowingSubsystem - * @since v1-alpha0 + * @since v1-alpha6 */ - public WindowingSubsystemConfiguration() { + WindowingSubsystemConfiguration() { super("ENGINE"); // TODO Wait for flexible constructor bodies (JEP 482) to be implemented into the JVM as a stable feature. We don't want to use preview features in production code. // Only allow one instance diff --git a/windowing/src/main/java/de/staropensource/engine/windowing/event/InputEvent.java b/windowing/src/main/java/de/staropensource/engine/windowing/event/InputEvent.java index 0b33b760..e870af39 100644 --- a/windowing/src/main/java/de/staropensource/engine/windowing/event/InputEvent.java +++ b/windowing/src/main/java/de/staropensource/engine/windowing/event/InputEvent.java @@ -43,7 +43,7 @@ public final class InputEvent implements Event { private final LoggerInstance logger = new LoggerInstance.Builder().setClazz(getClass()).setOrigin("ENGINE").build(); /** - * Constructs this class. + * Creates and initializes an instance of this event. * * @since v1-alpha2 */ diff --git a/windowing/src/main/java/de/staropensource/engine/windowing/event/RenderingErrorEvent.java b/windowing/src/main/java/de/staropensource/engine/windowing/event/RenderingErrorEvent.java index 3550df84..cbbd63e9 100644 --- a/windowing/src/main/java/de/staropensource/engine/windowing/event/RenderingErrorEvent.java +++ b/windowing/src/main/java/de/staropensource/engine/windowing/event/RenderingErrorEvent.java @@ -30,7 +30,7 @@ import org.jetbrains.annotations.NotNull; */ public final class RenderingErrorEvent implements Event { /** - * Constructs this class. + * Creates and initializes an instance of this event. * * @since v1-alpha0 */ diff --git a/windowing/src/main/java/de/staropensource/engine/windowing/event/WindowingErrorEvent.java b/windowing/src/main/java/de/staropensource/engine/windowing/event/WindowingErrorEvent.java index 35cc7976..9c593162 100644 --- a/windowing/src/main/java/de/staropensource/engine/windowing/event/WindowingErrorEvent.java +++ b/windowing/src/main/java/de/staropensource/engine/windowing/event/WindowingErrorEvent.java @@ -30,7 +30,7 @@ import org.jetbrains.annotations.NotNull; */ public final class WindowingErrorEvent implements Event { /** - * Constructs this class. + * Creates and initializes an instance of this event. * * @since v1-alpha0 */ diff --git a/windowing/src/main/java/de/staropensource/engine/windowing/event/WindowingShutdownEvent.java b/windowing/src/main/java/de/staropensource/engine/windowing/event/WindowingShutdownEvent.java index afc4e080..eecf3b04 100644 --- a/windowing/src/main/java/de/staropensource/engine/windowing/event/WindowingShutdownEvent.java +++ b/windowing/src/main/java/de/staropensource/engine/windowing/event/WindowingShutdownEvent.java @@ -29,7 +29,7 @@ import de.staropensource.engine.base.implementable.helper.EventHelper; */ public final class WindowingShutdownEvent implements Event { /** - * Constructs this class. + * Creates and initializes an instance of this event. * * @since v1-alpha0 */ diff --git a/windowing/src/main/java/de/staropensource/engine/windowing/exception/InvalidMonitorException.java b/windowing/src/main/java/de/staropensource/engine/windowing/exception/InvalidMonitorException.java index c4bec072..1fb7ba36 100644 --- a/windowing/src/main/java/de/staropensource/engine/windowing/exception/InvalidMonitorException.java +++ b/windowing/src/main/java/de/staropensource/engine/windowing/exception/InvalidMonitorException.java @@ -26,7 +26,7 @@ package de.staropensource.engine.windowing.exception; */ public final class InvalidMonitorException extends RuntimeException { /** - * Constructs this exception. + * Creates and initializes an instance of this exception. * * @since v1-alpha2 */ diff --git a/windowing/src/main/java/de/staropensource/engine/windowing/exception/NoMonitorsFoundException.java b/windowing/src/main/java/de/staropensource/engine/windowing/exception/NoMonitorsFoundException.java index d3d5d209..4a28b25b 100644 --- a/windowing/src/main/java/de/staropensource/engine/windowing/exception/NoMonitorsFoundException.java +++ b/windowing/src/main/java/de/staropensource/engine/windowing/exception/NoMonitorsFoundException.java @@ -26,7 +26,7 @@ package de.staropensource.engine.windowing.exception; */ public final class NoMonitorsFoundException extends RuntimeException { /** - * Constructs this exception. + * Creates and initializes an instance of this exception. * * @since v1-alpha2 */ diff --git a/windowing/src/main/java/de/staropensource/engine/windowing/exception/NotOnMainThreadException.java b/windowing/src/main/java/de/staropensource/engine/windowing/exception/NotOnMainThreadException.java index c27bd27a..653faa68 100644 --- a/windowing/src/main/java/de/staropensource/engine/windowing/exception/NotOnMainThreadException.java +++ b/windowing/src/main/java/de/staropensource/engine/windowing/exception/NotOnMainThreadException.java @@ -26,7 +26,7 @@ package de.staropensource.engine.windowing.exception; */ public final class NotOnMainThreadException extends RuntimeException { /** - * Constructs this exception. + * Creates and initializes an instance of this exception. * * @since v1-alpha2 */ diff --git a/windowing/src/main/java/de/staropensource/engine/windowing/exception/WindowCreationFailureException.java b/windowing/src/main/java/de/staropensource/engine/windowing/exception/WindowCreationFailureException.java index 0a77b788..b60c7eb3 100644 --- a/windowing/src/main/java/de/staropensource/engine/windowing/exception/WindowCreationFailureException.java +++ b/windowing/src/main/java/de/staropensource/engine/windowing/exception/WindowCreationFailureException.java @@ -29,14 +29,14 @@ import org.jetbrains.annotations.NotNull; */ public final class WindowCreationFailureException extends RuntimeException { /** - * Constructs this exception. + * Creates and initializes an instance of this exception. * * @since v1-alpha2 */ public WindowCreationFailureException() {} /** - * Constructs this exception. + * Creates and initializes an instance of this exception. * * @param message error message * @since v1-alpha2 diff --git a/windowing/src/main/java/de/staropensource/engine/windowing/implementable/Monitor.java b/windowing/src/main/java/de/staropensource/engine/windowing/implementable/Monitor.java index 96502f00..3dff53d4 100644 --- a/windowing/src/main/java/de/staropensource/engine/windowing/implementable/Monitor.java +++ b/windowing/src/main/java/de/staropensource/engine/windowing/implementable/Monitor.java @@ -99,7 +99,7 @@ public abstract class Monitor { private String identifier = null; /** - * Constructs this class. + * Initializes this abstract class. * * @since v1-alpha2 */ diff --git a/windowing/src/main/java/de/staropensource/engine/windowing/implementable/Window.java b/windowing/src/main/java/de/staropensource/engine/windowing/implementable/Window.java index 8c918242..fc04f66e 100644 --- a/windowing/src/main/java/de/staropensource/engine/windowing/implementable/Window.java +++ b/windowing/src/main/java/de/staropensource/engine/windowing/implementable/Window.java @@ -469,7 +469,7 @@ public abstract class Window implements AutoCloseable { } /** - * Creates a new window. + * Initializes this abstract class. * * @param name name * @param title title diff --git a/windowing/src/main/java/de/staropensource/engine/windowing/implementable/api/ApiClass.java b/windowing/src/main/java/de/staropensource/engine/windowing/implementable/api/ApiClass.java index 2435f218..4d472301 100644 --- a/windowing/src/main/java/de/staropensource/engine/windowing/implementable/api/ApiClass.java +++ b/windowing/src/main/java/de/staropensource/engine/windowing/implementable/api/ApiClass.java @@ -24,13 +24,13 @@ import de.staropensource.engine.base.implementable.SubsystemClass; import org.jetbrains.annotations.NotNull; /** - * The interface for windowing API main classes. + * Abstract class for building windowing API main classes. * * @since v1-alpha0 */ public abstract class ApiClass extends SubsystemClass { /** - * Constructs this class. + * Initializes this abstract class. * * @since v1-alpha2 */ diff --git a/windowing/src/main/java/de/staropensource/engine/windowing/implementable/api/ApiInternalClass.java b/windowing/src/main/java/de/staropensource/engine/windowing/implementable/api/ApiInternalClass.java index 8a088416..622cfd5d 100644 --- a/windowing/src/main/java/de/staropensource/engine/windowing/implementable/api/ApiInternalClass.java +++ b/windowing/src/main/java/de/staropensource/engine/windowing/implementable/api/ApiInternalClass.java @@ -27,7 +27,9 @@ import org.jetbrains.annotations.NotNull; import java.util.LinkedHashSet; /** - * The interface for internal API access, used by the windowing subsystem. + * Interface for internal API access classes. + * These are used exclusively by the windowing + * subsystem's code. * * @since v1-alpha2 */ diff --git a/windowing/src/main/java/de/staropensource/engine/windowing/implementable/api/ApiManagementClass.java b/windowing/src/main/java/de/staropensource/engine/windowing/implementable/api/ApiManagementClass.java index 4a068178..ebcee2c4 100644 --- a/windowing/src/main/java/de/staropensource/engine/windowing/implementable/api/ApiManagementClass.java +++ b/windowing/src/main/java/de/staropensource/engine/windowing/implementable/api/ApiManagementClass.java @@ -34,7 +34,8 @@ import java.util.LinkedList; import java.util.concurrent.atomic.AtomicReference; /** - * The interface for windowing API management classes. + * Interface for building windowing API management classes. + * These are used for interfacing with the windowing API directly. * * @since v1-alpha0 */ @@ -54,7 +55,7 @@ public abstract class ApiManagementClass { private final @NotNull LoggerInstance logger = new LoggerInstance.Builder().setClazz(getClass()).setOrigin("ENGINE").build(); /** - * Constructs this class. + * Initializes this abstract class. * * @since v1-alpha2 */