Update and extend JavaDoc for almost all classes

This commit is contained in:
JeremyStar™ 2024-07-07 12:52:36 +02:00
parent 9add9330bb
commit 8ee805b2db
Signed by: JeremyStarTM
GPG key ID: E366BAEF67E4704D
115 changed files with 233 additions and 183 deletions

View file

@ -63,14 +63,14 @@ import java.util.Set;
@EngineSubsystem @EngineSubsystem
public final class Engine implements SubsystemMainClass { public final class Engine implements SubsystemMainClass {
/** /**
* Instance. * Contains the class instance.
* *
* @since 1-alpha0 * @since 1-alpha0
* *
* -- GETTER -- * -- GETTER --
* Returns the {@link Engine} instance. * Returns the class instance.
* *
* @return {@link Engine} instance unless uninitialized * @return class instance unless the engine is uninitialized
* @since 1-alpha0 * @since 1-alpha0
*/ */
@Getter @Getter

View file

@ -22,9 +22,11 @@ package de.staropensource.sosengine.base;
import de.staropensource.sosengine.base.classes.SubsystemConfiguration; import de.staropensource.sosengine.base.classes.SubsystemConfiguration;
import de.staropensource.sosengine.base.classes.logging.LogIssuer; import de.staropensource.sosengine.base.classes.logging.LogIssuer;
import de.staropensource.sosengine.base.classes.logging.LogLevel; import de.staropensource.sosengine.base.classes.logging.LogLevel;
import de.staropensource.sosengine.base.logging.CrashHandler;
import de.staropensource.sosengine.base.logging.Logger; import de.staropensource.sosengine.base.logging.Logger;
import de.staropensource.sosengine.base.types.CodePart; import de.staropensource.sosengine.base.types.CodePart;
import de.staropensource.sosengine.base.utility.PropertyParser; import de.staropensource.sosengine.base.utility.PropertyParser;
import de.staropensource.sosengine.base.utility.ShortcodeConverter;
import lombok.Getter; import lombok.Getter;
import org.jetbrains.annotations.NotNull; import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable; import org.jetbrains.annotations.Nullable;
@ -32,7 +34,17 @@ import org.jetbrains.annotations.Nullable;
import java.util.Properties; import java.util.Properties;
/** /**
* Provides the engine configuration for all classes in a centralized place. * Provides the base engine configuration.
* <p>
* This class does not only provide engine settings but is also
* responsible for loading them into memory from {@link Properties} objects.
* <p>
* Now you might ask why we didn't go with the string-based approach.
* The answer is simple: It's a maintenance and documentation burden.
* Having various settings strings scattered across many classes will cause
* trouble at some point, which will cause some strings to be undocumented
* or have an inconsistent naming scheme. Containing settings as variables in
* one centralized place mitigates this.
* *
* @since 1-alpha0 * @since 1-alpha0
*/ */
@ -40,14 +52,14 @@ import java.util.Properties;
@Getter @Getter
public final class EngineConfiguration implements SubsystemConfiguration { public final class EngineConfiguration implements SubsystemConfiguration {
/** /**
* Instance. * Contains the class instance.
* *
* @since 1-alpha0 * @since 1-alpha0
* *
* -- GETTER -- * -- GETTER --
* Returns the {@link EngineConfiguration} instance. * Returns the class instance.
* *
* @return {@link EngineConfiguration} instance unless {@link Engine} is uninitialized * @return class instance unless {@link Engine} is uninitialized
* @since 1-alpha0 * @since 1-alpha0
*/ */
@Getter @Getter
@ -99,10 +111,10 @@ public final class EngineConfiguration implements SubsystemConfiguration {
private boolean debugEvents; private boolean debugEvents;
/** /**
* If enabled, very verbose messages about the {@link de.staropensource.sosengine.base.utility.ShortcodeConverter}'s internals will be printed.<br/> * If enabled, very verbose messages about the {@link ShortcodeConverter}'s internals will be printed.<br/>
* Don't enable unless you have knowledge about the {@link de.staropensource.sosengine.base.utility.ShortcodeConverter} and want to work on it. * Don't enable unless you want to work on it.
* *
* @see de.staropensource.sosengine.base.utility.ShortcodeConverter * @see ShortcodeConverter
* @since 1-alpha0 * @since 1-alpha0
* *
* -- GETTER -- * -- GETTER --
@ -115,10 +127,11 @@ public final class EngineConfiguration implements SubsystemConfiguration {
private boolean debugShortcodeConverter; private boolean debugShortcodeConverter;
/** /**
* If enabled, invalid shortcodes will be logged in {@link de.staropensource.sosengine.base.utility.ShortcodeConverter}. * If enabled, invalid shortcodes will be logged by the {@link ShortcodeConverter}.
* The message will be printed as a silent warning. * The message will be printed as a silent warning.
* *
* @see de.staropensource.sosengine.base.utility.ShortcodeConverter * @see ShortcodeConverter
* @see EngineConfiguration#loggerLevel
* @since 1-alpha0 * @since 1-alpha0
* *
* -- GETTER -- * -- GETTER --
@ -131,7 +144,7 @@ public final class EngineConfiguration implements SubsystemConfiguration {
private boolean errorShortcodeConverter; private boolean errorShortcodeConverter;
/** /**
* Determines which logger levels are allowed. * Determines which logger levels are allowed by setting the minimum logger level.
* *
* @see Logger * @see Logger
* @since 1-alpha0 * @since 1-alpha0
@ -146,7 +159,7 @@ public final class EngineConfiguration implements SubsystemConfiguration {
private LogLevel loggerLevel; private LogLevel loggerLevel;
/** /**
* Contains the logging template. * Contains the logging template used for creating log messages.
* *
* @see Logger * @see Logger
* @see de.staropensource.sosengine.base.data.placeholder Global placeholder list * @see de.staropensource.sosengine.base.data.placeholder Global placeholder list
@ -163,10 +176,10 @@ public final class EngineConfiguration implements SubsystemConfiguration {
private String loggerTemplate; private String loggerTemplate;
/** /**
* If enabled, the JVM will immediately shutdown. This will prevent shutdown hooks from executing.<br/> * If enabled, the JVM will immediately shutdown on an engine crash. This will prevent shutdown hooks from executing.<br/>
* Note: This will also prevent Jansi from removing temporary native libraries at shutdown. * Note: This will also prevent Jansi and potentially other libraries from removing temporary native libraries at shutdown.
* *
* @see de.staropensource.sosengine.base.logging.CrashHandler * @see CrashHandler
* @since 1-alpha0 * @since 1-alpha0
* *
* -- GETTER -- * -- GETTER --
@ -179,7 +192,8 @@ public final class EngineConfiguration implements SubsystemConfiguration {
private boolean loggerImmediateShutdown; private boolean loggerImmediateShutdown;
/** /**
* If enabled, will force the {@link Logger} and {@link de.staropensource.sosengine.base.logging.CrashHandler} to use the standard output. * If enabled, will force the {@link Logger} and {@link CrashHandler} to use <a href="https://www.man7.org/linux/man-pages/man3/stderr.3.html">the standard output</a>
* instead of <a href="https://www.man7.org/linux/man-pages/man3/stderr.3.html">the standard error</a> for logging {@code ERROR} and {@code CRASH}.
* *
* @since 1-alpha0 * @since 1-alpha0
* *
@ -193,7 +207,7 @@ public final class EngineConfiguration implements SubsystemConfiguration {
private boolean loggerForceStandardOutput; private boolean loggerForceStandardOutput;
/** /**
* Determines how fast the logger will poll for messages. * Determines how fast the logging thread will poll for queued messages.
* Only applies if {@code optimizeLogging} is turned on. * Only applies if {@code optimizeLogging} is turned on.
* *
* @see EngineConfiguration#optimizeLogging * @see EngineConfiguration#optimizeLogging
@ -209,10 +223,11 @@ public final class EngineConfiguration implements SubsystemConfiguration {
private int loggerPollingSpeed; private int loggerPollingSpeed;
/** /**
* If enabled, will makes the {@link Logger} work asynchronous. * If enabled, will makes the {@link Logger} work asynchronous, in a separate platform thread.
* Don't disable unless you want your application to run <b>extremely</b> slowly. * Don't disable unless you want your application to run <b>extremely</b> slowly.
* *
* @see EngineConfiguration#loggerPollingSpeed * @see EngineConfiguration#loggerPollingSpeed
* @see Thread
* @since 1-alpha0 * @since 1-alpha0
* *
* -- GETTER -- * -- GETTER --
@ -225,9 +240,10 @@ public final class EngineConfiguration implements SubsystemConfiguration {
private boolean optimizeLogging; private boolean optimizeLogging;
/** /**
* If enabled, will make all events asynchronous. * If enabled, will make all events asynchronous, in separate virtual threads.
* Don't disable unless you want your application to run slowly. * Don't disable unless you want your application to run slower.
* *
* @see VirtualThread
* @since 1-alpha0 * @since 1-alpha0
* *
* -- GETTER -- * -- GETTER --
@ -240,7 +256,7 @@ public final class EngineConfiguration implements SubsystemConfiguration {
private boolean optimizeEvents; private boolean optimizeEvents;
/** /**
* Constructor. * Constructs this class.
* *
* @see Engine * @see Engine
* @since 1-alpha0 * @since 1-alpha0

View file

@ -31,7 +31,7 @@ import java.util.Properties;
@SuppressWarnings({ "unused" }) @SuppressWarnings({ "unused" })
public interface SubsystemConfiguration { public interface SubsystemConfiguration {
/** /**
* Instance. * Contains the class instance.
* *
* @since 1-alpha0 * @since 1-alpha0
*/ */

View file

@ -22,8 +22,8 @@ package de.staropensource.sosengine.base.classes.helpers;
import de.staropensource.sosengine.base.EngineConfiguration; import de.staropensource.sosengine.base.EngineConfiguration;
import de.staropensource.sosengine.base.annotations.EventListener; import de.staropensource.sosengine.base.annotations.EventListener;
import de.staropensource.sosengine.base.classes.events.Event; import de.staropensource.sosengine.base.classes.events.Event;
import de.staropensource.sosengine.base.logging.Logger;
import de.staropensource.sosengine.base.classes.logging.LogIssuer; import de.staropensource.sosengine.base.classes.logging.LogIssuer;
import de.staropensource.sosengine.base.logging.Logger;
import de.staropensource.sosengine.base.utility.ListFormatter; import de.staropensource.sosengine.base.utility.ListFormatter;
import lombok.Getter; import lombok.Getter;
import org.jetbrains.annotations.NotNull; import org.jetbrains.annotations.NotNull;
@ -35,7 +35,10 @@ import org.reflections.util.ConfigurationBuilder;
import java.lang.reflect.InvocationTargetException; import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method; import java.lang.reflect.Method;
import java.util.*; import java.util.Comparator;
import java.util.HashMap;
import java.util.LinkedList;
import java.util.Set;
/** /**
* Represents an event. * Represents an event.
@ -53,7 +56,7 @@ public class EventHelper {
private static final HashMap<@NotNull Class<? extends Event>, LinkedList<@NotNull Method>> cachedEventListeners = new HashMap<>(); private static final HashMap<@NotNull Class<? extends Event>, LinkedList<@NotNull Method>> cachedEventListeners = new HashMap<>();
/** /**
* Constructor. * Constructs this class.
*/ */
public EventHelper() {} public EventHelper() {}

View file

@ -73,7 +73,7 @@ public class LogIssuer {
private final CodePart codePart; private final CodePart codePart;
/** /**
* Constructor. * Creates a new log issuer.
* *
* @param clazz issuing class * @param clazz issuing class
* @param additionalInformation additional information about the issuer * @param additionalInformation additional information about the issuer
@ -88,7 +88,7 @@ public class LogIssuer {
} }
/** /**
* Constructor. * Creates a new log issuer.
* *
* @param clazz issuing class * @param clazz issuing class
* @param additionalInformation additional information about the issuer * @param additionalInformation additional information about the issuer
@ -102,7 +102,7 @@ public class LogIssuer {
} }
/** /**
* Constructor. * Creates a new log issuer.
* *
* @param clazz issuing class * @param clazz issuing class
* @param codePart identifies to which part of the program the class belongs to * @param codePart identifies to which part of the program the class belongs to
@ -115,7 +115,7 @@ public class LogIssuer {
} }
/** /**
* Constructor. * Creates a new log issuer.
* *
* @param clazz issuing class * @param clazz issuing class
* @since 1-alpha0 * @since 1-alpha0

View file

@ -47,7 +47,7 @@ public class LogRule {
private final LogRuleType type; private final LogRuleType type;
/** /**
* Constructor. * Creates a new log rule.
* *
* @param type rule type * @param type rule type
*/ */

View file

@ -45,14 +45,14 @@ import java.util.Properties;
@Getter @Getter
public final class EngineInformation { public final class EngineInformation {
/** /**
* Instance. * Contains the class instance.
* *
* @since 1-alpha0 * @since 1-alpha0
* *
* -- GETTER -- * -- GETTER --
* Returns the {@link EngineInformation} instance. * Returns the class instance.
* *
* @return {@link EngineInformation} instance * @return class instance unless {@link Engine} is uninitialized
* @since 1-alpha0 * @since 1-alpha0
*/ */
@Getter @Getter
@ -349,7 +349,7 @@ public final class EngineInformation {
private String pluginLombok; private String pluginLombok;
/** /**
* Constructor. * Constructs this class.
* *
* @since 1-alpha0 * @since 1-alpha0
*/ */

View file

@ -19,9 +19,9 @@
package de.staropensource.sosengine.base.data.info; package de.staropensource.sosengine.base.data.info;
import de.staropensource.sosengine.base.classes.logging.LogIssuer;
import de.staropensource.sosengine.base.logging.Logger; import de.staropensource.sosengine.base.logging.Logger;
import de.staropensource.sosengine.base.types.CodePart; import de.staropensource.sosengine.base.types.CodePart;
import de.staropensource.sosengine.base.classes.logging.LogIssuer;
import org.jetbrains.annotations.NotNull; import org.jetbrains.annotations.NotNull;
import java.lang.management.ManagementFactory; import java.lang.management.ManagementFactory;
@ -33,7 +33,7 @@ import java.util.List;
@SuppressWarnings({ "unused" }) @SuppressWarnings({ "unused" })
public final class JvmInformation { public final class JvmInformation {
/** /**
* Constructor. * Constructs this class.
* *
* @since 1-alpha0 * @since 1-alpha0
*/ */

View file

@ -34,7 +34,7 @@ import java.util.Calendar;
@SuppressWarnings({ "unused" }) @SuppressWarnings({ "unused" })
public final class DateDay implements Placeholder { public final class DateDay implements Placeholder {
/** /**
* Constructor. * Constructs this class.
* *
* @since 1-alpha0 * @since 1-alpha0
*/ */

View file

@ -34,7 +34,7 @@ import java.util.Calendar;
@SuppressWarnings({ "unused" }) @SuppressWarnings({ "unused" })
public final class DateMonth implements Placeholder { public final class DateMonth implements Placeholder {
/** /**
* Constructor. * Constructs this class.
* *
* @since 1-alpha0 * @since 1-alpha0
*/ */

View file

@ -34,7 +34,7 @@ import java.util.Calendar;
@SuppressWarnings({ "unused" }) @SuppressWarnings({ "unused" })
public final class DateYear implements Placeholder { public final class DateYear implements Placeholder {
/** /**
* Constructor. * Constructs this class.
* *
* @since 1-alpha0 * @since 1-alpha0
*/ */

View file

@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull;
@SuppressWarnings({ "unused" }) @SuppressWarnings({ "unused" })
public final class EngineDependencyJansi implements Placeholder { public final class EngineDependencyJansi implements Placeholder {
/** /**
* Constructor. * Constructs this class.
* *
* @since 1-alpha0 * @since 1-alpha0
*/ */

View file

@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull;
@SuppressWarnings({ "unused" }) @SuppressWarnings({ "unused" })
public final class EngineDependencyJetbrainsAnnotations implements Placeholder { public final class EngineDependencyJetbrainsAnnotations implements Placeholder {
/** /**
* Constructor. * Constructs this class.
* *
* @since 1-alpha0 * @since 1-alpha0
*/ */

View file

@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull;
@SuppressWarnings({ "unused" }) @SuppressWarnings({ "unused" })
public final class EngineDependencyLombok implements Placeholder { public final class EngineDependencyLombok implements Placeholder {
/** /**
* Constructor. * Constructs this class.
* *
* @since 1-alpha0 * @since 1-alpha0
*/ */

View file

@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull;
@SuppressWarnings({ "unused" }) @SuppressWarnings({ "unused" })
public final class EngineDependencyLwjgl implements Placeholder { public final class EngineDependencyLwjgl implements Placeholder {
/** /**
* Constructor. * Constructs this class.
* *
* @since 1-alpha0 * @since 1-alpha0
*/ */

View file

@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull;
@SuppressWarnings({ "unused" }) @SuppressWarnings({ "unused" })
public final class EngineDependencyReflections implements Placeholder { public final class EngineDependencyReflections implements Placeholder {
/** /**
* Constructor. * Constructs this class.
* *
* @since 1-alpha0 * @since 1-alpha0
*/ */

View file

@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull;
@SuppressWarnings({ "unused" }) @SuppressWarnings({ "unused" })
public final class EngineDependencySlf4j implements Placeholder { public final class EngineDependencySlf4j implements Placeholder {
/** /**
* Constructor. * Constructs this class.
* *
* @since 1-alpha0 * @since 1-alpha0
*/ */

View file

@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull;
@SuppressWarnings({ "unused" }) @SuppressWarnings({ "unused" })
public final class EngineGitBranch implements Placeholder { public final class EngineGitBranch implements Placeholder {
/** /**
* Constructor. * Constructs this class.
* *
* @since 1-alpha0 * @since 1-alpha0
*/ */

View file

@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull;
@SuppressWarnings({ "unused" }) @SuppressWarnings({ "unused" })
public final class EngineGitCommitHeader implements Placeholder { public final class EngineGitCommitHeader implements Placeholder {
/** /**
* Constructor. * Constructs this class.
* *
* @since 1-alpha0 * @since 1-alpha0
*/ */

View file

@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull;
@SuppressWarnings({ "unused" }) @SuppressWarnings({ "unused" })
public final class EngineGitCommitIdLong implements Placeholder { public final class EngineGitCommitIdLong implements Placeholder {
/** /**
* Constructor. * Constructs this class.
* *
* @since 1-alpha0 * @since 1-alpha0
*/ */

View file

@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull;
@SuppressWarnings({ "unused" }) @SuppressWarnings({ "unused" })
public final class EngineGitCommitIdShort implements Placeholder { public final class EngineGitCommitIdShort implements Placeholder {
/** /**
* Constructor. * Constructs this class.
* *
* @since 1-alpha0 * @since 1-alpha0
*/ */

View file

@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull;
@SuppressWarnings({ "unused" }) @SuppressWarnings({ "unused" })
public final class EngineGitCommitTimeDay implements Placeholder { public final class EngineGitCommitTimeDay implements Placeholder {
/** /**
* Constructor. * Constructs this class.
* *
* @since 1-alpha0 * @since 1-alpha0
*/ */

View file

@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull;
@SuppressWarnings({ "unused" }) @SuppressWarnings({ "unused" })
public final class EngineGitCommitTimeHour implements Placeholder { public final class EngineGitCommitTimeHour implements Placeholder {
/** /**
* Constructor. * Constructs this class.
* *
* @since 1-alpha0 * @since 1-alpha0
*/ */

View file

@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull;
@SuppressWarnings({ "unused" }) @SuppressWarnings({ "unused" })
public final class EngineGitCommitTimeMinute implements Placeholder { public final class EngineGitCommitTimeMinute implements Placeholder {
/** /**
* Constructor. * Constructs this class.
* *
* @since 1-alpha0 * @since 1-alpha0
*/ */

View file

@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull;
@SuppressWarnings({ "unused" }) @SuppressWarnings({ "unused" })
public final class EngineGitCommitTimeMonth implements Placeholder { public final class EngineGitCommitTimeMonth implements Placeholder {
/** /**
* Constructor. * Constructs this class.
* *
* @since 1-alpha0 * @since 1-alpha0
*/ */

View file

@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull;
@SuppressWarnings({ "unused" }) @SuppressWarnings({ "unused" })
public final class EngineGitCommitTimeSecond implements Placeholder { public final class EngineGitCommitTimeSecond implements Placeholder {
/** /**
* Constructor. * Constructs this class.
* *
* @since 1-alpha0 * @since 1-alpha0
*/ */

View file

@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull;
@SuppressWarnings({ "unused" }) @SuppressWarnings({ "unused" })
public final class EngineGitCommitTimeYear implements Placeholder { public final class EngineGitCommitTimeYear implements Placeholder {
/** /**
* Constructor. * Constructs this class.
* *
* @since 1-alpha0 * @since 1-alpha0
*/ */

View file

@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull;
@SuppressWarnings({ "unused" }) @SuppressWarnings({ "unused" })
public final class EngineGitCommits implements Placeholder { public final class EngineGitCommits implements Placeholder {
/** /**
* Constructor. * Constructs this class.
* *
* @since 1-alpha0 * @since 1-alpha0
*/ */

View file

@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull;
@SuppressWarnings({ "unused" }) @SuppressWarnings({ "unused" })
public final class EngineGitCommitterEmail implements Placeholder { public final class EngineGitCommitterEmail implements Placeholder {
/** /**
* Constructor. * Constructs this class.
* *
* @since 1-alpha0 * @since 1-alpha0
*/ */

View file

@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull;
@SuppressWarnings({ "unused" }) @SuppressWarnings({ "unused" })
public final class EngineGitCommitterName implements Placeholder { public final class EngineGitCommitterName implements Placeholder {
/** /**
* Constructor. * Constructs this class.
* *
* @since 1-alpha0 * @since 1-alpha0
*/ */

View file

@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull;
@SuppressWarnings({ "unused" }) @SuppressWarnings({ "unused" })
public final class EngineGitDirty implements Placeholder { public final class EngineGitDirty implements Placeholder {
/** /**
* Constructor. * Constructs this class.
* *
* @since 1-alpha0 * @since 1-alpha0
*/ */

View file

@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull;
@SuppressWarnings({ "unused" }) @SuppressWarnings({ "unused" })
public final class EnginePluginLombok implements Placeholder { public final class EnginePluginLombok implements Placeholder {
/** /**
* Constructor. * Constructs this class.
* *
* @since 1-alpha0 * @since 1-alpha0
*/ */

View file

@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull;
@SuppressWarnings({ "unused" }) @SuppressWarnings({ "unused" })
public final class EnginePluginShadow implements Placeholder { public final class EnginePluginShadow implements Placeholder {
/** /**
* Constructor. * Constructs this class.
* *
* @since 1-alpha0 * @since 1-alpha0
*/ */

View file

@ -31,7 +31,7 @@ import org.jetbrains.annotations.NotNull;
@SuppressWarnings({ "unused" }) @SuppressWarnings({ "unused" })
public final class EngineVersion implements Placeholder { public final class EngineVersion implements Placeholder {
/** /**
* Constructor. * Constructs this class.
* *
* @since 1-alpha0 * @since 1-alpha0
*/ */

View file

@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull;
@SuppressWarnings({ "unused" }) @SuppressWarnings({ "unused" })
public final class EngineVersionFork implements Placeholder { public final class EngineVersionFork implements Placeholder {
/** /**
* Constructor. * Constructs this class.
* *
* @since 1-alpha0 * @since 1-alpha0
*/ */

View file

@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull;
@SuppressWarnings({ "unused" }) @SuppressWarnings({ "unused" })
public final class EngineVersionType implements Placeholder { public final class EngineVersionType implements Placeholder {
/** /**
* Constructor. * Constructs this class.
* *
* @since 1-alpha0 * @since 1-alpha0
*/ */

View file

@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull;
@SuppressWarnings({ "unused" }) @SuppressWarnings({ "unused" })
public final class EngineVersionTyperelease implements Placeholder { public final class EngineVersionTyperelease implements Placeholder {
/** /**
* Constructor. * Constructs this class.
* *
* @since 1-alpha0 * @since 1-alpha0
*/ */

View file

@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull;
@SuppressWarnings({ "unused" }) @SuppressWarnings({ "unused" })
public final class EngineVersionVersion implements Placeholder { public final class EngineVersionVersion implements Placeholder {
/** /**
* Constructor. * Constructs this class.
* *
* @since 1-alpha0 * @since 1-alpha0
*/ */

View file

@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull;
@SuppressWarnings({ "unused" }) @SuppressWarnings({ "unused" })
public final class JvmArguments implements Placeholder { public final class JvmArguments implements Placeholder {
/** /**
* Constructor. * Constructs this class.
* *
* @since 1-alpha0 * @since 1-alpha0
*/ */

View file

@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull;
@SuppressWarnings({ "unused" }) @SuppressWarnings({ "unused" })
public final class JvmImplementationName implements Placeholder { public final class JvmImplementationName implements Placeholder {
/** /**
* Constructor. * Constructs this class.
* *
* @since 1-alpha0 * @since 1-alpha0
*/ */

View file

@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull;
@SuppressWarnings({ "unused" }) @SuppressWarnings({ "unused" })
public final class JvmImplementationVendor implements Placeholder { public final class JvmImplementationVendor implements Placeholder {
/** /**
* Constructor. * Constructs this class.
* *
* @since 1-alpha0 * @since 1-alpha0
*/ */

View file

@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull;
@SuppressWarnings({ "unused" }) @SuppressWarnings({ "unused" })
public final class JvmImplementationVersion implements Placeholder { public final class JvmImplementationVersion implements Placeholder {
/** /**
* Constructor. * Constructs this class.
* *
* @since 1-alpha0 * @since 1-alpha0
*/ */

View file

@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull;
@SuppressWarnings({ "unused" }) @SuppressWarnings({ "unused" })
public final class JvmJava implements Placeholder { public final class JvmJava implements Placeholder {
/** /**
* Constructor. * Constructs this class.
* *
* @since 1-alpha0 * @since 1-alpha0
*/ */

View file

@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull;
@SuppressWarnings({ "unused" }) @SuppressWarnings({ "unused" })
public final class JvmUptime implements Placeholder { public final class JvmUptime implements Placeholder {
/** /**
* Constructor. * Constructs this class.
* *
* @since 1-alpha0 * @since 1-alpha0
*/ */

View file

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

View file

@ -34,7 +34,7 @@ import java.util.Calendar;
@SuppressWarnings({ "unused" }) @SuppressWarnings({ "unused" })
public final class TimeHour implements Placeholder { public final class TimeHour implements Placeholder {
/** /**
* Constructor. * Constructs this class.
* *
* @since 1-alpha0 * @since 1-alpha0
*/ */

View file

@ -34,7 +34,7 @@ import java.util.Calendar;
@SuppressWarnings({ "unused" }) @SuppressWarnings({ "unused" })
public final class TimeMinute implements Placeholder { public final class TimeMinute implements Placeholder {
/** /**
* Constructor. * Constructs this class.
* *
* @since 1-alpha0 * @since 1-alpha0
*/ */

View file

@ -34,7 +34,7 @@ import java.util.Calendar;
@SuppressWarnings({ "unused" }) @SuppressWarnings({ "unused" })
public final class TimeSecond implements Placeholder { public final class TimeSecond implements Placeholder {
/** /**
* Constructor. * Constructs this class.
* *
* @since 1-alpha0 * @since 1-alpha0
*/ */

View file

@ -33,7 +33,7 @@ import java.util.Locale;
@SuppressWarnings({ "unused" }) @SuppressWarnings({ "unused" })
public final class TimeZone implements Placeholder { public final class TimeZone implements Placeholder {
/** /**
* Constructor. * Constructs this class.
* *
* @since 1-alpha0 * @since 1-alpha0
*/ */

View file

@ -94,7 +94,7 @@ public final class FourNumberVersioningSystem implements VersioningSystem {
} }
/** /**
* Constructor. * Parses a four number-based version string.
* *
* @param versionString version string to parse * @param versionString version string to parse
* @throws InvalidVersionStringException if the version string is invalid * @throws InvalidVersionStringException if the version string is invalid

View file

@ -113,7 +113,7 @@ public final class SemanticVersioningSystem implements VersioningSystem {
} }
/** /**
* Constructor. * Parses a semantic versioning string.
* *
* @param versionString version string to parse * @param versionString version string to parse
* @throws InvalidVersionStringException if the version string is invalid * @throws InvalidVersionStringException if the version string is invalid

View file

@ -113,7 +113,7 @@ public final class StarOpenSourceVersioningSystem implements VersioningSystem {
} }
/** /**
* Constructor. * Parses a StarOpenSource versioning string.
* *
* @param versionString version string to parse * @param versionString version string to parse
* @throws InvalidVersionStringException if the version string is invalid * @throws InvalidVersionStringException if the version string is invalid

View file

@ -81,7 +81,7 @@ public final class ThreeNumberVersioningSystem implements VersioningSystem {
} }
/** /**
* Constructor. * Parses a three number-based version string.
* *
* @param versionString version string to parse * @param versionString version string to parse
* @throws InvalidVersionStringException if the version string is invalid * @throws InvalidVersionStringException if the version string is invalid

View file

@ -68,7 +68,7 @@ public final class TwoNumberVersioningSystem implements VersioningSystem {
} }
/** /**
* Constructor. * Parses a two number-based version string.
* *
* @param versionString version string to parse * @param versionString version string to parse
* @throws InvalidVersionStringException if the version string is invalid * @throws InvalidVersionStringException if the version string is invalid

View file

@ -30,7 +30,7 @@ import de.staropensource.sosengine.base.classes.helpers.EventHelper;
@SuppressWarnings({ "unused" }) @SuppressWarnings({ "unused" })
public final class EngineCrashEvent implements Event { public final class EngineCrashEvent implements Event {
/** /**
* Constructor. * Constructs this class.
*/ */
public EngineCrashEvent() {} public EngineCrashEvent() {}

View file

@ -29,7 +29,7 @@ import de.staropensource.sosengine.base.classes.helpers.EventHelper;
*/ */
public class EngineShutdownEvent implements Event { public class EngineShutdownEvent implements Event {
/** /**
* Constructor. * Constructs this class.
*/ */
public EngineShutdownEvent() {} public EngineShutdownEvent() {}

View file

@ -37,7 +37,7 @@ import java.lang.reflect.Method;
@SuppressWarnings({ "unused" }) @SuppressWarnings({ "unused" })
public final class LogEvent implements Event { public final class LogEvent implements Event {
/** /**
* Constructor. * Constructs this class.
*/ */
public LogEvent() {} public LogEvent() {}

View file

@ -36,7 +36,7 @@ import java.lang.reflect.Method;
*/ */
public class ThrowableCatchEvent implements Event { public class ThrowableCatchEvent implements Event {
/** /**
* Constructor. * Constructs this class.
*/ */
public ThrowableCatchEvent() {} public ThrowableCatchEvent() {}

View file

@ -29,7 +29,7 @@ import de.staropensource.sosengine.base.classes.helpers.EventHelper;
*/ */
public class InternalEngineShutdownEvent implements Event { public class InternalEngineShutdownEvent implements Event {
/** /**
* Constructor. * Constructs this class.
*/ */
public InternalEngineShutdownEvent() {} public InternalEngineShutdownEvent() {}

View file

@ -29,7 +29,7 @@ import org.jetbrains.annotations.NotNull;
@SuppressWarnings({ "unused" }) @SuppressWarnings({ "unused" })
public class DependencyCycleException extends Exception { public class DependencyCycleException extends Exception {
/** /**
* Constructor. * Constructs this exception.
* *
* @param path cycle path * @param path cycle path
* @since 1-alpha1 * @since 1-alpha1

View file

@ -48,7 +48,7 @@ public class InvalidVersionStringException extends Exception {
Throwable throwable; Throwable throwable;
/** /**
* Constructor. * Constructs this exception.
* *
* @param versioningSystem versioning system that is unable to parse version strings * @param versioningSystem versioning system that is unable to parse version strings
* @param versionString version string {@code a} * @param versionString version string {@code a}
@ -62,7 +62,7 @@ public class InvalidVersionStringException extends Exception {
} }
/** /**
* Constructor. * Constructs this exception.
* *
* @param versioningSystem versioning system that is unable to parse version strings * @param versioningSystem versioning system that is unable to parse version strings
* @param versionString version string {@code a} * @param versionString version string {@code a}
@ -75,7 +75,7 @@ public class InvalidVersionStringException extends Exception {
} }
/** /**
* Constructor. * Constructs this exception.
* *
* @param versioningSystem versioning system that is unable to parse version strings * @param versioningSystem versioning system that is unable to parse version strings
* @param versionString version string {@code a} * @param versionString version string {@code a}
@ -88,7 +88,7 @@ public class InvalidVersionStringException extends Exception {
} }
/** /**
* Constructor. * Constructs this exception.
* *
* @param versioningSystem versioning system that is unable to parse version strings * @param versioningSystem versioning system that is unable to parse version strings
* @param versionString version string {@code a} * @param versionString version string {@code a}

View file

@ -47,7 +47,7 @@ public class UnexpectedThrowableException extends Exception {
Throwable throwable; Throwable throwable;
/** /**
* Constructor. * Constructs this exception.
* *
* @param throwable throwable * @param throwable throwable
* @param message message * @param message message
@ -58,7 +58,7 @@ public class UnexpectedThrowableException extends Exception {
} }
/** /**
* Constructor. * Constructs this exception.
* *
* @param throwable throwable * @param throwable throwable
*/ */

View file

@ -95,7 +95,7 @@ public final class CrashHandler {
private static final LinkedHashMap<@NotNull Object, @NotNull Object> crashContent = new LinkedHashMap<>(); private static final LinkedHashMap<@NotNull Object, @NotNull Object> crashContent = new LinkedHashMap<>();
/** /**
* Constructor. * Constructs this class.
* *
* @since 1-alpha0 * @since 1-alpha0
*/ */

View file

@ -38,7 +38,7 @@ import org.jetbrains.annotations.NotNull;
@SuppressWarnings("resource") @SuppressWarnings("resource")
public class DefaultLoggerImpl implements LoggerImpl { public class DefaultLoggerImpl implements LoggerImpl {
/** /**
* Constructor. * Constructs this class.
* *
* @since 1-alpha0 * @since 1-alpha0
*/ */

View file

@ -111,7 +111,7 @@ public final class Logger {
private static final List<LogRule> activeRules = new ArrayList<>(); private static final List<LogRule> activeRules = new ArrayList<>();
/** /**
* Constructor. * Constructs this class.
* *
* @since 1-alpha0 * @since 1-alpha0
*/ */

View file

@ -46,7 +46,7 @@ public final class LoggerInstance {
private final LogIssuer logIssuer; private final LogIssuer logIssuer;
/** /**
* Constructor. * Creates a logger instance.
* *
* @param logIssuer information about the parent class * @param logIssuer information about the parent class
* @since 1-alpha0 * @since 1-alpha0

View file

@ -75,7 +75,7 @@ public class QueuedLogMessage {
private final String message; private final String message;
/** /**
* Constructor. * Creates a new queued log message.
* *
* @param issuer log message issuer * @param issuer log message issuer
* @param level log message level * @param level log message level

View file

@ -40,7 +40,7 @@ public final class IssuerClass implements Placeholder {
private final LogIssuer logIssuer; private final LogIssuer logIssuer;
/** /**
* Constructor. * Constructs this class.
* *
* @param logIssuer {@link LogIssuer} to use * @param logIssuer {@link LogIssuer} to use
* @since 1-alpha0 * @since 1-alpha0

View file

@ -40,7 +40,7 @@ public final class IssuerCodePart implements Placeholder {
private final LogIssuer logIssuer; private final LogIssuer logIssuer;
/** /**
* Constructor. * Constructs this class.
* *
* @param logIssuer {@link LogIssuer} to use * @param logIssuer {@link LogIssuer} to use
* @since 1-alpha0 * @since 1-alpha0

View file

@ -40,7 +40,7 @@ public final class IssuerInfo implements Placeholder {
private final LogIssuer logIssuer; private final LogIssuer logIssuer;
/** /**
* Constructor. * Constructs this class.
* *
* @param logIssuer {@link LogIssuer} to use * @param logIssuer {@link LogIssuer} to use
* @since 1-alpha0 * @since 1-alpha0

View file

@ -39,7 +39,7 @@ public final class IssuerMessage implements Placeholder {
private final String message; private final String message;
/** /**
* Constructor. * Constructs this class.
* *
* @param message message to use * @param message message to use
* @since 1-alpha0 * @since 1-alpha0

View file

@ -40,7 +40,7 @@ public final class IssuerPackage implements Placeholder {
private final LogIssuer logIssuer; private final LogIssuer logIssuer;
/** /**
* Constructor. * Constructs this class.
* *
* @param logIssuer {@link LogIssuer} to use * @param logIssuer {@link LogIssuer} to use
* @since 1-alpha0 * @since 1-alpha0

View file

@ -40,7 +40,7 @@ public final class IssuerPath implements Placeholder {
private final LogIssuer logIssuer; private final LogIssuer logIssuer;
/** /**
* Constructor. * Constructs this class.
* *
* @param logIssuer {@link LogIssuer} to use * @param logIssuer {@link LogIssuer} to use
* @since 1-alpha0 * @since 1-alpha0

View file

@ -41,7 +41,7 @@ public final class Stacktrace implements Placeholder {
private final Throwable throwable; private final Throwable throwable;
/** /**
* Constructor. * Constructs this class.
* *
* @param throwable {@link Throwable} to use * @param throwable {@link Throwable} to use
* @since 1-alpha0 * @since 1-alpha0

View file

@ -40,7 +40,7 @@ public final class LogClass implements Placeholder {
private final LogIssuer logIssuer; private final LogIssuer logIssuer;
/** /**
* Constructor. * Constructs this class.
* *
* @param logIssuer {@link LogIssuer} to use * @param logIssuer {@link LogIssuer} to use
* @since 1-alpha0 * @since 1-alpha0

View file

@ -40,7 +40,7 @@ public final class LogCodePart implements Placeholder {
private final LogIssuer logIssuer; private final LogIssuer logIssuer;
/** /**
* Constructor. * Constructs this class.
* *
* @param logIssuer {@link LogIssuer} to use * @param logIssuer {@link LogIssuer} to use
* @since 1-alpha0 * @since 1-alpha0

View file

@ -40,7 +40,7 @@ public final class LogColorPrimary implements Placeholder {
private final LogLevel level; private final LogLevel level;
/** /**
* Constructor. * Constructs this class.
* *
* @param level {@link LogLevel} to use * @param level {@link LogLevel} to use
* @since 1-alpha0 * @since 1-alpha0

View file

@ -40,7 +40,7 @@ public final class LogColorSecondary implements Placeholder {
private final LogLevel level; private final LogLevel level;
/** /**
* Constructor. * Constructs this class.
* *
* @param level {@link LogLevel} to use * @param level {@link LogLevel} to use
* @since 1-alpha0 * @since 1-alpha0

View file

@ -40,7 +40,7 @@ public final class LogInfo implements Placeholder {
private final LogIssuer logIssuer; private final LogIssuer logIssuer;
/** /**
* Constructor. * Constructs this class.
* *
* @param logIssuer {@link LogIssuer} to use * @param logIssuer {@link LogIssuer} to use
* @since 1-alpha0 * @since 1-alpha0

View file

@ -39,7 +39,7 @@ public final class LogLevel implements Placeholder {
private final de.staropensource.sosengine.base.classes.logging.LogLevel level; private final de.staropensource.sosengine.base.classes.logging.LogLevel level;
/** /**
* Constructor. * Constructs this class.
* *
* @param level {@link de.staropensource.sosengine.base.classes.logging.LogLevel} to use * @param level {@link de.staropensource.sosengine.base.classes.logging.LogLevel} to use
* @since 1-alpha0 * @since 1-alpha0

View file

@ -39,7 +39,7 @@ public final class LogMessage implements Placeholder {
private final String message; private final String message;
/** /**
* Constructor. * Constructs this class.
* *
* @param message message to use * @param message message to use
* @since 1-alpha0 * @since 1-alpha0

View file

@ -40,7 +40,7 @@ public final class LogPackage implements Placeholder {
private final LogIssuer logIssuer; private final LogIssuer logIssuer;
/** /**
* Constructor. * Constructs this class.
* *
* @param logIssuer {@link LogIssuer} to use * @param logIssuer {@link LogIssuer} to use
* @since 1-alpha0 * @since 1-alpha0

View file

@ -40,7 +40,7 @@ public final class LogPath implements Placeholder {
private final LogIssuer logIssuer; private final LogIssuer logIssuer;
/** /**
* Constructor. * Constructs this class.
* *
* @param logIssuer {@link LogIssuer} to use * @param logIssuer {@link LogIssuer} to use
* @since 1-alpha0 * @since 1-alpha0

View file

@ -90,7 +90,7 @@ public class DependencyVector {
private final List<@NotNull String> dependencies; private final List<@NotNull String> dependencies;
/** /**
* Constructor. * Creates a new dependency vector.
* *
* @param identifier identifier * @param identifier identifier
* @param versioningSystem versioning system to use * @param versioningSystem versioning system to use
@ -105,7 +105,7 @@ public class DependencyVector {
} }
/** /**
* Constructor. * Creates a new dependency vector.
* *
* @param identifier identifier * @param identifier identifier
* @param versioningSystem versioning system to use * @param versioningSystem versioning system to use

View file

@ -35,14 +35,14 @@ import java.util.function.BiFunction;
@SuppressWarnings({ "unused" }) @SuppressWarnings({ "unused" })
public class ImmutableMap<K, V> extends HashMap<K, V> { public class ImmutableMap<K, V> extends HashMap<K, V> {
/** /**
* Constructor. * Creates a new immutable map.
* *
* @since 1-alpha1 * @since 1-alpha1
*/ */
public ImmutableMap() {} public ImmutableMap() {}
/** /**
* Converts some {@link Map} into a {@link ImmutableMap}. * Converts a {@link Map} into a {@link ImmutableMap}.
* *
* @param map {@link Map} to convert * @param map {@link Map} to convert
* @since 1-alpha1 * @since 1-alpha1

View file

@ -70,7 +70,7 @@ public class Vec2 {
private float y; private float y;
/** /**
* Constructor. * Creates a new 2D vector.
* *
* @param x X axis value * @param x X axis value
* @param y Y axis value * @param y Y axis value

View file

@ -70,7 +70,7 @@ public class Vec2i {
private int y; private int y;
/** /**
* Constructor. * Creates a new 2D integer vector.
* *
* @param x X axis value * @param x X axis value
* @param y Y axis value * @param y Y axis value

View file

@ -89,7 +89,7 @@ public class Vec3 {
private float z; private float z;
/** /**
* Constructor. * Constructs this 3D vector.
* *
* @param x X axis value * @param x X axis value
* @param y Y axis value * @param y Y axis value

View file

@ -89,7 +89,7 @@ public class Vec3i {
private int z; private int z;
/** /**
* Constructor. * Constructs this 3D integer vector.
* *
* @param x X axis value * @param x X axis value
* @param y Y axis value * @param y Y axis value

View file

@ -45,7 +45,7 @@ public class DependencyResolver {
List<DependencyVector> vectors = new ArrayList<>(); List<DependencyVector> vectors = new ArrayList<>();
/** /**
* Constructor. * Constructs this class.
*/ */
public DependencyResolver() {} public DependencyResolver() {}

View file

@ -35,7 +35,7 @@ import java.util.Set;
@SuppressWarnings({ "unused" }) @SuppressWarnings({ "unused" })
public class ListFormatter { public class ListFormatter {
/** /**
* Constructor. * Constructs this class.
*/ */
public ListFormatter() {} public ListFormatter() {}

View file

@ -38,7 +38,7 @@ import java.util.stream.Collectors;
@SuppressWarnings({ "unused" }) @SuppressWarnings({ "unused" })
public final class Miscellaneous { public final class Miscellaneous {
/** /**
* Constructor. * Constructs this class.
* *
* @since 1-alpha0 * @since 1-alpha0
*/ */

View file

@ -19,6 +19,7 @@
package de.staropensource.sosengine.base.utility; package de.staropensource.sosengine.base.utility;
import de.staropensource.sosengine.base.Engine;
import de.staropensource.sosengine.base.classes.Placeholder; import de.staropensource.sosengine.base.classes.Placeholder;
import de.staropensource.sosengine.base.classes.logging.LogIssuer; import de.staropensource.sosengine.base.classes.logging.LogIssuer;
import de.staropensource.sosengine.base.data.placeholder.*; import de.staropensource.sosengine.base.data.placeholder.*;
@ -39,14 +40,14 @@ import java.util.List;
@SuppressWarnings({ "unused", "JavadocDeclaration", "JavadocBlankLines" }) @SuppressWarnings({ "unused", "JavadocDeclaration", "JavadocBlankLines" })
public final class PlaceholderEngine { public final class PlaceholderEngine {
/** /**
* Instance. * Contains the class instance.
* *
* @since 1-alpha0 * @since 1-alpha0
* *
* -- GETTER -- * -- GETTER --
* Returns the {@link PlaceholderEngine} instance. * Returns the class instance.
* *
* @return {@link PlaceholderEngine} instance * @return class instance unless {@link Engine} is uninitialized
* @since 1-alpha0 * @since 1-alpha0
*/ */
@Getter @Getter
@ -69,7 +70,7 @@ public final class PlaceholderEngine {
private List<@NotNull Placeholder> placeholders = new ArrayList<>(); private List<@NotNull Placeholder> placeholders = new ArrayList<>();
/** /**
* Constructor. * Constructs this class.
* *
* @since 1-alpha0 * @since 1-alpha0
*/ */

View file

@ -19,10 +19,10 @@
package de.staropensource.sosengine.base.utility; package de.staropensource.sosengine.base.utility;
import de.staropensource.sosengine.base.types.Tristate; import de.staropensource.sosengine.base.classes.logging.LogIssuer;
import de.staropensource.sosengine.base.logging.LoggerInstance; import de.staropensource.sosengine.base.logging.LoggerInstance;
import de.staropensource.sosengine.base.types.CodePart; import de.staropensource.sosengine.base.types.CodePart;
import de.staropensource.sosengine.base.classes.logging.LogIssuer; import de.staropensource.sosengine.base.types.Tristate;
import lombok.Getter; import lombok.Getter;
import org.jetbrains.annotations.NotNull; import org.jetbrains.annotations.NotNull;
@ -38,15 +38,15 @@ import java.util.Properties;
@NotNull @NotNull
public class PropertyParser { public class PropertyParser {
/** /**
* Instance providing access to the JVM-wide properties. * Contains an instance providing access to the JVM-wide properties.
* *
* @see System#getProperties() * @see System#getProperties()
* @since 1-alpha0 * @since 1-alpha0
* *
* -- GETTER -- * -- GETTER --
* Returns a {@link Properties} instance providing access to the JVM-wide properties. * Returns an instance providing access to the JVM-wide properties.
* *
* @return {@link Properties} using the JVM-wide properties * @return instance using the JVM-wide properties
* @see System#getProperties() * @see System#getProperties()
* @since 1-alpha0 * @since 1-alpha0
*/ */
@ -80,7 +80,7 @@ public class PropertyParser {
private final LoggerInstance logger; private final LoggerInstance logger;
/** /**
* Constructor. * Creates a new {@link Properties} parser.
* *
* @param properties {@link Properties} to use * @param properties {@link Properties} to use
* @since 1-alpha0 * @since 1-alpha0

View file

@ -19,11 +19,12 @@
package de.staropensource.sosengine.base.utility; package de.staropensource.sosengine.base.utility;
import de.staropensource.sosengine.base.Engine;
import de.staropensource.sosengine.base.EngineConfiguration; import de.staropensource.sosengine.base.EngineConfiguration;
import de.staropensource.sosengine.base.classes.logging.LogIssuer;
import de.staropensource.sosengine.base.logging.Logger; import de.staropensource.sosengine.base.logging.Logger;
import de.staropensource.sosengine.base.logging.LoggerInstance; import de.staropensource.sosengine.base.logging.LoggerInstance;
import de.staropensource.sosengine.base.types.CodePart; import de.staropensource.sosengine.base.types.CodePart;
import de.staropensource.sosengine.base.classes.logging.LogIssuer;
import lombok.Getter; import lombok.Getter;
import org.fusesource.jansi.Ansi; import org.fusesource.jansi.Ansi;
import org.jetbrains.annotations.NotNull; import org.jetbrains.annotations.NotNull;
@ -40,14 +41,14 @@ import org.jetbrains.annotations.NotNull;
@SuppressWarnings({ "unused", "JavadocDeclaration", "JavadocBlankLines" }) @SuppressWarnings({ "unused", "JavadocDeclaration", "JavadocBlankLines" })
public class ShortcodeConverter { public class ShortcodeConverter {
/** /**
* Instance. * Contains the class instance.
* *
* @since 1-alpha0 * @since 1-alpha0
* *
* -- GETTER -- * -- GETTER --
* Returns the {@link ShortcodeConverter} instance. * Returns the class instance.
* *
* @return {@link ShortcodeConverter} instance * @return class instance unless {@link Engine} is uninitialized
* @since 1-alpha0 * @since 1-alpha0
*/ */
@Getter @Getter
@ -62,7 +63,7 @@ public class ShortcodeConverter {
private final LoggerInstance logger = new LoggerInstance(new LogIssuer(getClass(), CodePart.ENGINE)); private final LoggerInstance logger = new LoggerInstance(new LogIssuer(getClass(), CodePart.ENGINE));
/** /**
* Constructor. * Constructs this class.
* *
* @since 1-alpha0 * @since 1-alpha0
*/ */

View file

@ -47,7 +47,7 @@ public class StackTraceParser {
private final @NotNull Throwable throwable; private final @NotNull Throwable throwable;
/** /**
* Constructor. * Constructs this class.
* *
* @param throwable throwable to use * @param throwable throwable to use
* @since 1-alpha0 * @since 1-alpha0

View file

@ -28,7 +28,7 @@ import de.staropensource.sosengine.base.classes.logging.LogLevel;
*/ */
public class UnitConfig { public class UnitConfig {
/** /**
* Constructor. * Constructs this class.
* *
* @since 1-alpha0 * @since 1-alpha0
*/ */

View file

@ -40,7 +40,7 @@ public class UnitLogger {
private final Class<?> clazz; private final Class<?> clazz;
/** /**
* Constructor. * Creates a new unit logger.
* *
* @param clazz parent class * @param clazz parent class
* @since 1-alpha0 * @since 1-alpha0

View file

@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull;
@SuppressWarnings({ "unused" }) @SuppressWarnings({ "unused" })
public final class OpenGlManagement implements ApiManagementClass { public final class OpenGlManagement implements ApiManagementClass {
/** /**
* Constructor. * Constructs this class.
*/ */
public OpenGlManagement() {} public OpenGlManagement() {}

View file

@ -50,14 +50,14 @@ import static org.lwjgl.glfw.GLFW.*;
@EngineSubsystem @EngineSubsystem
public final class OpenGlSubsystem implements ApiMainClass { public final class OpenGlSubsystem implements ApiMainClass {
/** /**
* Instance. * Contains the class instance.
* *
* @since 1-alpha0 * @since 1-alpha0
* *
* -- GETTER -- * -- GETTER --
* Returns the {@link OpenGlSubsystem} instance. * Returns the class instance.
* *
* @return {@link OpenGlSubsystem} instance unless uninitialized * @return class instance unless the subsystem is uninitialized
* @since 1-alpha0 * @since 1-alpha0
*/ */
@Getter @Getter
@ -84,7 +84,7 @@ public final class OpenGlSubsystem implements ApiMainClass {
private ApiManagementClass management; private ApiManagementClass management;
/** /**
* Constructor. * Constructs this subsystem.
* *
* @since 1-alpha0 * @since 1-alpha0
*/ */

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