[HDFS-15428] Javadocs fails for hadoop-federation-balance

• Type: Sub-task
• Status: Resolved
• Priority: Minor
• Resolution: Fixed
• Fix Version/s: 3.4.0
• Component/s: documentation
• Hadoop Flags: Reviewed
• Assignee: Xieming Li
• Reporter: Xieming Li
• Created: 22/Jun/20 02:24
• Updated: 22/Jun/20 11:30
• Resolved: 22/Jun/20 11:14

Description

javadoc fails for hadoop-federation-balance

[ERROR] Failed to execute goal org.apache.maven.plugins:maven-javadoc-plugin:3.0.1:jar (module-javadocs) on project hadoop-federation-balance: MavenReportException: Error while generating Javadoc:
[ERROR] Exit code: 1 - /Users/sri/projects/hadoop-mirror/hadoop-tools/hadoop-federation-balance/src/main/java/org/apache/hadoop/tools/fedbalance/procedure/BalanceProcedure.java:124: warning: no @throws for java.io.IOException
[ERROR]   public abstract boolean execute() throws RetryException, IOException;
[ERROR]                           ^
[ERROR] /Users/sri/projects/hadoop-mirror/hadoop-tools/hadoop-federation-balance/src/main/java/org/apache/hadoop/tools/fedbalance/procedure/BalanceProcedure.java:129: warning: no @return
[ERROR]   public long delayMillisBeforeRetry() {
[ERROR]               ^
[ERROR] /Users/sri/projects/hadoop-mirror/hadoop-tools/hadoop-federation-balance/src/main/java/org/apache/hadoop/tools/fedbalance/procedure/BalanceProcedure.java:136: warning: no @return
[ERROR]   protected boolean isSchedulerShutdown() {
[ERROR]                     ^
[ERROR] /Users/sri/projects/hadoop-mirror/hadoop-tools/hadoop-federation-balance/src/main/java/org/apache/hadoop/tools/fedbalance/procedure/BalanceProcedure.java:151: warning: no @return
[ERROR]   public String nextProcedure() {
[ERROR]                 ^
[ERROR] /Users/sri/projects/hadoop-mirror/hadoop-tools/hadoop-federation-balance/src/main/java/org/apache/hadoop/tools/fedbalance/procedure/BalanceProcedure.java:158: warning: no @return
[ERROR]   public String name() {
[ERROR]                 ^
[ERROR] /Users/sri/projects/hadoop-mirror/hadoop-tools/hadoop-federation-balance/src/main/java/org/apache/hadoop/tools/fedbalance/DistCpProcedure.java:124: warning: no @throws for java.io.IOException
[ERROR]   public DistCpProcedure(String name, String nextProcedure, long delayDuration,
[ERROR]          ^
[ERROR] /Users/sri/projects/hadoop-mirror/hadoop-tools/hadoop-federation-balance/src/main/java/org/apache/hadoop/tools/fedbalance/MountTableProcedure.java:46: error: bad use of '>'
[ERROR]  *   /a/b/c -> {ns:src path:/a/b/c}
[ERROR]              ^
[ERROR] /Users/sri/projects/hadoop-mirror/hadoop-tools/hadoop-federation-balance/src/main/java/org/apache/hadoop/tools/fedbalance/MountTableProcedure.java:48: error: bad use of '>'
[ERROR]  *   /a/b/c -> {ns:dst path:/a/b/c}
[ERROR]              ^
[ERROR] /Users/sri/projects/hadoop-mirror/hadoop-tools/hadoop-federation-balance/src/main/java/org/apache/hadoop/tools/fedbalance/MountTableProcedure.java:66: warning: no @param for name
[ERROR]   public MountTableProcedure(String name, String nextProcedure,
[ERROR]          ^
[ERROR] /Users/sri/projects/hadoop-mirror/hadoop-tools/hadoop-federation-balance/src/main/java/org/apache/hadoop/tools/fedbalance/MountTableProcedure.java:66: warning: no @param for nextProcedure
[ERROR]   public MountTableProcedure(String name, String nextProcedure,
[ERROR]          ^
[ERROR] /Users/sri/projects/hadoop-mirror/hadoop-tools/hadoop-federation-balance/src/main/java/org/apache/hadoop/tools/fedbalance/MountTableProcedure.java:66: warning: no @param for delayDuration
[ERROR]   public MountTableProcedure(String name, String nextProcedure,
[ERROR]          ^
[ERROR] /Users/sri/projects/hadoop-mirror/hadoop-tools/hadoop-federation-balance/src/main/java/org/apache/hadoop/tools/fedbalance/MountTableProcedure.java:66: warning: no @param for dstNs
[ERROR]   public MountTableProcedure(String name, String nextProcedure,
[ERROR]          ^
[ERROR] /Users/sri/projects/hadoop-mirror/hadoop-tools/hadoop-federation-balance/src/main/java/org/apache/hadoop/tools/fedbalance/MountTableProcedure.java:66: warning: no @throws for java.io.IOException
[ERROR]   public MountTableProcedure(String name, String nextProcedure,
[ERROR]          ^
[ERROR] /Users/sri/projects/hadoop-mirror/hadoop-tools/hadoop-federation-balance/src/main/java/org/apache/hadoop/tools/fedbalance/TrashProcedure.java:52: warning: no @throws for java.io.IOException
[ERROR]   public TrashProcedure(String name, String nextProcedure, long delayDuration,
[ERROR]          ^
[ERROR] /Users/sri/projects/hadoop-mirror/hadoop-tools/hadoop-federation-balance/src/main/java/org/apache/hadoop/tools/fedbalance/procedure/BalanceJob.java:186: warning: no @return
[ERROR]   public String getId() {
[ERROR]                 ^
[ERROR] /Users/sri/projects/hadoop-mirror/hadoop-tools/hadoop-federation-balance/src/main/java/org/apache/hadoop/tools/fedbalance/procedure/BalanceJob.java:194: warning: no @return
[ERROR]   public boolean shouldRemoveAfterDone() {
[ERROR]                  ^
[ERROR] /Users/sri/projects/hadoop-mirror/hadoop-tools/hadoop-federation-balance/src/main/java/org/apache/hadoop/tools/fedbalance/procedure/BalanceJob.java:211: warning: no @return
[ERROR]   public boolean isJobDone() {
[ERROR]                  ^
[ERROR] /Users/sri/projects/hadoop-mirror/hadoop-tools/hadoop-federation-balance/src/main/java/org/apache/hadoop/tools/fedbalance/procedure/BalanceJob.java:218: warning: no @throws for java.lang.InterruptedException
[ERROR]   public synchronized void waitJobDone() throws InterruptedException {
[ERROR]                            ^
[ERROR] /Users/sri/projects/hadoop-mirror/hadoop-tools/hadoop-federation-balance/src/main/java/org/apache/hadoop/tools/fedbalance/procedure/BalanceJob.java:228: warning: no @return
[ERROR]   public Exception getError() {
[ERROR]                    ^
[ERROR] /Users/sri/projects/hadoop-mirror/hadoop-tools/hadoop-federation-balance/src/main/java/org/apache/hadoop/tools/fedbalance/procedure/BalanceJob.java:332: warning: no @return
[ERROR]   public String getDetailMessage() {
[ERROR]                 ^
[ERROR] /Users/sri/projects/hadoop-mirror/hadoop-tools/hadoop-federation-balance/src/main/java/org/apache/hadoop/tools/fedbalance/procedure/BalanceJob.java:71: warning: no @param for procedure
[ERROR]     public Builder nextProcedure(T procedure) {
[ERROR]                    ^
[ERROR] /Users/sri/projects/hadoop-mirror/hadoop-tools/hadoop-federation-balance/src/main/java/org/apache/hadoop/tools/fedbalance/procedure/BalanceJob.java:71: warning: no @return
[ERROR]     public Builder nextProcedure(T procedure) {
[ERROR]                    ^
[ERROR] /Users/sri/projects/hadoop-mirror/hadoop-tools/hadoop-federation-balance/src/main/java/org/apache/hadoop/tools/fedbalance/procedure/BalanceJob.java:85: warning: no @param for remove
[ERROR]     public Builder removeAfterDone(boolean remove) {
[ERROR]                    ^
[ERROR] /Users/sri/projects/hadoop-mirror/hadoop-tools/hadoop-federation-balance/src/main/java/org/apache/hadoop/tools/fedbalance/procedure/BalanceJob.java:85: warning: no @return
[ERROR]     public Builder removeAfterDone(boolean remove) {
[ERROR]                    ^
[ERROR] /Users/sri/projects/hadoop-mirror/hadoop-tools/hadoop-federation-balance/src/main/java/org/apache/hadoop/tools/fedbalance/procedure/BalanceJournal.java:32: warning: no @param for job
[ERROR]   void saveJob(BalanceJob job) throws IOException;
[ERROR]        ^
[ERROR] /Users/sri/projects/hadoop-mirror/hadoop-tools/hadoop-federation-balance/src/main/java/org/apache/hadoop/tools/fedbalance/procedure/BalanceJournal.java:32: warning: no @throws for java.io.IOException
[ERROR]   void saveJob(BalanceJob job) throws IOException;
[ERROR]        ^
[ERROR] /Users/sri/projects/hadoop-mirror/hadoop-tools/hadoop-federation-balance/src/main/java/org/apache/hadoop/tools/fedbalance/procedure/BalanceJournal.java:37: warning: no @param for job
[ERROR]   void recoverJob(BalanceJob job) throws IOException;
[ERROR]        ^
[ERROR] /Users/sri/projects/hadoop-mirror/hadoop-tools/hadoop-federation-balance/src/main/java/org/apache/hadoop/tools/fedbalance/procedure/BalanceJournal.java:37: warning: no @throws for java.io.IOException
[ERROR]   void recoverJob(BalanceJob job) throws IOException;
[ERROR]        ^
[ERROR] /Users/sri/projects/hadoop-mirror/hadoop-tools/hadoop-federation-balance/src/main/java/org/apache/hadoop/tools/fedbalance/procedure/BalanceJournal.java:42: warning: no @return
[ERROR]   BalanceJob[] listAllJobs() throws IOException;
[ERROR]                ^
[ERROR] /Users/sri/projects/hadoop-mirror/hadoop-tools/hadoop-federation-balance/src/main/java/org/apache/hadoop/tools/fedbalance/procedure/BalanceJournal.java:42: warning: no @throws for java.io.IOException
[ERROR]   BalanceJob[] listAllJobs() throws IOException;
[ERROR]                ^
[ERROR] /Users/sri/projects/hadoop-mirror/hadoop-tools/hadoop-federation-balance/src/main/java/org/apache/hadoop/tools/fedbalance/procedure/BalanceJournal.java:47: warning: no @param for job
[ERROR]   void clear(BalanceJob job) throws IOException;
[ERROR]        ^
[ERROR] /Users/sri/projects/hadoop-mirror/hadoop-tools/hadoop-federation-balance/src/main/java/org/apache/hadoop/tools/fedbalance/procedure/BalanceJournal.java:47: warning: no @throws for java.io.IOException
[ERROR]   void clear(BalanceJob job) throws IOException;
[ERROR]        ^
[ERROR] /Users/sri/projects/hadoop-mirror/hadoop-tools/hadoop-federation-balance/src/main/java/org/apache/hadoop/tools/fedbalance/procedure/BalanceProcedureScheduler.java:96: warning: no @throws for java.io.IOException
[ERROR]   public synchronized void init(boolean recoverJobs) throws IOException {
[ERROR]                            ^
[ERROR] /Users/sri/projects/hadoop-mirror/hadoop-tools/hadoop-federation-balance/src/main/java/org/apache/hadoop/tools/fedbalance/procedure/BalanceProcedureScheduler.java:128: warning: no @param for job
[ERROR]   public synchronized void submit(BalanceJob job) throws IOException {
[ERROR]                            ^
[ERROR] /Users/sri/projects/hadoop-mirror/hadoop-tools/hadoop-federation-balance/src/main/java/org/apache/hadoop/tools/fedbalance/procedure/BalanceProcedureScheduler.java:128: warning: no @throws for java.io.IOException
[ERROR]   public synchronized void submit(BalanceJob job) throws IOException {
[ERROR]                            ^
[ERROR] /Users/sri/projects/hadoop-mirror/hadoop-tools/hadoop-federation-balance/src/main/java/org/apache/hadoop/tools/fedbalance/procedure/BalanceProcedureScheduler.java:144: warning: no @param for job
[ERROR]   public BalanceJob remove(BalanceJob job) {
[ERROR]                     ^
[ERROR] /Users/sri/projects/hadoop-mirror/hadoop-tools/hadoop-federation-balance/src/main/java/org/apache/hadoop/tools/fedbalance/procedure/BalanceProcedureScheduler.java:144: warning: no @return
[ERROR]   public BalanceJob remove(BalanceJob job) {
[ERROR]                     ^
[ERROR] /Users/sri/projects/hadoop-mirror/hadoop-tools/hadoop-federation-balance/src/main/java/org/apache/hadoop/tools/fedbalance/procedure/BalanceProcedureScheduler.java:162: warning: no @param for job
[ERROR]   public BalanceJob findJob(BalanceJob job) {
[ERROR]                     ^
[ERROR] /Users/sri/projects/hadoop-mirror/hadoop-tools/hadoop-federation-balance/src/main/java/org/apache/hadoop/tools/fedbalance/procedure/BalanceProcedureScheduler.java:176: warning: no @return
[ERROR]   public Collection<BalanceJob> getAllJobs() {
[ERROR]                                 ^
[ERROR] /Users/sri/projects/hadoop-mirror/hadoop-tools/hadoop-federation-balance/src/main/java/org/apache/hadoop/tools/fedbalance/procedure/BalanceProcedureScheduler.java:183: warning: no @param for job
[ERROR]   public void waitUntilDone(BalanceJob job) {
[ERROR]               ^
[ERROR] /Users/sri/projects/hadoop-mirror/hadoop-tools/hadoop-federation-balance/src/main/java/org/apache/hadoop/tools/fedbalance/procedure/BalanceProcedureScheduler.java:236: warning: no @return
[ERROR]   public boolean isRunning() {
[ERROR]                  ^
[ERROR] /Users/sri/projects/hadoop-mirror/hadoop-tools/hadoop-federation-balance/src/main/java/org/apache/hadoop/tools/fedbalance/procedure/BalanceProcedureScheduler.java:57: error: malformed HTML
[ERROR]  *   Job.Builder builder = new Job.Builder<>();
[ERROR]                                           ^
[ERROR] /Users/sri/projects/hadoop-mirror/hadoop-tools/hadoop-federation-balance/src/main/java/org/apache/hadoop/tools/fedbalance/procedure/BalanceProcedureScheduler.java:57: error: bad use of '>'
[ERROR]  *   Job.Builder builder = new Job.Builder<>();
[ERROR]                                            ^
[ERROR]
[ERROR] Command line was: /Library/Java/JavaVirtualMachines/adoptopenjdk-8.jdk/Contents/Home/jre/../bin/javadoc @options @packages
[ERROR]
[ERROR] Refer to the generated Javadoc files in '/Users/sri/projects/hadoop-mirror/hadoop-tools/hadoop-federation-balance/target/apidocs' dir.
[ERROR]
[ERROR] -> [Help 1]
[ERROR]
[ERROR] To see the full stack trace of the errors, re-run Maven with the -e switch.
[ERROR] Re-run Maven using the -X switch to enable full debug logging.
[ERROR]
[ERROR] For more information about the errors and possible solutions, please read the following articles:
[ERROR] [Help 1] http://cwiki.apache.org/confluence/display/MAVEN/MojoExecutionException
[ERROR]
[ERROR] After correcting the problems, you can resume the build with the command
[ERROR]   mvn <args> -rf :hadoop-federation-balance

Issue Links

• is broken by: HDFS-15340 RBF: Implement BalanceProcedureScheduler basic framework
• is broken by: HDFS-15346 FedBalance tool implementation