From 9713f7fc044e3d5a1a47ea69c171743a6945af64 Mon Sep 17 00:00:00 2001 From: Nathan Erwin Date: Wed, 11 Oct 2023 16:52:21 -0400 Subject: [PATCH] Update javadocs for various build items Updates for consistency, verb tense, spelling, and grammar that I noticed while working through the "Building my first extension" guide. Signed-off-by:Nathan Erwin --- ...tionalApplicationArchiveMarkerBuildItem.java | 2 +- .../AdditionalIndexedClassesBuildItem.java | 4 ++-- .../builditem/ApplicationArchivesBuildItem.java | 4 ++-- .../builditem/ApplicationIndexBuildItem.java | 2 +- .../builditem/ApplicationStartBuildItem.java | 2 +- .../builditem/ArchiveRootBuildItem.java | 17 +++++++---------- .../builditem/BytecodeTransformerBuildItem.java | 6 +++--- .../builditem/CapabilityBuildItem.java | 2 +- .../builditem/CombinedIndexBuildItem.java | 2 +- .../builditem/ConfigDescriptionBuildItem.java | 2 +- .../CuratedApplicationShutdownBuildItem.java | 6 +++--- .../DevServicesConfigResultBuildItem.java | 2 +- ...evServicesLauncherConfigResultBuildItem.java | 2 +- .../builditem/DevServicesResultBuildItem.java | 4 ++-- .../DevServicesSharedNetworkBuildItem.java | 6 +++--- .../deployment/builditem/ExecutorBuildItem.java | 2 +- .../deployment/builditem/FeatureBuildItem.java | 2 +- .../GeneratedFileSystemResourceBuildItem.java | 2 +- ...ratedFileSystemResourceHandledBuildItem.java | 2 +- .../GeneratedNativeImageClassBuildItem.java | 2 +- .../builditem/IOThreadDetectorBuildItem.java | 2 +- .../deployment/builditem/InitTaskBuildItem.java | 16 ++++++++-------- .../builditem/InitTaskCompletedBuildItem.java | 4 ++-- .../builditem/LaunchModeBuildItem.java | 3 +-- .../builditem/LiveReloadBuildItem.java | 13 +++++-------- .../builditem/LogCategoryBuildItem.java | 1 + .../builditem/ObjectSubstitutionBuildItem.java | 4 ++-- .../builditem/PreloadClassBuildItem.java | 2 +- .../PreloadClassesEnabledBuildItem.java | 2 +- .../RawCommandLineArgumentsBuildItem.java | 2 +- .../SnapStartDefaultValueBuildItem.java | 2 +- .../builditem/StreamingLogHandlerBuildItem.java | 2 +- ...NonRuntimeConfigChangedWarningBuildItem.java | 2 +- .../builditem/SystemPropertyBuildItem.java | 1 - .../builditem/TestAnnotationBuildItem.java | 4 ++-- .../builditem/TestClassBeanBuildItem.java | 2 +- .../builditem/TransformedClassesBuildItem.java | 2 +- .../builditem/WebSocketLogHandlerBuildItem.java | 2 +- 38 files changed, 66 insertions(+), 73 deletions(-) diff --git a/core/deployment/src/main/java/io/quarkus/deployment/builditem/AdditionalApplicationArchiveMarkerBuildItem.java b/core/deployment/src/main/java/io/quarkus/deployment/builditem/AdditionalApplicationArchiveMarkerBuildItem.java index 8dec21ed2c4bb..713d82d099c04 100644 --- a/core/deployment/src/main/java/io/quarkus/deployment/builditem/AdditionalApplicationArchiveMarkerBuildItem.java +++ b/core/deployment/src/main/java/io/quarkus/deployment/builditem/AdditionalApplicationArchiveMarkerBuildItem.java @@ -4,7 +4,7 @@ /** * A marker file that if present indicates that a given archive should be treated as an - * application archive + * application archive. */ public final class AdditionalApplicationArchiveMarkerBuildItem extends MultiBuildItem { diff --git a/core/deployment/src/main/java/io/quarkus/deployment/builditem/AdditionalIndexedClassesBuildItem.java b/core/deployment/src/main/java/io/quarkus/deployment/builditem/AdditionalIndexedClassesBuildItem.java index 017e136f3b246..d4cf0e8bd223c 100644 --- a/core/deployment/src/main/java/io/quarkus/deployment/builditem/AdditionalIndexedClassesBuildItem.java +++ b/core/deployment/src/main/java/io/quarkus/deployment/builditem/AdditionalIndexedClassesBuildItem.java @@ -6,8 +6,8 @@ import io.quarkus.builder.item.MultiBuildItem; /** - * Allows extensions to add classes to the index available via {@link CombinedIndexBuildItem} - * The classes are loaded by the Deployment ClassLoader + * Allows extensions to add classes to the index available via {@link CombinedIndexBuildItem}. + * The classes are loaded by the Deployment ClassLoader. */ public final class AdditionalIndexedClassesBuildItem extends MultiBuildItem { diff --git a/core/deployment/src/main/java/io/quarkus/deployment/builditem/ApplicationArchivesBuildItem.java b/core/deployment/src/main/java/io/quarkus/deployment/builditem/ApplicationArchivesBuildItem.java index 0b4c50951f60e..154b6b1def97f 100644 --- a/core/deployment/src/main/java/io/quarkus/deployment/builditem/ApplicationArchivesBuildItem.java +++ b/core/deployment/src/main/java/io/quarkus/deployment/builditem/ApplicationArchivesBuildItem.java @@ -24,7 +24,7 @@ public ApplicationArchivesBuildItem(ApplicationArchive root, Collection getAllApplicationArchives() { } /** - * Returns the archive that contains the given class name, or null if the class cannot be found + * Returns the archive that contains the given class name, or null if the class cannot be found. * * @param className The class name * @return The application archive diff --git a/core/deployment/src/main/java/io/quarkus/deployment/builditem/ApplicationIndexBuildItem.java b/core/deployment/src/main/java/io/quarkus/deployment/builditem/ApplicationIndexBuildItem.java index b93ce3d12d0b4..e1e5d7e7c98ed 100644 --- a/core/deployment/src/main/java/io/quarkus/deployment/builditem/ApplicationIndexBuildItem.java +++ b/core/deployment/src/main/java/io/quarkus/deployment/builditem/ApplicationIndexBuildItem.java @@ -5,7 +5,7 @@ import io.quarkus.builder.item.SimpleBuildItem; /** - * The Jandex index of the application root + * The Jandex index of the application root. */ public final class ApplicationIndexBuildItem extends SimpleBuildItem { diff --git a/core/deployment/src/main/java/io/quarkus/deployment/builditem/ApplicationStartBuildItem.java b/core/deployment/src/main/java/io/quarkus/deployment/builditem/ApplicationStartBuildItem.java index 0472ad5822ff1..0db1c88ee01e0 100644 --- a/core/deployment/src/main/java/io/quarkus/deployment/builditem/ApplicationStartBuildItem.java +++ b/core/deployment/src/main/java/io/quarkus/deployment/builditem/ApplicationStartBuildItem.java @@ -5,7 +5,7 @@ /** * A symbolic class that is produced after the startup event has been fired. * - * At this point it should be safe to open sockets and begin processing requests + * At this point it should be safe to open sockets and begin processing requests. */ public final class ApplicationStartBuildItem extends SimpleBuildItem { diff --git a/core/deployment/src/main/java/io/quarkus/deployment/builditem/ArchiveRootBuildItem.java b/core/deployment/src/main/java/io/quarkus/deployment/builditem/ArchiveRootBuildItem.java index 90e29b92e0ac6..d827753a08fee 100644 --- a/core/deployment/src/main/java/io/quarkus/deployment/builditem/ArchiveRootBuildItem.java +++ b/core/deployment/src/main/java/io/quarkus/deployment/builditem/ArchiveRootBuildItem.java @@ -121,9 +121,8 @@ public Path getArchiveLocation() { } /** - * * Returns a path representing the archive root. Note that if this is a jar archive this is not the path to the - * jar, but rather a path to the root of the mounted {@link com.sun.nio.zipfs.ZipFileSystem} + * jar, but rather a path to the root of the mounted {@link com.sun.nio.zipfs.ZipFileSystem}. * * @return The archive root. * @deprecated in favor of {@link #getRootDirectories()} @@ -134,14 +133,13 @@ public Path getArchiveRoot() { } /** - * Collection of path representing the archive's root directories. If there is a JAR among the paths + * Collection of paths representing the archive's root directories. If there is a JAR among the paths * (returned by {@link #getResolvedPaths()}) this method will return the path to the root of the mounted * {@link java.nio.file.ZipFileSystem} * instead. * * @deprecated in favor of {@link #getRootDirectories()} - * - * @return Collection of path representing the archive's root directories. + * @return Collection of paths representing the archive's root directories */ @Deprecated public PathsCollection getRootDirs() { @@ -149,12 +147,12 @@ public PathsCollection getRootDirs() { } /** - * Collection of path representing the archive's root directories. If there is a JAR among the paths + * Collection of paths representing the archive's root directories. If there is a JAR among the paths * (returned by {@link #getResolvedPaths()}) this method will return the path to the root of the mounted * {@link java.nio.file.ZipFileSystem} * instead. * - * @return Collection of path representing the archive's root directories. + * @return Collection of paths representing the archive's root directories */ public PathCollection getRootDirectories() { return rootDirs; @@ -164,8 +162,7 @@ public PathCollection getRootDirectories() { * Collection of paths that collectively constitute the application archive's content. * * @deprecated in favor of {@link #getResolvedPaths()} - * - * @return collection of paths that collectively constitute the application archive content. + * @return collection of paths that collectively constitute the application archive content */ @Deprecated public PathsCollection getPaths() { @@ -175,7 +172,7 @@ public PathsCollection getPaths() { /** * Collection of paths that collectively constitute the application archive's content. * - * @return collection of paths that collectively constitute the application archive content. + * @return collection of paths that collectively constitute the application archive content */ public PathCollection getResolvedPaths() { return paths; diff --git a/core/deployment/src/main/java/io/quarkus/deployment/builditem/BytecodeTransformerBuildItem.java b/core/deployment/src/main/java/io/quarkus/deployment/builditem/BytecodeTransformerBuildItem.java index 30618a463ab5b..adfdbec20bf84 100644 --- a/core/deployment/src/main/java/io/quarkus/deployment/builditem/BytecodeTransformerBuildItem.java +++ b/core/deployment/src/main/java/io/quarkus/deployment/builditem/BytecodeTransformerBuildItem.java @@ -21,8 +21,8 @@ public final class BytecodeTransformerBuildItem extends MultiBuildItem { final BiFunction visitorFunction; /** - * Function that can be applied to the inout bytes before it is passed into ASM. This should only be used - * in very specific circumstances. At the moment the only known valid use case is jacoco, which needs + * Function that can be applied to the input bytes before it is passed into ASM. This should only be used + * in very specific circumstances. At the moment the only known valid use case is JaCoCo, which needs * access to the unmodified class file bytes. */ final BiFunction inputTransformer; @@ -31,7 +31,7 @@ public final class BytecodeTransformerBuildItem extends MultiBuildItem { * A set of class names that need to be present in the const pool for the transformation to happen. These * need to be in JVM internal format. *

- * The transformation is only applied if at least one of the entries in the const pool is present + * The transformation is only applied if at least one of the entries in the const pool is present. *

* Note that this is an optimisation, and if another transformer is transforming the class anyway then * this transformer will always be applied. diff --git a/core/deployment/src/main/java/io/quarkus/deployment/builditem/CapabilityBuildItem.java b/core/deployment/src/main/java/io/quarkus/deployment/builditem/CapabilityBuildItem.java index 4a7ccc7c36d60..a93d7486b1cbd 100644 --- a/core/deployment/src/main/java/io/quarkus/deployment/builditem/CapabilityBuildItem.java +++ b/core/deployment/src/main/java/io/quarkus/deployment/builditem/CapabilityBuildItem.java @@ -59,7 +59,7 @@ public CapabilityBuildItem(String name) { /** * IMPORTANT: in most cases, capability build items should not be produced by build steps of specific * extensions but be configured in their extension descriptors instead. Capabilities produced from - * extension build steps aren't available for the Quarkus dev tools. As a consequences, such capabilities + * extension build steps aren't available for the Quarkus dev tools. As a consequence, such capabilities * can not be taken into account when analyzing extension compatibility during project creation or when * adding new extensions to a project. * diff --git a/core/deployment/src/main/java/io/quarkus/deployment/builditem/CombinedIndexBuildItem.java b/core/deployment/src/main/java/io/quarkus/deployment/builditem/CombinedIndexBuildItem.java index fc47bce41240e..927473b7622fa 100644 --- a/core/deployment/src/main/java/io/quarkus/deployment/builditem/CombinedIndexBuildItem.java +++ b/core/deployment/src/main/java/io/quarkus/deployment/builditem/CombinedIndexBuildItem.java @@ -14,7 +14,7 @@ * Compared to {@code BeanArchiveIndexBuildItem}, this index doesn't contain all CDI-related information. * On the other hand, it can contain classes from archives/dependencies that had no CDI component declared within them. * - * The computing index can also be used to index classes on demand. This when {@link IndexView#getClassByName(DotName)} + * The computing index can also be used to index classes on demand, when {@link IndexView#getClassByName(DotName)} * is called. Note that this is a mutable index as this will add additional information, so in general this Index * should only be used if you actually need it. * diff --git a/core/deployment/src/main/java/io/quarkus/deployment/builditem/ConfigDescriptionBuildItem.java b/core/deployment/src/main/java/io/quarkus/deployment/builditem/ConfigDescriptionBuildItem.java index 0f4a85265d051..6d5d8155003ec 100644 --- a/core/deployment/src/main/java/io/quarkus/deployment/builditem/ConfigDescriptionBuildItem.java +++ b/core/deployment/src/main/java/io/quarkus/deployment/builditem/ConfigDescriptionBuildItem.java @@ -7,7 +7,7 @@ /** * A build item that is not part of the standard build, but is only used to generate - * example config files and docs + * example config files and docs. */ public final class ConfigDescriptionBuildItem extends MultiBuildItem implements Comparable { private final String propertyName; diff --git a/core/deployment/src/main/java/io/quarkus/deployment/builditem/CuratedApplicationShutdownBuildItem.java b/core/deployment/src/main/java/io/quarkus/deployment/builditem/CuratedApplicationShutdownBuildItem.java index 4f36c075c2e90..b807a64868b7d 100644 --- a/core/deployment/src/main/java/io/quarkus/deployment/builditem/CuratedApplicationShutdownBuildItem.java +++ b/core/deployment/src/main/java/io/quarkus/deployment/builditem/CuratedApplicationShutdownBuildItem.java @@ -11,7 +11,7 @@ * Build Item that can be used to queue shutdown tasks that are run when the {@link io.quarkus.bootstrap.app.CuratedApplication} * is closed. *

- * For production applications, this will be at the end of the maven/gradle build. For dev mode applications, this will be + * For production applications, this will be at the end of the Maven/Gradle build. For dev mode applications, this will be * when dev mode shuts down. For tests, it will generally be at the end of the test run. However, for continuous testing this * will be when the outer dev mode process shuts down. For unit style tests, this will usually be the end of the test. */ @@ -30,11 +30,11 @@ public CuratedApplicationShutdownBuildItem(QuarkusClassLoader baseCl, boolean fi } /** - * Adds a task to run when the application is closed + * Adds a task to run when the application is closed. * * @param task The task * @param firstRunOnly If this should only be added for the first augment step. This makes it possible to prevent tasks - * being added for every build + * being added for every build. */ public synchronized void addCloseTask(Runnable task, boolean firstRunOnly) { if (firstRunOnly || firstRun) { diff --git a/core/deployment/src/main/java/io/quarkus/deployment/builditem/DevServicesConfigResultBuildItem.java b/core/deployment/src/main/java/io/quarkus/deployment/builditem/DevServicesConfigResultBuildItem.java index 675e755bbd291..a09307e6ad241 100644 --- a/core/deployment/src/main/java/io/quarkus/deployment/builditem/DevServicesConfigResultBuildItem.java +++ b/core/deployment/src/main/java/io/quarkus/deployment/builditem/DevServicesConfigResultBuildItem.java @@ -3,7 +3,7 @@ import io.quarkus.builder.item.MultiBuildItem; /** - * Configuration property that is the result of start dev services. + * Configuration property that is the result of starting dev services. * * Used to start and configure dev services, any processor starting dev services should produce these items. * diff --git a/core/deployment/src/main/java/io/quarkus/deployment/builditem/DevServicesLauncherConfigResultBuildItem.java b/core/deployment/src/main/java/io/quarkus/deployment/builditem/DevServicesLauncherConfigResultBuildItem.java index bb8301df169cd..94ae93babb1d0 100644 --- a/core/deployment/src/main/java/io/quarkus/deployment/builditem/DevServicesLauncherConfigResultBuildItem.java +++ b/core/deployment/src/main/java/io/quarkus/deployment/builditem/DevServicesLauncherConfigResultBuildItem.java @@ -5,7 +5,7 @@ import io.quarkus.builder.item.SimpleBuildItem; /** - * Build item that contains the final results of all + * Build item that contains the final results of all configuration. */ public final class DevServicesLauncherConfigResultBuildItem extends SimpleBuildItem { diff --git a/core/deployment/src/main/java/io/quarkus/deployment/builditem/DevServicesResultBuildItem.java b/core/deployment/src/main/java/io/quarkus/deployment/builditem/DevServicesResultBuildItem.java index 560a9d1f49e38..7645cc96b49da 100644 --- a/core/deployment/src/main/java/io/quarkus/deployment/builditem/DevServicesResultBuildItem.java +++ b/core/deployment/src/main/java/io/quarkus/deployment/builditem/DevServicesResultBuildItem.java @@ -9,13 +9,13 @@ import io.quarkus.builder.item.MultiBuildItem; /** - * BuildItem for running dev services + * BuildItem for running dev services. * Combines injected configs to the application with container id (if it exists). * * Processors are expected to return this build item not only when the dev service first starts, * but also if a running dev service already exists. * - * {@link RunningDevService} helps to manage the lifecycle of the running dev service + * {@link RunningDevService} helps to manage the lifecycle of the running dev service. */ public final class DevServicesResultBuildItem extends MultiBuildItem { diff --git a/core/deployment/src/main/java/io/quarkus/deployment/builditem/DevServicesSharedNetworkBuildItem.java b/core/deployment/src/main/java/io/quarkus/deployment/builditem/DevServicesSharedNetworkBuildItem.java index 2dca91a136c15..fbce82559bd27 100644 --- a/core/deployment/src/main/java/io/quarkus/deployment/builditem/DevServicesSharedNetworkBuildItem.java +++ b/core/deployment/src/main/java/io/quarkus/deployment/builditem/DevServicesSharedNetworkBuildItem.java @@ -11,16 +11,16 @@ import io.quarkus.builder.item.MultiBuildItem; /** - * A marker build item that, if any instances are provided during the build, the containers started by DevServices + * A marker build item that indicates, if any instances are provided during the build, the containers started by DevServices * will use a shared network. * This is mainly useful in integration tests where the application container needs to be able - * to communicate with the services containers + * to communicate with the service containers. */ public final class DevServicesSharedNetworkBuildItem extends MultiBuildItem { /** * Generates a {@code List> build chain builder} which creates a build step - * producing the {@link DevServicesSharedNetworkBuildItem} build item + * producing the {@link DevServicesSharedNetworkBuildItem} build item. */ public static final class Factory implements Function, List>> { diff --git a/core/deployment/src/main/java/io/quarkus/deployment/builditem/ExecutorBuildItem.java b/core/deployment/src/main/java/io/quarkus/deployment/builditem/ExecutorBuildItem.java index a5bafee044258..a8059e74a83ee 100644 --- a/core/deployment/src/main/java/io/quarkus/deployment/builditem/ExecutorBuildItem.java +++ b/core/deployment/src/main/java/io/quarkus/deployment/builditem/ExecutorBuildItem.java @@ -5,7 +5,7 @@ import io.quarkus.builder.item.SimpleBuildItem; /** - * The main executor for blocking tasks + * The main executor for blocking tasks. */ public final class ExecutorBuildItem extends SimpleBuildItem { diff --git a/core/deployment/src/main/java/io/quarkus/deployment/builditem/FeatureBuildItem.java b/core/deployment/src/main/java/io/quarkus/deployment/builditem/FeatureBuildItem.java index 59f2b16314ad4..a3c7be9c36aa2 100644 --- a/core/deployment/src/main/java/io/quarkus/deployment/builditem/FeatureBuildItem.java +++ b/core/deployment/src/main/java/io/quarkus/deployment/builditem/FeatureBuildItem.java @@ -6,7 +6,7 @@ import io.quarkus.deployment.Feature; /** - * Represents a functionality provided by an extension. The name of the feature gets displayed in the log during application + * Represents functionality provided by an extension. The name of the feature gets displayed in the log during application * bootstrap. *

* An extension should provide at most one feature. The name must be unique. If multiple extensions register a feature of the diff --git a/core/deployment/src/main/java/io/quarkus/deployment/builditem/GeneratedFileSystemResourceBuildItem.java b/core/deployment/src/main/java/io/quarkus/deployment/builditem/GeneratedFileSystemResourceBuildItem.java index 742c422f39f4f..d5c262d3714f1 100644 --- a/core/deployment/src/main/java/io/quarkus/deployment/builditem/GeneratedFileSystemResourceBuildItem.java +++ b/core/deployment/src/main/java/io/quarkus/deployment/builditem/GeneratedFileSystemResourceBuildItem.java @@ -6,7 +6,7 @@ * Used when resources generated by the build should not end up in the produced runnable artifact, * but in the file system inside the output directory of OutputTargetBuildItem. * - * This is written to the file system for normal and dev mode, but not for test mode + * This is written to the file system for normal and dev mode, but not for test mode. */ public final class GeneratedFileSystemResourceBuildItem extends MultiBuildItem { final String name; diff --git a/core/deployment/src/main/java/io/quarkus/deployment/builditem/GeneratedFileSystemResourceHandledBuildItem.java b/core/deployment/src/main/java/io/quarkus/deployment/builditem/GeneratedFileSystemResourceHandledBuildItem.java index 77cd613578c1f..c8445406685a0 100644 --- a/core/deployment/src/main/java/io/quarkus/deployment/builditem/GeneratedFileSystemResourceHandledBuildItem.java +++ b/core/deployment/src/main/java/io/quarkus/deployment/builditem/GeneratedFileSystemResourceHandledBuildItem.java @@ -3,7 +3,7 @@ import io.quarkus.builder.item.SimpleBuildItem; /** - * Marker used only to ensure that the file system resources where properly written in dev-mode + * Marker used only to ensure that the file system resources where properly written in dev mode. */ public final class GeneratedFileSystemResourceHandledBuildItem extends SimpleBuildItem { diff --git a/core/deployment/src/main/java/io/quarkus/deployment/builditem/GeneratedNativeImageClassBuildItem.java b/core/deployment/src/main/java/io/quarkus/deployment/builditem/GeneratedNativeImageClassBuildItem.java index 41a3b265e0bb8..f7fb1fdb60fb3 100644 --- a/core/deployment/src/main/java/io/quarkus/deployment/builditem/GeneratedNativeImageClassBuildItem.java +++ b/core/deployment/src/main/java/io/quarkus/deployment/builditem/GeneratedNativeImageClassBuildItem.java @@ -3,7 +3,7 @@ import io.quarkus.builder.item.MultiBuildItem; /** - * A generated class that is only applicable to native images + * A generated class that is only applicable to native images. */ public final class GeneratedNativeImageClassBuildItem extends MultiBuildItem { final String name; diff --git a/core/deployment/src/main/java/io/quarkus/deployment/builditem/IOThreadDetectorBuildItem.java b/core/deployment/src/main/java/io/quarkus/deployment/builditem/IOThreadDetectorBuildItem.java index d06ed43642d64..e9b5da0dc7d96 100644 --- a/core/deployment/src/main/java/io/quarkus/deployment/builditem/IOThreadDetectorBuildItem.java +++ b/core/deployment/src/main/java/io/quarkus/deployment/builditem/IOThreadDetectorBuildItem.java @@ -4,7 +4,7 @@ import io.quarkus.runtime.IOThreadDetector; /** - * A build items provides the ability to detect if the current thread is an IO thread + * A build item that provides the ability to detect if the current thread is an IO thread */ public final class IOThreadDetectorBuildItem extends MultiBuildItem { diff --git a/core/deployment/src/main/java/io/quarkus/deployment/builditem/InitTaskBuildItem.java b/core/deployment/src/main/java/io/quarkus/deployment/builditem/InitTaskBuildItem.java index ac66f850ac3d9..b8a33322b40f2 100644 --- a/core/deployment/src/main/java/io/quarkus/deployment/builditem/InitTaskBuildItem.java +++ b/core/deployment/src/main/java/io/quarkus/deployment/builditem/InitTaskBuildItem.java @@ -9,11 +9,11 @@ /** * Represents an initialization task for the application. - * Often extension perform some sort of initialization as part of the application startup. + * Often extensions perform some sort of initialization as part of the application startup. * There are cases where we want to externalize the initialization (e.g. in a pipeline). * * Often the task is run using the same artifact as the application but using a different command or - * arguments. In the later case it might be deseriable to pass additional environment variable to both the + * arguments. In the later case it might be desirable to pass additional environment variables to both the * init tasks (to enable init) and the application (to disable the init). */ public final class InitTaskBuildItem extends MultiBuildItem { @@ -102,9 +102,9 @@ public InitTaskBuildItem withAppEnvVars(Map appEnvVars) { /** * Flag for tasks that require access to the environment variables of the application. * Often tasks need to access resources, configured via environment variables. This - * flag expresses that the task should be executed using the same envrironment variables as the application. + * flag expresses that the task should be executed using the same environment variables as the application. * - * @return true when the task is meant to share environment variables with the application. + * @return true when the task is meant to share environment variables with the application */ public boolean isSharedEnvironment() { return sharedEnvironment; @@ -116,13 +116,13 @@ public InitTaskBuildItem withSharedEnvironment(boolean sharedEnvironment) { } /** - * Flag for tasks that need to share filesystem with the application. - * Often tasks need to access resources, configured via filesystem (e.g. local config files, kubernetes service binding + * Flag for tasks that need to share the file system with the application. + * Often tasks need to access resources, configured via the file system (e.g. local config files, Kubernetes service binding * etc). * In other cases, tasks may need to produce files needed by the application. - * This flag expresses that the task should share filesystem with the application. + * This flag expresses that the task should share the file system with the application. * - * @return true when the task is meant to share filesystem. + * @return true when the task is meant to share the file system */ public boolean isSharedFilesystem() { return sharedFilesystem; diff --git a/core/deployment/src/main/java/io/quarkus/deployment/builditem/InitTaskCompletedBuildItem.java b/core/deployment/src/main/java/io/quarkus/deployment/builditem/InitTaskCompletedBuildItem.java index 9d2cb2bb61e66..dfb934ffe702d 100644 --- a/core/deployment/src/main/java/io/quarkus/deployment/builditem/InitTaskCompletedBuildItem.java +++ b/core/deployment/src/main/java/io/quarkus/deployment/builditem/InitTaskCompletedBuildItem.java @@ -3,9 +3,9 @@ import io.quarkus.builder.item.MultiBuildItem; /** - * A symbolic class that represents that an initialization task has been complete. + * A symbolic class that represents that an initialization task has been completed. * Similar to {@link ServiceStartBuildItem} but focused on initialization tasks (e.g. db migrations etc) that are run during - * runtime just before the application startups. + * runtime just before the application starts. *

* The build item is used, so that we can track when all initialization tasks have been completed. */ diff --git a/core/deployment/src/main/java/io/quarkus/deployment/builditem/LaunchModeBuildItem.java b/core/deployment/src/main/java/io/quarkus/deployment/builditem/LaunchModeBuildItem.java index e25cef971c186..2b968769f8e66 100644 --- a/core/deployment/src/main/java/io/quarkus/deployment/builditem/LaunchModeBuildItem.java +++ b/core/deployment/src/main/java/io/quarkus/deployment/builditem/LaunchModeBuildItem.java @@ -7,7 +7,7 @@ import io.quarkus.runtime.LaunchMode; /** - * indicates the type of launch + * Indicates the type of launch. */ public final class LaunchModeBuildItem extends SimpleBuildItem { @@ -64,7 +64,6 @@ public boolean isAuxiliaryApplication() { /** * The dev mode type of the main application. - * */ public Optional getAuxiliaryDevModeType() { return auxiliaryDevModeType; diff --git a/core/deployment/src/main/java/io/quarkus/deployment/builditem/LiveReloadBuildItem.java b/core/deployment/src/main/java/io/quarkus/deployment/builditem/LiveReloadBuildItem.java index 95bcedc823295..be747e41da36f 100644 --- a/core/deployment/src/main/java/io/quarkus/deployment/builditem/LiveReloadBuildItem.java +++ b/core/deployment/src/main/java/io/quarkus/deployment/builditem/LiveReloadBuildItem.java @@ -11,7 +11,6 @@ /** * A build item that can be used to query the live reload state. * - * * It can also be used to store context information that is persistent between hot reloads. */ public final class LiveReloadBuildItem extends SimpleBuildItem { @@ -22,7 +21,7 @@ public final class LiveReloadBuildItem extends SimpleBuildItem { private final ClassChangeInformation changeInformation; /** - * This constructor should only be used if live reload is not possible + * This constructor should only be used if live reload is not possible. */ public LiveReloadBuildItem() { liveReload = false; @@ -44,7 +43,7 @@ public LiveReloadBuildItem(boolean liveReload, Set changedResources, Map * time this app has started, or the app is not running in developer mode it will return false. * * Note that unsuccessful attempts to start are not counted, if the app initially failed to start - * the next attempt this will still return false. + * the next attempt will still return false. * * @return true if this is a live reload */ @@ -53,15 +52,14 @@ public boolean isLiveReload() { } /** - * If this is a live reload this set contains the config resources that have changed - * + * If this is a live reload this set contains the config resources that have changed. */ public Set getChangedResources() { return changedResources; } /** - * Gets an object from live reload context that is persistent across restarts + * Gets an object from live reload context that is persistent across restarts. * * @return */ @@ -70,8 +68,7 @@ public T getContextObject(Class type) { } /** - * Sets an object into the live reload context that is persistent across restarts - * + * Sets an object into the live reload context that is persistent across restarts. */ public void setContextObject(Class type, T val) { reloadContext.put(type, val); diff --git a/core/deployment/src/main/java/io/quarkus/deployment/builditem/LogCategoryBuildItem.java b/core/deployment/src/main/java/io/quarkus/deployment/builditem/LogCategoryBuildItem.java index de8b42838d1d6..327a92d44be2c 100644 --- a/core/deployment/src/main/java/io/quarkus/deployment/builditem/LogCategoryBuildItem.java +++ b/core/deployment/src/main/java/io/quarkus/deployment/builditem/LogCategoryBuildItem.java @@ -29,6 +29,7 @@ public LogCategoryBuildItem(final String category, final Level level) { * * @param category the category (must not be {@code null} or empty) * @param level the level (must not be {@code null}) + * @param setMinLevelDefault if the default minimum level for the category should be set */ public LogCategoryBuildItem(final String category, final Level level, boolean setMinLevelDefault) { Assert.checkNotNullParam("category", category); diff --git a/core/deployment/src/main/java/io/quarkus/deployment/builditem/ObjectSubstitutionBuildItem.java b/core/deployment/src/main/java/io/quarkus/deployment/builditem/ObjectSubstitutionBuildItem.java index e291534c775f6..4f949277f3974 100644 --- a/core/deployment/src/main/java/io/quarkus/deployment/builditem/ObjectSubstitutionBuildItem.java +++ b/core/deployment/src/main/java/io/quarkus/deployment/builditem/ObjectSubstitutionBuildItem.java @@ -4,11 +4,11 @@ import io.quarkus.runtime.ObjectSubstitution; /** - * Used to capture object substitution information for non-serializable classes + * Used to capture object substitution information for non-serializable classes. */ public final class ObjectSubstitutionBuildItem extends MultiBuildItem { /** - * Holder to keep type info around for compiler + * Holder to keep type info around for compiler. * * @param - from class * @param - to class diff --git a/core/deployment/src/main/java/io/quarkus/deployment/builditem/PreloadClassBuildItem.java b/core/deployment/src/main/java/io/quarkus/deployment/builditem/PreloadClassBuildItem.java index e7f11530561a4..1a15e4266f6ce 100644 --- a/core/deployment/src/main/java/io/quarkus/deployment/builditem/PreloadClassBuildItem.java +++ b/core/deployment/src/main/java/io/quarkus/deployment/builditem/PreloadClassBuildItem.java @@ -4,7 +4,7 @@ import io.smallrye.common.constraint.Assert; /** - * Class to be preloaded in static initialization phase of Quarkus + * Class to be preloaded in static initialization phase of Quarkus. */ public final class PreloadClassBuildItem extends MultiBuildItem { private final String className; diff --git a/core/deployment/src/main/java/io/quarkus/deployment/builditem/PreloadClassesEnabledBuildItem.java b/core/deployment/src/main/java/io/quarkus/deployment/builditem/PreloadClassesEnabledBuildItem.java index 76d282d411d24..e79c08b247932 100644 --- a/core/deployment/src/main/java/io/quarkus/deployment/builditem/PreloadClassesEnabledBuildItem.java +++ b/core/deployment/src/main/java/io/quarkus/deployment/builditem/PreloadClassesEnabledBuildItem.java @@ -3,7 +3,7 @@ import io.quarkus.builder.item.SimpleBuildItem; /** - * Extension build steps can produce this if preloading classes is enabled + * Extension build steps can produce this if preloading classes is enabled. */ public final class PreloadClassesEnabledBuildItem extends SimpleBuildItem { private final boolean initialize; diff --git a/core/deployment/src/main/java/io/quarkus/deployment/builditem/RawCommandLineArgumentsBuildItem.java b/core/deployment/src/main/java/io/quarkus/deployment/builditem/RawCommandLineArgumentsBuildItem.java index 0f0bb0821752f..f817324356f2d 100644 --- a/core/deployment/src/main/java/io/quarkus/deployment/builditem/RawCommandLineArgumentsBuildItem.java +++ b/core/deployment/src/main/java/io/quarkus/deployment/builditem/RawCommandLineArgumentsBuildItem.java @@ -19,7 +19,7 @@ public final class RawCommandLineArgumentsBuildItem extends SimpleBuildItem /** * As this object directly implements ReturnedProxy it can be * passed into bytecode recorders. The runtime value of the command line parameters - * in places directly into the startup context under this key. + * are placed directly into the startup context under this key. */ @Override public String __returned$proxy$key() { diff --git a/core/deployment/src/main/java/io/quarkus/deployment/builditem/SnapStartDefaultValueBuildItem.java b/core/deployment/src/main/java/io/quarkus/deployment/builditem/SnapStartDefaultValueBuildItem.java index 2ae1d00a46479..a9d365f7efdb8 100644 --- a/core/deployment/src/main/java/io/quarkus/deployment/builditem/SnapStartDefaultValueBuildItem.java +++ b/core/deployment/src/main/java/io/quarkus/deployment/builditem/SnapStartDefaultValueBuildItem.java @@ -3,7 +3,7 @@ import io.quarkus.builder.item.SimpleBuildItem; /** - * Allows extensions to set default value for enabling SnapStart. + * Allows extensions to set a default value for enabling SnapStart. */ public final class SnapStartDefaultValueBuildItem extends SimpleBuildItem { private final boolean defaultValue; diff --git a/core/deployment/src/main/java/io/quarkus/deployment/builditem/StreamingLogHandlerBuildItem.java b/core/deployment/src/main/java/io/quarkus/deployment/builditem/StreamingLogHandlerBuildItem.java index c11d0f3fd052f..5271f0e8f11de 100644 --- a/core/deployment/src/main/java/io/quarkus/deployment/builditem/StreamingLogHandlerBuildItem.java +++ b/core/deployment/src/main/java/io/quarkus/deployment/builditem/StreamingLogHandlerBuildItem.java @@ -9,7 +9,7 @@ import io.quarkus.runtime.RuntimeValue; /** - * A build item for adding the dev stream log via mutiny + * A build item for adding the dev stream log via mutiny. */ public final class StreamingLogHandlerBuildItem extends SimpleBuildItem { private final RuntimeValue> handlerValue; diff --git a/core/deployment/src/main/java/io/quarkus/deployment/builditem/SuppressNonRuntimeConfigChangedWarningBuildItem.java b/core/deployment/src/main/java/io/quarkus/deployment/builditem/SuppressNonRuntimeConfigChangedWarningBuildItem.java index 79d6049424220..c2d0127dcfd37 100644 --- a/core/deployment/src/main/java/io/quarkus/deployment/builditem/SuppressNonRuntimeConfigChangedWarningBuildItem.java +++ b/core/deployment/src/main/java/io/quarkus/deployment/builditem/SuppressNonRuntimeConfigChangedWarningBuildItem.java @@ -4,7 +4,7 @@ /** * Allows extensions to suppress the runtime warning that Quarkus emits on startup when a non-runtime configuration - * options is different at runtime than build time. + * option is different at runtime than build time. * An example usage of this is when a user provides some test value in {@code application.properties} * for a build-time only property and only provides the actual value on the command line when starting Quarkus. * In such a case we don't want the value set at build time to be revealed at runtime as it could be sensitive. diff --git a/core/deployment/src/main/java/io/quarkus/deployment/builditem/SystemPropertyBuildItem.java b/core/deployment/src/main/java/io/quarkus/deployment/builditem/SystemPropertyBuildItem.java index f9bf5add7638f..06560fd0d2ac9 100644 --- a/core/deployment/src/main/java/io/quarkus/deployment/builditem/SystemPropertyBuildItem.java +++ b/core/deployment/src/main/java/io/quarkus/deployment/builditem/SystemPropertyBuildItem.java @@ -4,7 +4,6 @@ /** * Represents a system property that will be set immediately on application startup. - * */ public final class SystemPropertyBuildItem extends MultiBuildItem { diff --git a/core/deployment/src/main/java/io/quarkus/deployment/builditem/TestAnnotationBuildItem.java b/core/deployment/src/main/java/io/quarkus/deployment/builditem/TestAnnotationBuildItem.java index 65773ed92f2fb..4c19e195eda23 100644 --- a/core/deployment/src/main/java/io/quarkus/deployment/builditem/TestAnnotationBuildItem.java +++ b/core/deployment/src/main/java/io/quarkus/deployment/builditem/TestAnnotationBuildItem.java @@ -3,8 +3,8 @@ import io.quarkus.builder.item.MultiBuildItem; /** - * This is an optional build item that allows us to track annotations that will define test classes - * It is only available during tests + * This is an optional build item that allows us to track annotations that will define test classes. + * It is only available during tests. */ public final class TestAnnotationBuildItem extends MultiBuildItem { diff --git a/core/deployment/src/main/java/io/quarkus/deployment/builditem/TestClassBeanBuildItem.java b/core/deployment/src/main/java/io/quarkus/deployment/builditem/TestClassBeanBuildItem.java index d5f764796260c..3ded383c9e7ff 100644 --- a/core/deployment/src/main/java/io/quarkus/deployment/builditem/TestClassBeanBuildItem.java +++ b/core/deployment/src/main/java/io/quarkus/deployment/builditem/TestClassBeanBuildItem.java @@ -4,7 +4,7 @@ /** * This is an optional build item that allows us to track additional test classes that will become beans. - * It is only available during tests + * It is only available during tests. */ public final class TestClassBeanBuildItem extends MultiBuildItem { diff --git a/core/deployment/src/main/java/io/quarkus/deployment/builditem/TransformedClassesBuildItem.java b/core/deployment/src/main/java/io/quarkus/deployment/builditem/TransformedClassesBuildItem.java index d2b87565bc129..551b778d6a537 100644 --- a/core/deployment/src/main/java/io/quarkus/deployment/builditem/TransformedClassesBuildItem.java +++ b/core/deployment/src/main/java/io/quarkus/deployment/builditem/TransformedClassesBuildItem.java @@ -13,7 +13,7 @@ * The results of applying bytecode transformation to a class. * * Note that this has also been abused somewhat to also represent removed - * resources, as the logic is the same, and it avoids have two separate mechanisms + * resources, as the logic is the same, and it avoids having two separate mechanisms * that essentially do the same thing. */ public final class TransformedClassesBuildItem extends SimpleBuildItem { diff --git a/core/deployment/src/main/java/io/quarkus/deployment/builditem/WebSocketLogHandlerBuildItem.java b/core/deployment/src/main/java/io/quarkus/deployment/builditem/WebSocketLogHandlerBuildItem.java index d102c670a1c27..15927c1abc17f 100644 --- a/core/deployment/src/main/java/io/quarkus/deployment/builditem/WebSocketLogHandlerBuildItem.java +++ b/core/deployment/src/main/java/io/quarkus/deployment/builditem/WebSocketLogHandlerBuildItem.java @@ -9,7 +9,7 @@ import io.quarkus.runtime.RuntimeValue; /** - * A build item for adding the dev stream log + * A build item for adding the dev stream log. */ public final class WebSocketLogHandlerBuildItem extends SimpleBuildItem { private final RuntimeValue> handlerValue;