Update Javadoc and class constructors

This commit is contained in:
JeremyStar™ 2024-09-28 21:45:09 +02:00
parent 46b52173fd
commit 0075b465cd
Signed by: JeremyStarTM
GPG key ID: E366BAEF67E4704D
166 changed files with 293 additions and 281 deletions

View file

@ -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
*/

View file

@ -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

View file

@ -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
*/

View file

@ -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();

View file

@ -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();

View file

@ -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;

View file

@ -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
*/

View file

@ -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
*/

View file

@ -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
*/

View file

@ -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
*/

View file

@ -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
*/

View file

@ -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

View file

@ -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

View file

@ -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
*/

View file

@ -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
*/

View file

@ -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

View file

@ -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

View file

@ -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

View file

@ -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

View file

@ -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

View file

@ -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

View file

@ -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

View file

@ -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

View file

@ -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

View file

@ -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

View file

@ -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}

View file

@ -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();

View file

@ -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.

View file

@ -72,14 +72,14 @@ public abstract class ShortcodeParser {
protected final @NotNull LinkedList<String> 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);
}

View file

@ -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.
*

View file

@ -68,7 +68,7 @@ public final class EventHelper {
private static final @NotNull Map<@NotNull Class<? extends Event>, LinkedList<@NotNull EventListenerCode>> cachedEventListeners = new HashMap<>();
/**
* Constructs this class.
* Creates and initializes an instance of this class.
*
* @since v1-alpha0
*/

View file

@ -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
*/

View file

@ -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
*/

View file

@ -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
*/

View file

@ -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

View file

@ -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

View file

@ -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

View file

@ -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

View file

@ -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

View file

@ -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

View file

@ -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

View file

@ -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
*/

View file

@ -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

View file

@ -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
*/

View file

@ -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
*/

View file

@ -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
*/

View file

@ -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
*/

View file

@ -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
*/

View file

@ -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
*/

View file

@ -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
*/

View file

@ -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
*/

View file

@ -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
*/

View file

@ -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
*/

View file

@ -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
*/

View file

@ -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
*/

View file

@ -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
*/

View file

@ -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
*/

View file

@ -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
*/

View file

@ -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
*/

View file

@ -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
*/

View file

@ -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
*/

View file

@ -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
*/

View file

@ -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
*/

View file

@ -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
*/

View file

@ -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
*/

View file

@ -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
*/

View file

@ -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
*/

View file

@ -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
*/

View file

@ -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
*/

View file

@ -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
*/

View file

@ -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
*/

View file

@ -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
*/

View file

@ -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
*/

View file

@ -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
*/

View file

@ -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
*/

View file

@ -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
*/

View file

@ -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
*/

View file

@ -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
*/

View file

@ -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
*/

View file

@ -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
*/

View file

@ -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

View file

@ -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

View file

@ -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

View file

@ -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

View file

@ -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

View file

@ -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

View file

@ -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

View file

@ -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
*/

View file

@ -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

View file

@ -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

View file

@ -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

View file

@ -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

View file

@ -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

View file

@ -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

View file

@ -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

View file

@ -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}.

View file

@ -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

View file

@ -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

View file

@ -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.

View file

@ -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", ""));

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