SAMZA-712: Fix javadoc warnings
authorJózsef Márton Jung <j.jung@levi9.com>
Mon, 22 Jun 2015 22:45:11 +0000 (15:45 -0700)
committerYi Pan (Data Infrastructure) <yipan@linkedin.com>
Mon, 22 Jun 2015 22:45:11 +0000 (15:45 -0700)
samza-api/src/main/java/org/apache/samza/task/TaskContext.java
samza-log4j/src/main/java/org/apache/samza/logging/log4j/serializers/LoggingEventJsonSerde.java

index 5b337a6..a85e0b4 100644 (file)
@@ -48,6 +48,10 @@ public interface TaskContext {
    * will have no effect.
    *
    * NOTE: this feature is experimental, and the API may change in a future release.
+   *
+   * @param ssp {@link org.apache.samza.system.SystemStreamPartition} whose offset should be set
+   * @param offset to set for the given {@link org.apache.samza.system.SystemStreamPartition}
+   *
    */
   void setStartingOffset(SystemStreamPartition ssp, String offset);
 }
index fd1c476..cbf552c 100644 (file)
@@ -153,6 +153,11 @@ public class LoggingEventJsonSerde implements Serde<LoggingEvent> {
 
   /**
    * This method is not currently implemented.
+   *
+   * @param loggingEventMap a map of logging events
+   *
+   * @return {@link LoggingEvent} decoded from the given logging event map.<br>
+   *     Currently it throws an {@link UnsupportedOperationException} as the method is not implemented yet!
    */
   public static LoggingEvent decodeFromMap(Map<String, Object> loggingEventMap) {
     throw new UnsupportedOperationException("Unable to decode LoggingEvents.");