This is an automated email from the ASF dual-hosted git repository. elharo pushed a commit to branch jd in repository https://gitbox.apache.org/repos/asf/maven-build-cache-extension.git
commit 18e35d32f91f931c20b124fc190c3a53a67e6a8a Author: Elliotte Rusty Harold <[email protected]> AuthorDate: Fri Jan 16 08:32:53 2026 -0500 Fix Javadoc issues per Oracle conventions --- .../BuildCacheMojosExecutionStrategy.java | 4 ++-- .../org/apache/maven/buildcache/CacheContext.java | 2 +- .../apache/maven/buildcache/CacheController.java | 2 +- .../maven/buildcache/CacheControllerImpl.java | 12 +++++----- .../org/apache/maven/buildcache/CacheDiff.java | 2 +- .../org/apache/maven/buildcache/CacheResult.java | 2 +- .../org/apache/maven/buildcache/CacheUtils.java | 11 +++++---- .../maven/buildcache/DefaultPluginScanConfig.java | 2 +- .../maven/buildcache/LifecyclePhasesHelper.java | 10 ++++---- .../maven/buildcache/MojoParametersListener.java | 2 +- .../maven/buildcache/NormalizedModelProvider.java | 4 ++-- .../apache/maven/buildcache/PluginScanConfig.java | 2 +- .../maven/buildcache/PluginScanConfigImpl.java | 2 +- .../maven/buildcache/ProjectInputCalculator.java | 3 --- .../buildcache/RemoteCacheRepositoryImpl.java | 2 +- .../org/apache/maven/buildcache/RestoreStatus.java | 2 +- .../maven/buildcache/ScanConfigProperties.java | 2 +- .../artifact/ArtifactRestorationReport.java | 4 ++-- .../buildcache/artifact/RestoredArtifact.java | 2 +- .../checksum/DependencyNotResolvedException.java | 2 +- .../maven/buildcache/checksum/DigestUtils.java | 2 +- .../apache/maven/buildcache/checksum/KeyUtils.java | 2 +- .../buildcache/checksum/MavenProjectInput.java | 28 ++++++++++------------ .../apache/maven/buildcache/checksum/WalkKey.java | 2 +- .../buildcache/checksum/exclude/Exclusion.java | 11 +++++---- .../checksum/exclude/ExclusionResolver.java | 8 +++---- .../maven/buildcache/hash/CloseableBuffer.java | 6 ++--- .../org/apache/maven/buildcache/hash/Hash.java | 8 +++---- .../maven/buildcache/hash/HashAlgorithm.java | 2 +- .../apache/maven/buildcache/hash/HashChecksum.java | 2 +- .../apache/maven/buildcache/hash/HashFactory.java | 2 +- .../org/apache/maven/buildcache/hash/HexUtils.java | 2 +- .../maven/buildcache/hash/ReflectionUtils.java | 2 +- .../java/org/apache/maven/buildcache/hash/SHA.java | 2 +- .../maven/buildcache/hash/ThreadLocalBuffer.java | 2 +- .../maven/buildcache/hash/ThreadLocalDigest.java | 2 +- .../java/org/apache/maven/buildcache/hash/Zah.java | 2 +- .../org/apache/maven/buildcache/xml/Build.java | 2 +- .../apache/maven/buildcache/xml/CacheConfig.java | 12 +++++----- .../maven/buildcache/xml/CacheConfigImpl.java | 4 ++-- .../apache/maven/buildcache/xml/CacheSource.java | 2 +- .../apache/maven/buildcache/xml/CacheState.java | 2 +- .../org/apache/maven/buildcache/xml/DtoUtils.java | 10 ++++---- .../apache/maven/buildcache/xml/XmlService.java | 2 +- 44 files changed, 95 insertions(+), 98 deletions(-) diff --git a/src/main/java/org/apache/maven/buildcache/BuildCacheMojosExecutionStrategy.java b/src/main/java/org/apache/maven/buildcache/BuildCacheMojosExecutionStrategy.java index 952dd43..eff221c 100644 --- a/src/main/java/org/apache/maven/buildcache/BuildCacheMojosExecutionStrategy.java +++ b/src/main/java/org/apache/maven/buildcache/BuildCacheMojosExecutionStrategy.java @@ -210,7 +210,7 @@ public void execute( } /** - * Check if the current mojo execution is for the clean goal + * Check if the current mojo execution is for the clean goal. * * @param mojoExecutions the mojo executions * @return true if the goal is clean and it is the only goal, false otherwise @@ -453,7 +453,7 @@ boolean isParamsMatched( * - redundant '..' and '.' to be removed to have consistent views on all paths * - all relative paths are considered portable and should not be touched * - absolute paths outside of project directory could not be deterministically - * relativized and not touched + * relativized and not touched. */ private static String normalizedPath(Path path, Path baseDirPath) { boolean isProjectSubdir = path.isAbsolute() && path.startsWith(baseDirPath); diff --git a/src/main/java/org/apache/maven/buildcache/CacheContext.java b/src/main/java/org/apache/maven/buildcache/CacheContext.java index 613f75a..7be1da5 100644 --- a/src/main/java/org/apache/maven/buildcache/CacheContext.java +++ b/src/main/java/org/apache/maven/buildcache/CacheContext.java @@ -25,7 +25,7 @@ import static java.util.Objects.requireNonNull; /** - * CacheContext + * CacheContext. */ public class CacheContext { diff --git a/src/main/java/org/apache/maven/buildcache/CacheController.java b/src/main/java/org/apache/maven/buildcache/CacheController.java index 7d8f578..bd54d6b 100644 --- a/src/main/java/org/apache/maven/buildcache/CacheController.java +++ b/src/main/java/org/apache/maven/buildcache/CacheController.java @@ -29,7 +29,7 @@ import org.apache.maven.project.MavenProject; /** - * CacheController + * CacheController. */ public interface CacheController { diff --git a/src/main/java/org/apache/maven/buildcache/CacheControllerImpl.java b/src/main/java/org/apache/maven/buildcache/CacheControllerImpl.java index 4c57328..7a78f2e 100644 --- a/src/main/java/org/apache/maven/buildcache/CacheControllerImpl.java +++ b/src/main/java/org/apache/maven/buildcache/CacheControllerImpl.java @@ -110,7 +110,7 @@ import static org.apache.maven.buildcache.checksum.MavenProjectInput.CACHE_IMPLEMENTATION_VERSION; /** - * CacheControllerImpl + * CacheControllerImpl. */ @SessionScoped @Named @@ -487,7 +487,7 @@ public ArtifactRestorationReport restoreProjectArtifacts(CacheResult cacheResult /** * Helper method similar to {@link org.apache.maven.project.MavenProjectHelper#attachArtifact} to work specifically - * with restored from cache artifacts + * with restored from cache artifacts. */ private RestoredArtifact restoredArtifact( org.apache.maven.artifact.Artifact parent, @@ -1232,8 +1232,8 @@ public FileVisitResult visitFile(Path path, BasicFileAttributes basicFileAttribu * <p><b>Interrupted Build Handling:</b> * If staging directory exists from interrupted previous run, it's deleted and recreated. * - * @param session The Maven session - * @param project The Maven project being built + * @param session the Maven session + * @param project the Maven project being built * @throws IOException if file move operations fail */ public void stagePreExistingArtifacts(MavenSession session, MavenProject project) throws IOException { @@ -1342,8 +1342,8 @@ private Set<Path> collectCachedArtifactPaths(MavenProject project) { * * <p>Finally, deletes the staging directory. * - * @param session The Maven session - * @param project The Maven project being built + * @param session the Maven session + * @param project the Maven project being built */ public void restoreStagedArtifacts(MavenSession session, MavenProject project) { final ProjectCacheState state = getProjectState(project); diff --git a/src/main/java/org/apache/maven/buildcache/CacheDiff.java b/src/main/java/org/apache/maven/buildcache/CacheDiff.java index 9c2977b..8b65e65 100644 --- a/src/main/java/org/apache/maven/buildcache/CacheDiff.java +++ b/src/main/java/org/apache/maven/buildcache/CacheDiff.java @@ -39,7 +39,7 @@ import org.apache.maven.buildcache.xml.diff.Mismatch; /** - * Utility class for comparing 2 builds + * Utility class for comparing 2 builds. */ public class CacheDiff { diff --git a/src/main/java/org/apache/maven/buildcache/CacheResult.java b/src/main/java/org/apache/maven/buildcache/CacheResult.java index 6c1b5b2..67d9801 100644 --- a/src/main/java/org/apache/maven/buildcache/CacheResult.java +++ b/src/main/java/org/apache/maven/buildcache/CacheResult.java @@ -24,7 +24,7 @@ import static java.util.Objects.requireNonNull; /** - * CacheResult + * CacheResult. */ public class CacheResult { diff --git a/src/main/java/org/apache/maven/buildcache/CacheUtils.java b/src/main/java/org/apache/maven/buildcache/CacheUtils.java index df3bb49..67ff876 100644 --- a/src/main/java/org/apache/maven/buildcache/CacheUtils.java +++ b/src/main/java/org/apache/maven/buildcache/CacheUtils.java @@ -57,7 +57,7 @@ import static org.apache.maven.artifact.Artifact.SNAPSHOT_VERSION; /** - * Cache Utils + * Cache Utils. */ public class CacheUtils { @@ -154,6 +154,7 @@ public static boolean isArchive(File file) { /** * Put every matching files of a directory in a zip. + * * @param dir directory to zip * @param zip zip to populate * @param glob glob to apply to filenames @@ -163,7 +164,7 @@ public static boolean isArchive(File file) { * the ZIP file (e.g., for cache keys) will include permission information, ensuring * cache invalidation when file permissions change. This behavior is similar to how Git * includes file mode in tree hashes.</p> - * @return true if at least one file has been included in the zip. + * @return true if at least one file has been included in the zip * @throws IOException */ public static boolean zip(final Path dir, final Path zip, final String glob, boolean preservePermissions) @@ -263,7 +264,7 @@ public static <T> void debugPrintCollection( * cross-platform builds.</p> * * @param permissions POSIX file permissions - * @return Unix mode: {@code 0100755} if owner-executable, {@code 0100644} otherwise + * @return unix mode: {@code 0100755} if owner-executable, {@code 0100644} otherwise */ private static int permissionsToMode(Set<PosixFilePermission> permissions) { // Following Git's approach: preserve only the owner executable bit @@ -287,8 +288,8 @@ private static int permissionsToMode(Set<PosixFilePermission> permissions) { * <p>The key distinction is the presence of the execute bit. Other permission variations * are normalized to these two standard patterns for portability.</p> * - * @param mode Unix mode (should be either {@code 0100755} or {@code 0100644}) - * @return Set of POSIX file permissions + * @param mode unix mode (should be either {@code 0100755} or {@code 0100644}) + * @return set of POSIX file permissions */ private static Set<PosixFilePermission> modeToPermissions(int mode) { Set<PosixFilePermission> permissions = new HashSet<>(); diff --git a/src/main/java/org/apache/maven/buildcache/DefaultPluginScanConfig.java b/src/main/java/org/apache/maven/buildcache/DefaultPluginScanConfig.java index e266386..6823932 100644 --- a/src/main/java/org/apache/maven/buildcache/DefaultPluginScanConfig.java +++ b/src/main/java/org/apache/maven/buildcache/DefaultPluginScanConfig.java @@ -23,7 +23,7 @@ import org.apache.maven.buildcache.xml.config.DirScanConfig; /** - * DefaultPluginScanConfig + * DefaultPluginScanConfig. */ public class DefaultPluginScanConfig implements PluginScanConfig { diff --git a/src/main/java/org/apache/maven/buildcache/LifecyclePhasesHelper.java b/src/main/java/org/apache/maven/buildcache/LifecyclePhasesHelper.java index c37facc..c58488d 100644 --- a/src/main/java/org/apache/maven/buildcache/LifecyclePhasesHelper.java +++ b/src/main/java/org/apache/maven/buildcache/LifecyclePhasesHelper.java @@ -135,7 +135,7 @@ public boolean isLaterPhase(String phase, String other) { } /** - * Computes the list of mojos executions in the clean phase + * Computes the list of mojos executions in the clean phase. */ public List<MojoExecution> getCleanSegment(MavenProject project, List<MojoExecution> mojoExecutions) { List<MojoExecution> list = new ArrayList<>(mojoExecutions.size()); @@ -151,11 +151,11 @@ public List<MojoExecution> getCleanSegment(MavenProject project, List<MojoExecut } /** - * Resolves lifecycle phase of a given mojo forks aware + * Resolves lifecycle phase of a given mojo forks aware. * - * @param project - project context - * @param mojoExecution - mojo to resolve lifecycle for - * @return phase + * @param project - project context + * @param mojoExecution - mojo to resolve lifecycle for + * @return phase */ private String resolveMojoExecutionLifecyclePhase(MavenProject project, MojoExecution mojoExecution) { diff --git a/src/main/java/org/apache/maven/buildcache/MojoParametersListener.java b/src/main/java/org/apache/maven/buildcache/MojoParametersListener.java index 62f8fb2..5d79067 100644 --- a/src/main/java/org/apache/maven/buildcache/MojoParametersListener.java +++ b/src/main/java/org/apache/maven/buildcache/MojoParametersListener.java @@ -37,7 +37,7 @@ import static org.apache.maven.buildcache.xml.CacheState.INITIALIZED; /** - * MojoParametersListener + * MojoParametersListener. */ @Singleton @Named diff --git a/src/main/java/org/apache/maven/buildcache/NormalizedModelProvider.java b/src/main/java/org/apache/maven/buildcache/NormalizedModelProvider.java index d81c26a..9273149 100644 --- a/src/main/java/org/apache/maven/buildcache/NormalizedModelProvider.java +++ b/src/main/java/org/apache/maven/buildcache/NormalizedModelProvider.java @@ -30,8 +30,8 @@ public interface NormalizedModelProvider { /** - * @param project - the project which model will be calculated for - * @return normalized model for project + * @param project - the project which model will be calculated for + * @return normalized model for project */ Model normalizedModel(MavenProject project); } diff --git a/src/main/java/org/apache/maven/buildcache/PluginScanConfig.java b/src/main/java/org/apache/maven/buildcache/PluginScanConfig.java index 80e94ab..8a2d5f8 100644 --- a/src/main/java/org/apache/maven/buildcache/PluginScanConfig.java +++ b/src/main/java/org/apache/maven/buildcache/PluginScanConfig.java @@ -23,7 +23,7 @@ import org.apache.maven.buildcache.xml.config.DirScanConfig; /** - * PluginScanConfig + * PluginScanConfig. */ public interface PluginScanConfig { diff --git a/src/main/java/org/apache/maven/buildcache/PluginScanConfigImpl.java b/src/main/java/org/apache/maven/buildcache/PluginScanConfigImpl.java index 04206ff..c2f249e 100644 --- a/src/main/java/org/apache/maven/buildcache/PluginScanConfigImpl.java +++ b/src/main/java/org/apache/maven/buildcache/PluginScanConfigImpl.java @@ -28,7 +28,7 @@ import org.apache.maven.buildcache.xml.config.TagScanConfig; /** - * PluginScanConfigImpl + * PluginScanConfigImpl. */ public class PluginScanConfigImpl implements PluginScanConfig { diff --git a/src/main/java/org/apache/maven/buildcache/ProjectInputCalculator.java b/src/main/java/org/apache/maven/buildcache/ProjectInputCalculator.java index c7a3602..64e47d7 100644 --- a/src/main/java/org/apache/maven/buildcache/ProjectInputCalculator.java +++ b/src/main/java/org/apache/maven/buildcache/ProjectInputCalculator.java @@ -21,9 +21,6 @@ import org.apache.maven.buildcache.xml.build.ProjectsInputInfo; import org.apache.maven.project.MavenProject; -/** - * - */ public interface ProjectInputCalculator { ProjectsInputInfo calculateInput(MavenProject project); diff --git a/src/main/java/org/apache/maven/buildcache/RemoteCacheRepositoryImpl.java b/src/main/java/org/apache/maven/buildcache/RemoteCacheRepositoryImpl.java index 8d884cd..127b958 100644 --- a/src/main/java/org/apache/maven/buildcache/RemoteCacheRepositoryImpl.java +++ b/src/main/java/org/apache/maven/buildcache/RemoteCacheRepositoryImpl.java @@ -143,7 +143,7 @@ public void saveArtifactFile(CacheResult cacheResult, org.apache.maven.artifact. } /** - * Downloads content of the resource + * Downloads content of the resource. * * @return null or content */ diff --git a/src/main/java/org/apache/maven/buildcache/RestoreStatus.java b/src/main/java/org/apache/maven/buildcache/RestoreStatus.java index 8855aa8..a1f2e11 100644 --- a/src/main/java/org/apache/maven/buildcache/RestoreStatus.java +++ b/src/main/java/org/apache/maven/buildcache/RestoreStatus.java @@ -19,7 +19,7 @@ package org.apache.maven.buildcache; /** - * RestoreStatus + * RestoreStatus. */ public enum RestoreStatus { EMPTY, diff --git a/src/main/java/org/apache/maven/buildcache/ScanConfigProperties.java b/src/main/java/org/apache/maven/buildcache/ScanConfigProperties.java index d7d07a1..6759a0f 100644 --- a/src/main/java/org/apache/maven/buildcache/ScanConfigProperties.java +++ b/src/main/java/org/apache/maven/buildcache/ScanConfigProperties.java @@ -19,7 +19,7 @@ package org.apache.maven.buildcache; /** - * ScanConfigProperties + * ScanConfigProperties. */ public class ScanConfigProperties { diff --git a/src/main/java/org/apache/maven/buildcache/artifact/ArtifactRestorationReport.java b/src/main/java/org/apache/maven/buildcache/artifact/ArtifactRestorationReport.java index 606582b..61fa1de 100644 --- a/src/main/java/org/apache/maven/buildcache/artifact/ArtifactRestorationReport.java +++ b/src/main/java/org/apache/maven/buildcache/artifact/ArtifactRestorationReport.java @@ -21,12 +21,12 @@ public class ArtifactRestorationReport { /** - * Success restoration indicator + * Success restoration indicator. */ private boolean success; /** - * True if some files have been restored (or attempted in case of error) in the project directory + * True if some files have been restored (or attempted in case of error) in the project directory. */ private boolean restoredFilesInProjectDirectory; diff --git a/src/main/java/org/apache/maven/buildcache/artifact/RestoredArtifact.java b/src/main/java/org/apache/maven/buildcache/artifact/RestoredArtifact.java index 596fb1f..dc58eb8 100644 --- a/src/main/java/org/apache/maven/buildcache/artifact/RestoredArtifact.java +++ b/src/main/java/org/apache/maven/buildcache/artifact/RestoredArtifact.java @@ -70,7 +70,7 @@ public RestoredArtifact( } /** - * Returns file using caller thread to download it if necessary + * Returns file using caller thread to download it if necessary. */ @Override public File getFile() { diff --git a/src/main/java/org/apache/maven/buildcache/checksum/DependencyNotResolvedException.java b/src/main/java/org/apache/maven/buildcache/checksum/DependencyNotResolvedException.java index 08ce775..d42e15b 100644 --- a/src/main/java/org/apache/maven/buildcache/checksum/DependencyNotResolvedException.java +++ b/src/main/java/org/apache/maven/buildcache/checksum/DependencyNotResolvedException.java @@ -19,7 +19,7 @@ package org.apache.maven.buildcache.checksum; /** - * DependencyNotResolvedException + * DependencyNotResolvedException. */ public class DependencyNotResolvedException extends RuntimeException { diff --git a/src/main/java/org/apache/maven/buildcache/checksum/DigestUtils.java b/src/main/java/org/apache/maven/buildcache/checksum/DigestUtils.java index a365d52..75c7f41 100644 --- a/src/main/java/org/apache/maven/buildcache/checksum/DigestUtils.java +++ b/src/main/java/org/apache/maven/buildcache/checksum/DigestUtils.java @@ -38,7 +38,7 @@ import static java.nio.charset.StandardCharsets.UTF_8; /** - * DigestUtils + * DigestUtils. */ public class DigestUtils { diff --git a/src/main/java/org/apache/maven/buildcache/checksum/KeyUtils.java b/src/main/java/org/apache/maven/buildcache/checksum/KeyUtils.java index 98e34fb..5cb2f42 100644 --- a/src/main/java/org/apache/maven/buildcache/checksum/KeyUtils.java +++ b/src/main/java/org/apache/maven/buildcache/checksum/KeyUtils.java @@ -23,7 +23,7 @@ import org.apache.maven.project.MavenProject; /** - * KeyUtils + * KeyUtils. */ public class KeyUtils { diff --git a/src/main/java/org/apache/maven/buildcache/checksum/MavenProjectInput.java b/src/main/java/org/apache/maven/buildcache/checksum/MavenProjectInput.java index 5cc53d8..6b2ee14 100644 --- a/src/main/java/org/apache/maven/buildcache/checksum/MavenProjectInput.java +++ b/src/main/java/org/apache/maven/buildcache/checksum/MavenProjectInput.java @@ -105,26 +105,26 @@ import static org.apache.maven.buildcache.xml.CacheConfigImpl.RESTORE_ON_DISK_ARTIFACTS_PROPERTY_NAME; /** - * MavenProjectInput + * MavenProjectInput. */ public class MavenProjectInput { /** - * Version of cache implementation. It is recommended to change to simplify remote cache maintenance + * Version of cache implementation. It is recommended to change to simplify remote cache maintenance. */ public static final String CACHE_IMPLEMENTATION_VERSION = "v1.1"; /** - * property name to pass glob value. The glob to be used to list directory files in plugins scanning + * Property name to pass glob value. The glob to be used to list directory files in plugins scanning. */ private static final String CACHE_INPUT_GLOB_NAME = "maven.build.cache.input.glob"; /** - * property name prefix to pass input files with project properties. smth like maven.build.cache.input.1 will be - * accepted + * Property name prefix to pass input files with project properties. smth like maven.build.cache.input.1 will be + * accepted. */ private static final String CACHE_INPUT_NAME = "maven.build.cache.input"; /** - * Flag to control if we should check values from plugin configs as file system objects + * Flag to control if we should check values from plugin configs as file system objects. */ private static final String CACHE_PROCESS_PLUGINS = "maven.build.cache.processPlugins"; @@ -143,7 +143,7 @@ public class MavenProjectInput { private final ArtifactHandlerManager artifactHandlerManager; /** - * The project glob to use every time there is no override + * The project glob to use every time there is no override. */ private final String projectGlob; @@ -422,7 +422,7 @@ private Path convertToAbsolutePath(Path path) { } /** - * entry point for directory walk + * Entry point for directory walk. */ private void startWalk( Path candidate, String glob, boolean recursive, List<Path> collectedFiles, Set<WalkKey> visitedDirs) { @@ -923,7 +923,7 @@ private Optional<MavenProject> tryResolveReactorProjectByGA(Dependency dependenc } /** - * PathIgnoringCaseComparator + * PathIgnoringCaseComparator. */ public static class PathIgnoringCaseComparator implements Comparator<Path> { @@ -942,8 +942,8 @@ public int compare(Path f1, Path f2) { /** * Skip lookup on a per-project level via a property to force module rebuild * e.g.{@code <maven.build.cache.skipCache>true<maven.build.cache.skipCache/>} + * * @param project - * @return */ public static boolean isSkipCache(MavenProject project) { return Boolean.parseBoolean(project.getProperties().getProperty(CACHE_SKIP, "false")); @@ -953,8 +953,7 @@ public static boolean isSkipCache(MavenProject project) { * Allow skipping generated sources restoration on a per-project level via a property (which defaults to true) * e.g. {@code <maven.build.cache.restoreGeneratedSources>false<maven.build.cache.restoreGeneratedSources/>}. * - * @param project - * @return + * @param project */ public static boolean isRestoreGeneratedSources(MavenProject project) { return Boolean.parseBoolean( @@ -965,8 +964,7 @@ public static boolean isRestoreGeneratedSources(MavenProject project) { * Allow skipping artifacts restoration on a per-project level via a property (which defaults to true) * e.g. {@code <maven.build.cache.restoreOnDiskArtifacts>false<maven.build.cache.restoreOnDiskArtifacts/>}. * - * @param project - * @return + * @param project */ public static boolean isRestoreOnDiskArtifacts(MavenProject project) { return Boolean.parseBoolean( @@ -977,8 +975,8 @@ public static boolean isRestoreOnDiskArtifacts(MavenProject project) { * Allow disabling caching entirely on a per-project level via a property - both artifact lookup and upload * Defaults to false * {@code <maven.build.cache.enabled>false<maven.build.cache.enabled/>} + * * @param project - * @return */ public static boolean isCacheDisabled(MavenProject project) { return !Boolean.parseBoolean(project.getProperties().getProperty(CACHE_ENABLED_PROPERTY_NAME, "true")); diff --git a/src/main/java/org/apache/maven/buildcache/checksum/WalkKey.java b/src/main/java/org/apache/maven/buildcache/checksum/WalkKey.java index 5dc9463..513a29e 100644 --- a/src/main/java/org/apache/maven/buildcache/checksum/WalkKey.java +++ b/src/main/java/org/apache/maven/buildcache/checksum/WalkKey.java @@ -21,7 +21,7 @@ import java.nio.file.Path; /** - * WalkKey + * WalkKey. */ public class WalkKey { diff --git a/src/main/java/org/apache/maven/buildcache/checksum/exclude/Exclusion.java b/src/main/java/org/apache/maven/buildcache/checksum/exclude/Exclusion.java index 26988b3..880b404 100644 --- a/src/main/java/org/apache/maven/buildcache/checksum/exclude/Exclusion.java +++ b/src/main/java/org/apache/maven/buildcache/checksum/exclude/Exclusion.java @@ -30,7 +30,7 @@ public class Exclusion { /** - * Glob prefix for path matchers + * Glob prefix for path matchers. */ private static final String GLOB_PX = "glob:"; @@ -38,7 +38,7 @@ public class Exclusion { private static final String GLOB_ALL_NAMES = "*"; /** - * Default glob + * Default glob. */ private static final String DEFAULT_GLOB = GLOB_ALL_PATHS; @@ -50,17 +50,17 @@ public class Exclusion { private final EntryType entryType; /** - * Denormalization to increase pathmatching resolution speed if the glob obviously match all files + * Denormalization to increase pathmatching resolution speed if the glob obviously match all files. */ private boolean matchesAllNames; /** - * Denormalization to increase pathmatching resolution speed if the glob obviously match all paths + * Denormalization to increase pathmatching resolution speed if the glob obviously match all paths. */ private boolean matchesAllPaths; /** - * True if the configured value was already an absolute path + * True if the configured value was already an absolute path. */ private final boolean configuredAsAbsolute; @@ -114,6 +114,7 @@ public EntryType getEntryType() { /** * True if the exclusion applies to the given path (does not indicate that the path is excluded) + * * @param path a visited path * @return true if the exclusion applies to the given path */ diff --git a/src/main/java/org/apache/maven/buildcache/checksum/exclude/ExclusionResolver.java b/src/main/java/org/apache/maven/buildcache/checksum/exclude/ExclusionResolver.java index 189d310..2ad2147 100644 --- a/src/main/java/org/apache/maven/buildcache/checksum/exclude/ExclusionResolver.java +++ b/src/main/java/org/apache/maven/buildcache/checksum/exclude/ExclusionResolver.java @@ -37,8 +37,8 @@ public class ExclusionResolver { /** - * property name prefix to exclude files from input. smth like maven.build.cache.exclude.value.1 should be set in project - * props + * Property name prefix to exclude files from input. smth like maven.build.cache.exclude.value.1 should be set in project + * props. */ private static final String PROJECT_PROPERTY_EXCLUDE_PREFIX = "maven.build.cache.exclude"; @@ -48,11 +48,11 @@ public class ExclusionResolver { public static final String PROJECT_PROPERTY_EXCLUDE_MATCHER_TYPE = PROJECT_PROPERTY_EXCLUDE_PREFIX + ".matcherType"; /** - * Directories exclusions based on a glob + * Directories exclusions based on a glob. */ private final List<Exclusion> directoryExclusions = new ArrayList<>(); /** - * Files exclusions based on a glob + * Files exclusions based on a glob. */ private final List<Exclusion> filesExclusions = new ArrayList<>(); /** diff --git a/src/main/java/org/apache/maven/buildcache/hash/CloseableBuffer.java b/src/main/java/org/apache/maven/buildcache/hash/CloseableBuffer.java index 7b7c60d..950cc9d 100644 --- a/src/main/java/org/apache/maven/buildcache/hash/CloseableBuffer.java +++ b/src/main/java/org/apache/maven/buildcache/hash/CloseableBuffer.java @@ -54,7 +54,7 @@ public static CloseableBuffer mappedBuffer(FileChannel channel, MapMode mode) th private ByteBuffer buffer; /** - * Unmap only DirectByteBuffer and MappedByteBuffer + * Unmap only DirectByteBuffer and MappedByteBuffer. */ private CloseableBuffer(ByteBuffer buffer) { // Java 8: buffer.isDirect() @@ -62,7 +62,7 @@ private CloseableBuffer(ByteBuffer buffer) { } /** - * Do not use buffer after close + * Do not use buffer after close. */ public ByteBuffer getBuffer() { return buffer; @@ -131,7 +131,7 @@ public static boolean isSupported() { /** * Calling the above code in JDK9+ gives a reflection warning on stderr, * Unsafe.theUnsafe.invokeCleaner(byteBuffer) - * makes the same call, but does not print the reflection warning + * makes the same call, but does not print the reflection warning. */ @Override public boolean clean(ByteBuffer buffer) { diff --git a/src/main/java/org/apache/maven/buildcache/hash/Hash.java b/src/main/java/org/apache/maven/buildcache/hash/Hash.java index 7fc8e2a..44cd298 100644 --- a/src/main/java/org/apache/maven/buildcache/hash/Hash.java +++ b/src/main/java/org/apache/maven/buildcache/hash/Hash.java @@ -22,12 +22,12 @@ import java.nio.file.Path; /** - * Hash + * Hash. */ public class Hash { /** - * Algorithm + * Algorithm. */ public interface Algorithm { @@ -37,7 +37,7 @@ public interface Algorithm { } /** - * accumulates states and should be completed by {@link #digest()} + * Accumulates states and should be completed by {@link #digest()} */ public interface Checksum { @@ -47,7 +47,7 @@ public interface Checksum { } /** - * Factory + * Factory. */ public interface Factory { diff --git a/src/main/java/org/apache/maven/buildcache/hash/HashAlgorithm.java b/src/main/java/org/apache/maven/buildcache/hash/HashAlgorithm.java index 87d9ea0..6944f14 100644 --- a/src/main/java/org/apache/maven/buildcache/hash/HashAlgorithm.java +++ b/src/main/java/org/apache/maven/buildcache/hash/HashAlgorithm.java @@ -22,7 +22,7 @@ import java.nio.file.Path; /** - * HashAlgorithm + * HashAlgorithm. */ public class HashAlgorithm { diff --git a/src/main/java/org/apache/maven/buildcache/hash/HashChecksum.java b/src/main/java/org/apache/maven/buildcache/hash/HashChecksum.java index ce74f7a..8373c32 100644 --- a/src/main/java/org/apache/maven/buildcache/hash/HashChecksum.java +++ b/src/main/java/org/apache/maven/buildcache/hash/HashChecksum.java @@ -22,7 +22,7 @@ import java.nio.file.Path; /** - * HashChecksum + * HashChecksum. */ public class HashChecksum { diff --git a/src/main/java/org/apache/maven/buildcache/hash/HashFactory.java b/src/main/java/org/apache/maven/buildcache/hash/HashFactory.java index 731480a..1bc4943 100644 --- a/src/main/java/org/apache/maven/buildcache/hash/HashFactory.java +++ b/src/main/java/org/apache/maven/buildcache/hash/HashFactory.java @@ -25,7 +25,7 @@ import net.openhft.hashing.LongHashFunction; /** - * HashFactory + * HashFactory. */ public enum HashFactory { SHA1(new SHA("SHA-1")), diff --git a/src/main/java/org/apache/maven/buildcache/hash/HexUtils.java b/src/main/java/org/apache/maven/buildcache/hash/HexUtils.java index 1e38b90..ef6f134 100644 --- a/src/main/java/org/apache/maven/buildcache/hash/HexUtils.java +++ b/src/main/java/org/apache/maven/buildcache/hash/HexUtils.java @@ -21,7 +21,7 @@ import java.nio.charset.StandardCharsets; /** - * HexUtils + * HexUtils. */ @SuppressWarnings("checkstyle:MagicNumber") public class HexUtils { diff --git a/src/main/java/org/apache/maven/buildcache/hash/ReflectionUtils.java b/src/main/java/org/apache/maven/buildcache/hash/ReflectionUtils.java index 74c4614..0fca539 100644 --- a/src/main/java/org/apache/maven/buildcache/hash/ReflectionUtils.java +++ b/src/main/java/org/apache/maven/buildcache/hash/ReflectionUtils.java @@ -22,7 +22,7 @@ import java.lang.reflect.Method; /** - * ReflectionUtils + * ReflectionUtils. */ class ReflectionUtils { diff --git a/src/main/java/org/apache/maven/buildcache/hash/SHA.java b/src/main/java/org/apache/maven/buildcache/hash/SHA.java index 38d8b2d..4fcfdd0 100644 --- a/src/main/java/org/apache/maven/buildcache/hash/SHA.java +++ b/src/main/java/org/apache/maven/buildcache/hash/SHA.java @@ -24,7 +24,7 @@ import java.security.MessageDigest; /** - * SHA + * SHA. */ public class SHA implements Hash.Factory { diff --git a/src/main/java/org/apache/maven/buildcache/hash/ThreadLocalBuffer.java b/src/main/java/org/apache/maven/buildcache/hash/ThreadLocalBuffer.java index 1ba19ec..3f825b1 100644 --- a/src/main/java/org/apache/maven/buildcache/hash/ThreadLocalBuffer.java +++ b/src/main/java/org/apache/maven/buildcache/hash/ThreadLocalBuffer.java @@ -23,7 +23,7 @@ import java.util.concurrent.ConcurrentMap; /** - * ThreadLocalBuffer + * ThreadLocalBuffer. */ public class ThreadLocalBuffer { diff --git a/src/main/java/org/apache/maven/buildcache/hash/ThreadLocalDigest.java b/src/main/java/org/apache/maven/buildcache/hash/ThreadLocalDigest.java index 9414093..6ecee43 100644 --- a/src/main/java/org/apache/maven/buildcache/hash/ThreadLocalDigest.java +++ b/src/main/java/org/apache/maven/buildcache/hash/ThreadLocalDigest.java @@ -23,7 +23,7 @@ import java.util.Objects; /** - * ThreadLocalDigest + * ThreadLocalDigest. */ public class ThreadLocalDigest { diff --git a/src/main/java/org/apache/maven/buildcache/hash/Zah.java b/src/main/java/org/apache/maven/buildcache/hash/Zah.java index befea77..99c36ad 100644 --- a/src/main/java/org/apache/maven/buildcache/hash/Zah.java +++ b/src/main/java/org/apache/maven/buildcache/hash/Zah.java @@ -30,7 +30,7 @@ import static java.nio.file.StandardOpenOption.READ; /** - * Zero-Allocation-Hash based factory + * Zero-Allocation-Hash based factory. */ public class Zah implements Hash.Factory { diff --git a/src/main/java/org/apache/maven/buildcache/xml/Build.java b/src/main/java/org/apache/maven/buildcache/xml/Build.java index abc391a..c1487a6 100644 --- a/src/main/java/org/apache/maven/buildcache/xml/Build.java +++ b/src/main/java/org/apache/maven/buildcache/xml/Build.java @@ -42,7 +42,7 @@ import static org.apache.maven.buildcache.CacheUtils.mojoExecutionKey; /** - * Build + * Build. */ public class Build { diff --git a/src/main/java/org/apache/maven/buildcache/xml/CacheConfig.java b/src/main/java/org/apache/maven/buildcache/xml/CacheConfig.java index 452dcfb..8617633 100644 --- a/src/main/java/org/apache/maven/buildcache/xml/CacheConfig.java +++ b/src/main/java/org/apache/maven/buildcache/xml/CacheConfig.java @@ -37,7 +37,7 @@ import org.apache.maven.plugin.MojoExecution; /** - * A java interface to the information configured in the maven-build-cache-config.xml file + * A java interface to the information configured in the maven-build-cache-config.xml file. */ public interface CacheConfig { @@ -134,24 +134,24 @@ public interface CacheConfig { /** * Flag to restore (default) or not generated sources as it might be desired to disable it in continuous integration - * scenarios + * scenarios. */ boolean isRestoreGeneratedSources(); /** - * Flag to restore (default) or not generated artifacts + * Flag to restore (default) or not generated artifacts. */ boolean isRestoreOnDiskArtifacts(); String getAlwaysRunPlugins(); /** - * Flag to disable cache saving + * Flag to disable cache saving. */ boolean isSkipSave(); /** - * Flag to save in cache only if a build went through the clean lifecycle + * Flag to save in cache only if a build went through the clean lifecycle. */ boolean isMandatoryClean(); @@ -162,7 +162,7 @@ public interface CacheConfig { * <p> * Use: -Dmaven.build.cache.cacheCompile=(true|false) * <p> - * Default: true + * Default: true. */ boolean isCacheCompile(); } diff --git a/src/main/java/org/apache/maven/buildcache/xml/CacheConfigImpl.java b/src/main/java/org/apache/maven/buildcache/xml/CacheConfigImpl.java index 7d7b91e..5d50338 100644 --- a/src/main/java/org/apache/maven/buildcache/xml/CacheConfigImpl.java +++ b/src/main/java/org/apache/maven/buildcache/xml/CacheConfigImpl.java @@ -75,7 +75,7 @@ import static org.apache.maven.buildcache.CacheUtils.getMultimoduleRoot; /** - * CacheConfigImpl + * CacheConfigImpl. */ @SessionScoped @Named @@ -110,7 +110,7 @@ public class CacheConfigImpl implements org.apache.maven.buildcache.xml.CacheCon public static final String CACHE_SKIP = "maven.build.cache.skipCache"; /** - * Flag to disable cache saving + * Flag to disable cache saving. */ public static final String SKIP_SAVE = "maven.build.cache.skipSave"; diff --git a/src/main/java/org/apache/maven/buildcache/xml/CacheSource.java b/src/main/java/org/apache/maven/buildcache/xml/CacheSource.java index 5cf101f..40a928b 100644 --- a/src/main/java/org/apache/maven/buildcache/xml/CacheSource.java +++ b/src/main/java/org/apache/maven/buildcache/xml/CacheSource.java @@ -19,7 +19,7 @@ package org.apache.maven.buildcache.xml; /** - * CacheSource + * CacheSource. */ public enum CacheSource { LOCAL, diff --git a/src/main/java/org/apache/maven/buildcache/xml/CacheState.java b/src/main/java/org/apache/maven/buildcache/xml/CacheState.java index 6600f79..c3454b9 100644 --- a/src/main/java/org/apache/maven/buildcache/xml/CacheState.java +++ b/src/main/java/org/apache/maven/buildcache/xml/CacheState.java @@ -19,7 +19,7 @@ package org.apache.maven.buildcache.xml; /** - * CacheState + * CacheState. */ public enum CacheState { DISABLED, diff --git a/src/main/java/org/apache/maven/buildcache/xml/DtoUtils.java b/src/main/java/org/apache/maven/buildcache/xml/DtoUtils.java index 3c8b3a7..783f8d2 100644 --- a/src/main/java/org/apache/maven/buildcache/xml/DtoUtils.java +++ b/src/main/java/org/apache/maven/buildcache/xml/DtoUtils.java @@ -37,7 +37,7 @@ import static org.apache.maven.buildcache.checksum.KeyUtils.getArtifactKey; /** - * DtoUtils + * DtoUtils. */ public class DtoUtils { @@ -122,11 +122,11 @@ public static void addProperty( } /** - * Checks that all tracked (for reconciliation purposes) properties present in cached build record + * Checks that all tracked (for reconciliation purposes) properties present in cached build record. * - * @param cachedExecution mojo execution record (from cache) - * @param trackedProperties list of tracked properties (from config) - * @return true if all tracked properties are listed in the cache record + * @param cachedExecution mojo execution record (from cache) + * @param trackedProperties list of tracked properties (from config) + * @return true if all tracked properties are listed in the cache record */ public static boolean containsAllProperties( @Nonnull CompletedExecution cachedExecution, List<TrackedProperty> trackedProperties) { diff --git a/src/main/java/org/apache/maven/buildcache/xml/XmlService.java b/src/main/java/org/apache/maven/buildcache/xml/XmlService.java index eaba25e..5e580b7 100644 --- a/src/main/java/org/apache/maven/buildcache/xml/XmlService.java +++ b/src/main/java/org/apache/maven/buildcache/xml/XmlService.java @@ -43,7 +43,7 @@ import org.codehaus.plexus.util.xml.pull.XmlPullParserException; /** - * XmlService + * XmlService. */ @Singleton @Named
