You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@samza.apache.org by sh...@apache.org on 2019/11/14 01:04:57 UTC
[samza] branch master updated: Fixed javadoc compilation warnings
(api, sql-shell, yarn) (#1206)
This is an automated email from the ASF dual-hosted git repository.
shanthoosh pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/samza.git
The following commit(s) were added to refs/heads/master by this push:
new fa873bf Fixed javadoc compilation warnings (api, sql-shell, yarn) (#1206)
fa873bf is described below
commit fa873bf324d8d5a434cf7a53bb1a201046ac5a0a
Author: micpod <57...@users.noreply.github.com>
AuthorDate: Thu Nov 14 02:04:50 2019 +0100
Fixed javadoc compilation warnings (api, sql-shell, yarn) (#1206)
---
.../java/org/apache/samza/sql/schema/SqlFieldSchema.java | 4 +---
.../java/org/apache/samza/startpoint/StartpointVisitor.java | 8 ++++----
.../java/org/apache/samza/sql/client/cli/CliCommand.java | 8 ++++----
.../samza/sql/client/exceptions/CommandHandlerException.java | 8 ++++----
.../org/apache/samza/sql/client/impl/CliCommandHandler.java | 12 ++++++------
.../apache/samza/sql/client/interfaces/CommandHandler.java | 12 ++++++------
.../main/java/org/apache/samza/sql/client/util/CliUtil.java | 6 +++---
.../apache/samza/job/yarn/YarnClusterResourceManager.java | 8 ++++----
8 files changed, 32 insertions(+), 34 deletions(-)
diff --git a/samza-api/src/main/java/org/apache/samza/sql/schema/SqlFieldSchema.java b/samza-api/src/main/java/org/apache/samza/sql/schema/SqlFieldSchema.java
index 7c4fd32..7c3c281 100644
--- a/samza-api/src/main/java/org/apache/samza/sql/schema/SqlFieldSchema.java
+++ b/samza-api/src/main/java/org/apache/samza/sql/schema/SqlFieldSchema.java
@@ -51,7 +51,6 @@ public class SqlFieldSchema {
/**
* Create a primitive field schema.
* @param typeName
- * @return
*/
public static SqlFieldSchema createPrimitiveSchema(SamzaSqlFieldType typeName, boolean isNullable,
boolean isOptional) {
@@ -80,8 +79,7 @@ public class SqlFieldSchema {
}
/**
- * Get teh Type of the Samza SQL Field.
- * @return
+ * Get the Type of the Samza SQL Field.
*/
public SamzaSqlFieldType getFieldType() {
return fieldType;
diff --git a/samza-api/src/main/java/org/apache/samza/startpoint/StartpointVisitor.java b/samza-api/src/main/java/org/apache/samza/startpoint/StartpointVisitor.java
index 72b1552..2b48ba4 100644
--- a/samza-api/src/main/java/org/apache/samza/startpoint/StartpointVisitor.java
+++ b/samza-api/src/main/java/org/apache/samza/startpoint/StartpointVisitor.java
@@ -28,7 +28,7 @@ import org.apache.samza.system.SystemAdmin;
public interface StartpointVisitor<IN, OUT> {
/**
- * Performs a sequence of operations using the {@link IN} and {@link StartpointSpecific} and returns the result of the execution.
+ * Performs a sequence of operations using IN and {@link StartpointSpecific} and returns the result of the execution.
* @param input the input metadata about the startpoint.
* @param startpointSpecific the {@link Startpoint} that represents the specific offset.
* @return the result of executing the operations defined by the visit method.
@@ -38,7 +38,7 @@ public interface StartpointVisitor<IN, OUT> {
}
/**
- * Performs a sequence of operations using the {@link IN} and {@link StartpointTimestamp} and returns the result of the execution.
+ * Performs a sequence of operations using IN and {@link StartpointTimestamp} and returns the result of the execution.
* @param input the input metadata about the startpoint.
* @param startpointTimestamp the {@link Startpoint} that represents the timestamp.
* @return the result of executing the operations defined by the visit method.
@@ -48,7 +48,7 @@ public interface StartpointVisitor<IN, OUT> {
}
/**
- * Performs a sequence of operations using the {@link IN} and {@link StartpointOldest} and returns the result of the execution.
+ * Performs a sequence of operations using IN and {@link StartpointOldest} and returns the result of the execution.
* @param input the input metadata about the startpoint.
* @param startpointOldest the {@link Startpoint} that represents the earliest offset.
* @return the result of executing the operations defined by the visit method.
@@ -58,7 +58,7 @@ public interface StartpointVisitor<IN, OUT> {
}
/**
- * Performs a sequence of operations using the {@link IN} and {@link StartpointUpcoming} and returns the result of the execution.
+ * Performs a sequence of operations using IN and {@link StartpointUpcoming} and returns the result of the execution.
* @param input the input metadata about the startpoint.
* @param startpointUpcoming the {@link Startpoint} that represents the latest offset.
* @return the result of executing the operations defined by the visit method.
diff --git a/samza-sql-shell/src/main/java/org/apache/samza/sql/client/cli/CliCommand.java b/samza-sql-shell/src/main/java/org/apache/samza/sql/client/cli/CliCommand.java
index 5dc12a6..770e2c3 100755
--- a/samza-sql-shell/src/main/java/org/apache/samza/sql/client/cli/CliCommand.java
+++ b/samza-sql-shell/src/main/java/org/apache/samza/sql/client/cli/CliCommand.java
@@ -30,7 +30,7 @@ public class CliCommand {
/**
* Constructor with empty parameters
- * @param cmdType: the given {@link CommandType}
+ * @param cmdType the given {@link CommandType}
*/
public CliCommand(CommandType cmdType) {
this.commandType = cmdType;
@@ -38,8 +38,8 @@ public class CliCommand {
/**
* Constructor using both {@link CommandType} and parameters
- * @param cmdType: the given {@link CommandType}
- * @param parameters: the parameters as single String
+ * @param cmdType the given {@link CommandType}
+ * @param parameters the parameters as single String
*/
public CliCommand(CommandType cmdType, String parameters) {
this(cmdType);
@@ -63,7 +63,7 @@ public class CliCommand {
/**
* Sets the parameters of this command
- * @param parameters: input parameters
+ * @param parameters input parameters
*/
public void setParameters(String parameters) {
this.parameters = parameters;
diff --git a/samza-sql-shell/src/main/java/org/apache/samza/sql/client/exceptions/CommandHandlerException.java b/samza-sql-shell/src/main/java/org/apache/samza/sql/client/exceptions/CommandHandlerException.java
index 2ad1af2..fa9f5ae 100644
--- a/samza-sql-shell/src/main/java/org/apache/samza/sql/client/exceptions/CommandHandlerException.java
+++ b/samza-sql-shell/src/main/java/org/apache/samza/sql/client/exceptions/CommandHandlerException.java
@@ -32,7 +32,7 @@ public class CommandHandlerException extends Exception {
/**
* creates instance given error message
- * @param message: error message
+ * @param message error message
*/
public CommandHandlerException(String message) {
super(message);
@@ -40,8 +40,8 @@ public class CommandHandlerException extends Exception {
/**
* creates instance given error message and {@link Throwable} cause
- * @param message: error message
- * @param cause: throwable cause
+ * @param message error message
+ * @param cause throwable cause
*/
public CommandHandlerException(String message, Throwable cause) {
super(message, cause);
@@ -49,7 +49,7 @@ public class CommandHandlerException extends Exception {
/**
* creates instance given {@link Throwable} cause
- * @param cause: throwable case
+ * @param cause throwable case
*/
public CommandHandlerException(Throwable cause) {
super(cause);
diff --git a/samza-sql-shell/src/main/java/org/apache/samza/sql/client/impl/CliCommandHandler.java b/samza-sql-shell/src/main/java/org/apache/samza/sql/client/impl/CliCommandHandler.java
index c18c637..4a89601 100644
--- a/samza-sql-shell/src/main/java/org/apache/samza/sql/client/impl/CliCommandHandler.java
+++ b/samza-sql-shell/src/main/java/org/apache/samza/sql/client/impl/CliCommandHandler.java
@@ -71,10 +71,10 @@ public class CliCommandHandler implements CommandHandler {
/**
* sets up the member variables
- * @param shell: the {@link CliShell} which uses this CommandHandler
- * @param env: the Shell's {@link CliEnvironment}
- * @param terminal: the {@link Terminal} to print output and messages
- * @param exeContext: the {@link ExecutionContext}
+ * @param shell the {@link CliShell} which uses this CommandHandler
+ * @param env the Shell's {@link CliEnvironment}
+ * @param terminal the {@link Terminal} to print output and messages
+ * @param exeContext the {@link ExecutionContext}
*/
public void init(CliShell shell, CliEnvironment env, Terminal terminal, ExecutionContext exeContext) {
this.env = env;
@@ -88,7 +88,7 @@ public class CliCommandHandler implements CommandHandler {
/**
* Attempts to parse the given input string line into a {@link CliCommand} of this
* handler's {@link org.apache.samza.sql.client.interfaces.CommandType}
- * @param line: input line string
+ * @param line input line string
* @return {@link CliCommand} on success, null otherwise
*/
public CliCommand parseLine(String line) {
@@ -142,7 +142,7 @@ public class CliCommandHandler implements CommandHandler {
/**
* Handles the given command
- * @param command: input {@link CliCommand} to handle
+ * @param command input {@link CliCommand} to handle
* @return false if command is to quit, or fatal error happened that Shell should not continue running. True o.w.
* @throws CommandHandlerException if unrecoverable error happened while handling the input {@link CliCommand}
*/
diff --git a/samza-sql-shell/src/main/java/org/apache/samza/sql/client/interfaces/CommandHandler.java b/samza-sql-shell/src/main/java/org/apache/samza/sql/client/interfaces/CommandHandler.java
index 0d30256..80e92c5 100644
--- a/samza-sql-shell/src/main/java/org/apache/samza/sql/client/interfaces/CommandHandler.java
+++ b/samza-sql-shell/src/main/java/org/apache/samza/sql/client/interfaces/CommandHandler.java
@@ -32,23 +32,23 @@ import org.jline.terminal.Terminal;
public interface CommandHandler {
/**
* sets-up the member variables
- * @param shell: the {@link CliShell} which uses this CommandHandler
- * @param env: the Shell's {@link CliEnvironment}
- * @param terminal: the {@link Terminal} to print output and messages
- * @param exeContext: the {@link ExecutionContext}
+ * @param shell the {@link CliShell} which uses this CommandHandler
+ * @param env the Shell's {@link CliEnvironment}
+ * @param terminal the {@link Terminal} to print output and messages
+ * @param exeContext the {@link ExecutionContext}
*/
void init(CliShell shell, CliEnvironment env, Terminal terminal, ExecutionContext exeContext);
/**
* Attempts to parse the given input string line into a {@link CliCommand} of this handler's {@link CommandType}
- * @param line: input line string
+ * @param line input line string
* @return {@link CliCommand} on success, null otherwise
*/
CliCommand parseLine(String line);
/**
* Handles the given command
- * @param command: input {@link CliCommand} to handle
+ * @param command input {@link CliCommand} to handle
* @return false if command is to quit, or fatal error happened that Shell should not continue running. True o.w.
* @throws CommandHandlerException if unrecoverable error happened
*/
diff --git a/samza-sql-shell/src/main/java/org/apache/samza/sql/client/util/CliUtil.java b/samza-sql-shell/src/main/java/org/apache/samza/sql/client/util/CliUtil.java
index f2af57c..c9373dd 100755
--- a/samza-sql-shell/src/main/java/org/apache/samza/sql/client/util/CliUtil.java
+++ b/samza-sql-shell/src/main/java/org/apache/samza/sql/client/util/CliUtil.java
@@ -46,7 +46,7 @@ public class CliUtil {
/**
* Trims: leading spaces; trailing spaces and ";"s
- * @param command: input String to trim
+ * @param command input String to trim
* @return trimmed String
*/
public static String trimCommand(String command) {
@@ -68,8 +68,8 @@ public class CliUtil {
/**
* Prints to input {@link PrintWriter} the usage string of the input {@link CliCommand}
- * @param command: command to get its usage string
- * @param writer: where to print usage
+ * @param command command to get its usage string
+ * @param writer where to print usage
*/
public static void printCommandUsage(CliCommand command, PrintWriter writer) {
writer.println(command.getCommandType().getUsage());
diff --git a/samza-yarn/src/main/java/org/apache/samza/job/yarn/YarnClusterResourceManager.java b/samza-yarn/src/main/java/org/apache/samza/job/yarn/YarnClusterResourceManager.java
index 14cb68f..43c49cc 100644
--- a/samza-yarn/src/main/java/org/apache/samza/job/yarn/YarnClusterResourceManager.java
+++ b/samza-yarn/src/main/java/org/apache/samza/job/yarn/YarnClusterResourceManager.java
@@ -292,8 +292,8 @@ public class YarnClusterResourceManager extends ClusterResourceManager implement
/**
*
* Requests the launch of a StreamProcessor with the specified ID on the resource
- * @param resource , the SamzaResource on which to launch the StreamProcessor
- * @param builder, the builder to build the resource launch command from
+ * @param resource the SamzaResource on which to launch the StreamProcessor
+ * @param builder the builder to build the resource launch command from
*
* TODO: Support non-builder methods to launch resources. Maybe, refactor into a ContainerLaunchStrategy interface
*/
@@ -498,8 +498,8 @@ public class YarnClusterResourceManager extends ClusterResourceManager implement
}
/**
- * Callback invoked when there is an error in the Yarn client. This delegates the
- * callback handling to the {@link ClusterResourceManager.Callback} instance.
+ * Callback invoked when there is an error in the Yarn client. This delegates the callback handling to
+ * the {@link org.apache.samza.clustermanager.ClusterResourceManager.Callback} instance.
*
*/
@Override