Repository: metron Updated Branches: refs/heads/master 0c20fd1a3 -> 2a1cbbbf2
METRON-1673 Fix Javadoc errors (justinleet) closes apache/metron#1107 Project: http://git-wip-us.apache.org/repos/asf/metron/repo Commit: http://git-wip-us.apache.org/repos/asf/metron/commit/2a1cbbbf Tree: http://git-wip-us.apache.org/repos/asf/metron/tree/2a1cbbbf Diff: http://git-wip-us.apache.org/repos/asf/metron/diff/2a1cbbbf Branch: refs/heads/master Commit: 2a1cbbbf2029faec0b265e83f270a31e75ef9d9a Parents: 0c20fd1 Author: justinleet <[email protected]> Authored: Tue Jul 17 09:18:08 2018 -0400 Committer: leet <[email protected]> Committed: Tue Jul 17 09:18:08 2018 -0400 ---------------------------------------------------------------------- .../metron/profiler/client/window/Window.java | 8 ++--- .../profiler/client/window/WindowProcessor.java | 35 ++++++++++++-------- .../client/window/predicates/DayPredicates.java | 2 +- .../profiler/DefaultMessageDistributor.java | 18 +++++----- .../apache/metron/rest/config/KafkaConfig.java | 4 +-- .../configuration/IndexingConfigurations.java | 2 +- .../configuration/SensorParserConfig.java | 6 ++-- .../writer/ConfigurationsStrategies.java | 2 +- .../common/performance/PerformanceLogger.java | 10 +++--- .../apache/metron/common/system/FakeClock.java | 18 +++++----- .../metron/common/utils/ReflectionUtils.java | 2 +- .../configurations/ConfigurationsUpdater.java | 1 - .../indexing/dao/metaalert/MetaAlertDao.java | 6 ++-- .../metron/writer/BulkWriterComponent.java | 24 ++++++-------- .../stellar/common/CachingStellarProcessor.java | 2 +- .../org/apache/metron/stellar/dsl/Context.java | 2 +- 16 files changed, 72 insertions(+), 70 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/metron/blob/2a1cbbbf/metron-analytics/metron-profiler-client/src/main/java/org/apache/metron/profiler/client/window/Window.java ---------------------------------------------------------------------- diff --git a/metron-analytics/metron-profiler-client/src/main/java/org/apache/metron/profiler/client/window/Window.java b/metron-analytics/metron-profiler-client/src/main/java/org/apache/metron/profiler/client/window/Window.java index 964d594..9fd6339 100644 --- a/metron-analytics/metron-profiler-client/src/main/java/org/apache/metron/profiler/client/window/Window.java +++ b/metron-analytics/metron-profiler-client/src/main/java/org/apache/metron/profiler/client/window/Window.java @@ -20,14 +20,12 @@ package org.apache.metron.profiler.client.window; import com.google.common.collect.Iterables; -import org.apache.commons.lang3.Range; - import java.util.ArrayList; import java.util.List; import java.util.Optional; import java.util.function.Function; import java.util.function.Predicate; -import java.util.stream.Stream; +import org.apache.commons.lang3.Range; /** * A window is intended to compute the set of window intervals across time based on a reference time. @@ -72,7 +70,7 @@ public class Window { * Get the set of inclusion predicates. If any of these are true as applied to the window interval start time, * then a field is included unless it's explicitly excluded. * @param now - * @return Iterable<Predicate<Long>> returns a set of inclusion predicates. If any of these are true as + * @return {@code Iterable<Predicate<Long>>} returns a set of inclusion predicates. If any of these are true as * applied to the window interval start time, then a field is included unless it's explicitly excluded */ public Iterable<Predicate<Long>> getIncludes(long now) { @@ -87,7 +85,7 @@ public class Window { * Get the set of exclusion predicates. If any of these exclusion predicates are true as applied to the window * interval start time, then the interval is excluded. NOTE: Exclusions trump inclusions. * @param now - * @return Iterable<Predicate<Long>> returns the set of exclusion predicates. If any of these exclusion + * @return {@code Iterable<Predicate<Long>>} returns the set of exclusion predicates. If any of these exclusion * predicates are true as applied to the window interval start time, then the interval is excluded. * Exclusions trump inclusions. */ http://git-wip-us.apache.org/repos/asf/metron/blob/2a1cbbbf/metron-analytics/metron-profiler-client/src/main/java/org/apache/metron/profiler/client/window/WindowProcessor.java ---------------------------------------------------------------------- diff --git a/metron-analytics/metron-profiler-client/src/main/java/org/apache/metron/profiler/client/window/WindowProcessor.java b/metron-analytics/metron-profiler-client/src/main/java/org/apache/metron/profiler/client/window/WindowProcessor.java index da4ce3c..66a4f7d 100644 --- a/metron-analytics/metron-profiler-client/src/main/java/org/apache/metron/profiler/client/window/WindowProcessor.java +++ b/metron-analytics/metron-profiler-client/src/main/java/org/apache/metron/profiler/client/window/WindowProcessor.java @@ -19,24 +19,31 @@ */ package org.apache.metron.profiler.client.window; -import org.antlr.v4.runtime.*; +import static org.apache.commons.lang3.StringUtils.isEmpty; + +import java.util.ArrayDeque; +import java.util.ArrayList; +import java.util.Deque; +import java.util.LinkedList; +import java.util.List; +import java.util.Optional; +import java.util.concurrent.TimeUnit; +import java.util.function.Function; +import java.util.function.Predicate; +import org.antlr.v4.runtime.ANTLRInputStream; +import org.antlr.v4.runtime.CommonTokenStream; +import org.antlr.v4.runtime.ParserRuleContext; +import org.antlr.v4.runtime.TokenStream; import org.antlr.v4.runtime.tree.ParseTree; -import org.apache.metron.stellar.dsl.ErrorListener; -import org.apache.metron.stellar.dsl.GrammarUtils; -import org.apache.metron.stellar.dsl.ParseException; -import org.apache.metron.stellar.dsl.Token; -import org.apache.metron.stellar.common.utils.ConversionUtils; import org.apache.metron.profiler.client.window.generated.WindowBaseListener; import org.apache.metron.profiler.client.window.generated.WindowLexer; import org.apache.metron.profiler.client.window.generated.WindowParser; import org.apache.metron.profiler.client.window.predicates.DayPredicates; - -import java.util.*; -import java.util.concurrent.TimeUnit; -import java.util.function.Function; -import java.util.function.Predicate; - -import static org.apache.commons.lang3.StringUtils.isEmpty; +import org.apache.metron.stellar.common.utils.ConversionUtils; +import org.apache.metron.stellar.dsl.ErrorListener; +import org.apache.metron.stellar.dsl.GrammarUtils; +import org.apache.metron.stellar.dsl.ParseException; +import org.apache.metron.stellar.dsl.Token; /** * The WindowProcessor instance provides the parser callbacks for the Window selector language. This constructs @@ -142,7 +149,7 @@ public class WindowProcessor extends WindowBaseListener { } /** - * Normalize the day specifier e.g. tuesdays -> tuesday and push onto the stack. + * Normalize the day specifier e.g. tuesdays -{@literal >} tuesday and push onto the stack. * @param ctx */ @Override http://git-wip-us.apache.org/repos/asf/metron/blob/2a1cbbbf/metron-analytics/metron-profiler-client/src/main/java/org/apache/metron/profiler/client/window/predicates/DayPredicates.java ---------------------------------------------------------------------- diff --git a/metron-analytics/metron-profiler-client/src/main/java/org/apache/metron/profiler/client/window/predicates/DayPredicates.java b/metron-analytics/metron-profiler-client/src/main/java/org/apache/metron/profiler/client/window/predicates/DayPredicates.java index e8b985c..2c5adb4 100644 --- a/metron-analytics/metron-profiler-client/src/main/java/org/apache/metron/profiler/client/window/predicates/DayPredicates.java +++ b/metron-analytics/metron-profiler-client/src/main/java/org/apache/metron/profiler/client/window/predicates/DayPredicates.java @@ -104,7 +104,7 @@ public enum DayPredicates { * Create a Predicate given a set of arguments. * @param name * @param arg - * @return Predicate<Long> return a Predicate given a set of arguments + * @return {@code Predicate<Long>} return a Predicate given a set of arguments */ public static Predicate<Long> create(String name, List<String> arg) { return DayPredicates.valueOf(name).predicateCreator.apply(arg); http://git-wip-us.apache.org/repos/asf/metron/blob/2a1cbbbf/metron-analytics/metron-profiler-common/src/main/java/org/apache/metron/profiler/DefaultMessageDistributor.java ---------------------------------------------------------------------- diff --git a/metron-analytics/metron-profiler-common/src/main/java/org/apache/metron/profiler/DefaultMessageDistributor.java b/metron-analytics/metron-profiler-common/src/main/java/org/apache/metron/profiler/DefaultMessageDistributor.java index 70f4228..82f7174 100644 --- a/metron-analytics/metron-profiler-common/src/main/java/org/apache/metron/profiler/DefaultMessageDistributor.java +++ b/metron-analytics/metron-profiler-common/src/main/java/org/apache/metron/profiler/DefaultMessageDistributor.java @@ -20,26 +20,25 @@ package org.apache.metron.profiler; +import static java.lang.String.format; + import com.google.common.base.Ticker; import com.google.common.cache.Cache; import com.google.common.cache.CacheBuilder; import com.google.common.cache.RemovalListener; import com.google.common.cache.RemovalNotification; -import org.apache.commons.lang.builder.HashCodeBuilder; -import org.apache.metron.common.configuration.profiler.ProfileConfig; -import org.apache.metron.stellar.dsl.Context; -import org.json.simple.JSONObject; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; - import java.lang.invoke.MethodHandles; import java.util.ArrayList; import java.util.List; import java.util.Optional; import java.util.concurrent.ExecutionException; import java.util.concurrent.TimeUnit; - -import static java.lang.String.format; +import org.apache.commons.lang.builder.HashCodeBuilder; +import org.apache.metron.common.configuration.profiler.ProfileConfig; +import org.apache.metron.stellar.dsl.Context; +import org.json.simple.JSONObject; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; /** * The default implementation of a {@link MessageDistributor}. @@ -151,7 +150,6 @@ public class DefaultMessageDistributor implements MessageDistributor { * @param timestamp The timestamp of the message. * @param route The message route. * @param context The Stellar execution context. - * @throws ExecutionException */ @Override public void distribute(JSONObject message, long timestamp, MessageRoute route, Context context) { http://git-wip-us.apache.org/repos/asf/metron/blob/2a1cbbbf/metron-interface/metron-rest/src/main/java/org/apache/metron/rest/config/KafkaConfig.java ---------------------------------------------------------------------- diff --git a/metron-interface/metron-rest/src/main/java/org/apache/metron/rest/config/KafkaConfig.java b/metron-interface/metron-rest/src/main/java/org/apache/metron/rest/config/KafkaConfig.java index 7e9b468..03db036 100644 --- a/metron-interface/metron-rest/src/main/java/org/apache/metron/rest/config/KafkaConfig.java +++ b/metron-interface/metron-rest/src/main/java/org/apache/metron/rest/config/KafkaConfig.java @@ -73,9 +73,9 @@ public class KafkaConfig { } /** - * Create properties that will be used by {@link this#createConsumerFactory()} + * Create properties that will be used by {@link org.apache.metron.rest.config.KafkaConfig#createConsumerFactory()} * - * @return Configurations used by {@link this#createConsumerFactory()}. + * @return Configurations used by {@link org.apache.metron.rest.config.KafkaConfig#createConsumerFactory()}. */ @Bean public Map<String, Object> consumerProperties() { http://git-wip-us.apache.org/repos/asf/metron/blob/2a1cbbbf/metron-platform/metron-common/src/main/java/org/apache/metron/common/configuration/IndexingConfigurations.java ---------------------------------------------------------------------- diff --git a/metron-platform/metron-common/src/main/java/org/apache/metron/common/configuration/IndexingConfigurations.java b/metron-platform/metron-common/src/main/java/org/apache/metron/common/configuration/IndexingConfigurations.java index 7ecb606..2f01884 100644 --- a/metron-platform/metron-common/src/main/java/org/apache/metron/common/configuration/IndexingConfigurations.java +++ b/metron-platform/metron-common/src/main/java/org/apache/metron/common/configuration/IndexingConfigurations.java @@ -112,7 +112,7 @@ public class IndexingConfigurations extends Configurations { /** * Returns all configured values of batchTimeout, for all configured sensors, - * but only for the specific writer identified by {@param writerName}. So, if it is + * but only for the specific writer identified by {@code writerName}. So, if it is * an hdfs writer, it will return the batchTimeouts for hdfs writers for all the sensors. * The goal is to return to a {@link org.apache.metron.common.bolt.ConfiguredBolt} * the set of all and only batchTimeouts relevant to that ConfiguredBolt. http://git-wip-us.apache.org/repos/asf/metron/blob/2a1cbbbf/metron-platform/metron-common/src/main/java/org/apache/metron/common/configuration/SensorParserConfig.java ---------------------------------------------------------------------- diff --git a/metron-platform/metron-common/src/main/java/org/apache/metron/common/configuration/SensorParserConfig.java b/metron-platform/metron-common/src/main/java/org/apache/metron/common/configuration/SensorParserConfig.java index 01630c1..4cc4e61 100644 --- a/metron-platform/metron-common/src/main/java/org/apache/metron/common/configuration/SensorParserConfig.java +++ b/metron-platform/metron-common/src/main/java/org/apache/metron/common/configuration/SensorParserConfig.java @@ -200,8 +200,10 @@ public class SensorParserConfig implements Serializable { /** * Configures the cache that backs stellar field transformations. * - * <li>stellar.cache.maxSize - The maximum number of elements in the cache. - * <li>stellar.cache.maxTimeRetain - The maximum amount of time an element is kept in the cache (in minutes). + * <ul> + * <li>stellar.cache.maxSize - The maximum number of elements in the cache. + * <li>stellar.cache.maxTimeRetain - The maximum amount of time an element is kept in the cache (in minutes). + * </ul> */ private Map<String, Object> cacheConfig = new HashMap<>(); http://git-wip-us.apache.org/repos/asf/metron/blob/2a1cbbbf/metron-platform/metron-common/src/main/java/org/apache/metron/common/configuration/writer/ConfigurationsStrategies.java ---------------------------------------------------------------------- diff --git a/metron-platform/metron-common/src/main/java/org/apache/metron/common/configuration/writer/ConfigurationsStrategies.java b/metron-platform/metron-common/src/main/java/org/apache/metron/common/configuration/writer/ConfigurationsStrategies.java index f22dd01..bafbbe1 100644 --- a/metron-platform/metron-common/src/main/java/org/apache/metron/common/configuration/writer/ConfigurationsStrategies.java +++ b/metron-platform/metron-common/src/main/java/org/apache/metron/common/configuration/writer/ConfigurationsStrategies.java @@ -134,7 +134,7 @@ public enum ConfigurationsStrategies implements ConfigurationStrategy { /** * Config updater * @param reloadable callback - * @param configSupplier Supplier provides config of type <? extends Configurations> + * @param configSupplier Supplier provides config of type {@code <? extends Configurations>} * @return Config updater */ @Override http://git-wip-us.apache.org/repos/asf/metron/blob/2a1cbbbf/metron-platform/metron-common/src/main/java/org/apache/metron/common/performance/PerformanceLogger.java ---------------------------------------------------------------------- diff --git a/metron-platform/metron-common/src/main/java/org/apache/metron/common/performance/PerformanceLogger.java b/metron-platform/metron-common/src/main/java/org/apache/metron/common/performance/PerformanceLogger.java index 61015ef..78aacd3 100644 --- a/metron-platform/metron-common/src/main/java/org/apache/metron/common/performance/PerformanceLogger.java +++ b/metron-platform/metron-common/src/main/java/org/apache/metron/common/performance/PerformanceLogger.java @@ -77,7 +77,7 @@ public class PerformanceLogger { /** * Log a message at DEBUG level for the given markName. * Warns when logging for a markName that hasn't been set. - * <p/> + * <p> * <p>This form avoids superfluous string concatenation when the logger * is disabled for the DEBUG level.</p> * @@ -92,7 +92,7 @@ public class PerformanceLogger { /** * Log a message at DEBUG level for the given markName according to the specified message. * Warns when logging for a markName that hasn't been set. - * <p/> + * <p> * <p>This form avoids superfluous string concatenation when the logger * is disabled for the DEBUG level.</p> * @@ -127,7 +127,7 @@ public class PerformanceLogger { /** * Log a message at DEBUG level for the given markName according to the specified format * and argument. Warns when logging for a markName that hasn't been set. - * <p/> + * <p> * <p>This form avoids superfluous string concatenation when the logger * is disabled for the DEBUG level.</p> * @@ -144,7 +144,7 @@ public class PerformanceLogger { /** * Log a message at DEBUG level according to the specified format and argument. - * <p/> + * <p> * <p>This form avoids superfluous string concatenation when the logger * is disabled for the DEBUG level.</p> * @@ -162,7 +162,7 @@ public class PerformanceLogger { /** * Log a message at DEBUG level according to the specified format and arguments. - * <p/> + * <p> * <p>This form avoids superfluous string concatenation when the logger * is disabled for the DEBUG level. However, this variant incurs the hidden * (and relatively small) cost of creating an <code>Object[]</code> before invoking the method, http://git-wip-us.apache.org/repos/asf/metron/blob/2a1cbbbf/metron-platform/metron-common/src/main/java/org/apache/metron/common/system/FakeClock.java ---------------------------------------------------------------------- diff --git a/metron-platform/metron-common/src/main/java/org/apache/metron/common/system/FakeClock.java b/metron-platform/metron-common/src/main/java/org/apache/metron/common/system/FakeClock.java index e34a26d..d0f9b5e 100644 --- a/metron-platform/metron-common/src/main/java/org/apache/metron/common/system/FakeClock.java +++ b/metron-platform/metron-common/src/main/java/org/apache/metron/common/system/FakeClock.java @@ -24,11 +24,11 @@ import java.util.concurrent.TimeUnit; * never advances itself, but allows you to increment it by any desired amount. * * Note that the base class is not the Java 8 Clock, but rather the Clock we - * defined in {@org.apache.metron.common.system.Clock}. Fundamental units of time + * defined in {@link org.apache.metron.common.system.Clock}. Fundamental units of time * are milliseconds. * - * Three exceptions are also defined: {@IllegalArgumentClockNegative}, - * {@IllegalArgumentClockZero}, and {@IllegalArgumentClockOverflow}. + * Three exceptions are also defined: {@link IllegalArgumentClockNegative}, + * {@link IllegalArgumentClockZero}, and {@link IllegalArgumentClockOverflow}. * These are thrown in various circumstances that imply the FakeClock is * being used outside of its design intent. They are subclasses of IllegalArgumentException, * hence unchecked. @@ -52,7 +52,7 @@ public class FakeClock extends Clock { * If we really get a demand for this capability, we'll add methods that don't * check for this. * @throws IllegalArgumentClockOverflow (unchecked) if you try to add a duration - * that would overflow the Long value of {@currentTimeMillis} + * that would overflow the Long value of {@code currentTimeMillis} */ public void elapseMillis(long duration_ms) { long instant_ms = now_ms + duration_ms; @@ -71,7 +71,7 @@ public class FakeClock extends Clock { /** * Advance the fake clock by a number of seconds. - * See {@elapseMillis} for details. + * See {@code elapseMillis} for details. * * @param duration_secs */ @@ -93,7 +93,7 @@ public class FakeClock extends Clock { * Why? Because it implies your test code has lost track of previous increments, * which might be problematic, so we do this in the spirit of "fail fast". * If you *meant* to lose track, for instance if you were using random numbers of events, - * or whatever, you can always orient yourself in time by reading {@currentTimeMillis}. + * or whatever, you can always orient yourself in time by reading {@code currentTimeMillis}. */ public void advanceToMillis(long instant_ms) { if (instant_ms < now_ms) { @@ -111,7 +111,7 @@ public class FakeClock extends Clock { /** * Advance the fake clock to a point in time specified as seconds after 0. - * See {@advanceToMillis} for details. + * See {@code advanceToMillis} for details. * * @param instant_secs - epoch time in seconds */ @@ -138,7 +138,7 @@ public class FakeClock extends Clock { * Why? Because it implies your test code has lost track of previous increments, * which might be problematic, so we do this in the spirit of "fail fast". * If you *meant* to lose track, for instance if you were using random numbers of events, - * or whatever, you can always orient yourself in time by reading {@currentTimeMillis}. + * or whatever, you can always orient yourself in time by reading {@code currentTimeMillis}. * * Note that argument does not apply to ellapseMillis(0), so it does not throw * this exception. @@ -151,7 +151,7 @@ public class FakeClock extends Clock { /** * IllegalArgumentClockOverflow (unchecked) is thrown if you try to add a duration - * that would overflow the Long value of {@currentTimeMillis} + * that would overflow the Long value of {@code currentTimeMillis} */ public static class IllegalArgumentClockOverflow extends IllegalArgumentException { public IllegalArgumentClockOverflow(String s) { http://git-wip-us.apache.org/repos/asf/metron/blob/2a1cbbbf/metron-platform/metron-common/src/main/java/org/apache/metron/common/utils/ReflectionUtils.java ---------------------------------------------------------------------- diff --git a/metron-platform/metron-common/src/main/java/org/apache/metron/common/utils/ReflectionUtils.java b/metron-platform/metron-common/src/main/java/org/apache/metron/common/utils/ReflectionUtils.java index ee6b041..1f216a8 100644 --- a/metron-platform/metron-common/src/main/java/org/apache/metron/common/utils/ReflectionUtils.java +++ b/metron-platform/metron-common/src/main/java/org/apache/metron/common/utils/ReflectionUtils.java @@ -95,7 +95,7 @@ public class ReflectionUtils { * Create instance from passed class name with specified parameter types and arguments. If parameter * types is null, defaults to attempting to instantiate the no-arg constructor. * - * @param clazz Class to create instance from + * @param className Class to create instance from * @param parameterTypes parameter types to use for looking up the desired constructor * @param parameters arguments to pass into the constructor when instantiating the object. * @param <T> Instance created from passed class http://git-wip-us.apache.org/repos/asf/metron/blob/2a1cbbbf/metron-platform/metron-common/src/main/java/org/apache/metron/common/zookeeper/configurations/ConfigurationsUpdater.java ---------------------------------------------------------------------- diff --git a/metron-platform/metron-common/src/main/java/org/apache/metron/common/zookeeper/configurations/ConfigurationsUpdater.java b/metron-platform/metron-common/src/main/java/org/apache/metron/common/zookeeper/configurations/ConfigurationsUpdater.java index 9ff2bee..f616ece 100644 --- a/metron-platform/metron-common/src/main/java/org/apache/metron/common/zookeeper/configurations/ConfigurationsUpdater.java +++ b/metron-platform/metron-common/src/main/java/org/apache/metron/common/zookeeper/configurations/ConfigurationsUpdater.java @@ -118,7 +118,6 @@ public abstract class ConfigurationsUpdater<T extends Configurations> implements * this is ONLY called on deletes to path to the zookeeper nodes which correspond * to your configurations type (rather than all configurations type). * @param name the path - * @throws IOException when update is unable to happen */ public abstract void delete(String name); http://git-wip-us.apache.org/repos/asf/metron/blob/2a1cbbbf/metron-platform/metron-indexing/src/main/java/org/apache/metron/indexing/dao/metaalert/MetaAlertDao.java ---------------------------------------------------------------------- diff --git a/metron-platform/metron-indexing/src/main/java/org/apache/metron/indexing/dao/metaalert/MetaAlertDao.java b/metron-platform/metron-indexing/src/main/java/org/apache/metron/indexing/dao/metaalert/MetaAlertDao.java index c9e6711..66d1d93 100644 --- a/metron-platform/metron-indexing/src/main/java/org/apache/metron/indexing/dao/metaalert/MetaAlertDao.java +++ b/metron-platform/metron-indexing/src/main/java/org/apache/metron/indexing/dao/metaalert/MetaAlertDao.java @@ -29,7 +29,7 @@ import org.apache.metron.indexing.dao.IndexDao; * status field that controls it's inclusion in search results and a groups field that can be used to track * the groups a meta alert was created from. * - * </p> + * <p> * The structure of a meta alert is as follows: * { * "guid": "meta alert guid", @@ -47,13 +47,13 @@ import org.apache.metron.indexing.dao.IndexDao; * "median": 10 * } * - * </p> + * <p> * A child alert that has been added to a meta alert will store the meta alert GUID in a "metaalerts" field. * This field is an array of meta alert GUIDs, meaning a child alert can be contained in multiple meta alerts. * Any update to a child alert will trigger an update to the meta alert so that the alert inside a meta alert * and the original alert will be kept in sync. * - * </p> + * <p> * Other fields can be added to a meta alert through the patch method on the IndexDao interface. However, attempts * to directly change the "alerts" or "status" field will result in an exception. */ http://git-wip-us.apache.org/repos/asf/metron/blob/2a1cbbbf/metron-platform/metron-writer/src/main/java/org/apache/metron/writer/BulkWriterComponent.java ---------------------------------------------------------------------- diff --git a/metron-platform/metron-writer/src/main/java/org/apache/metron/writer/BulkWriterComponent.java b/metron-platform/metron-writer/src/main/java/org/apache/metron/writer/BulkWriterComponent.java index dfa265d..e35960f 100644 --- a/metron-platform/metron-writer/src/main/java/org/apache/metron/writer/BulkWriterComponent.java +++ b/metron-platform/metron-writer/src/main/java/org/apache/metron/writer/BulkWriterComponent.java @@ -18,8 +18,17 @@ package org.apache.metron.writer; +import static java.lang.String.format; + import com.google.common.collect.Iterables; -import org.apache.commons.lang.exception.ExceptionUtils; +import java.util.ArrayList; +import java.util.Collection; +import java.util.HashMap; +import java.util.HashSet; +import java.util.List; +import java.util.Map; +import java.util.Optional; +import java.util.concurrent.TimeUnit; import org.apache.metron.common.Constants; import org.apache.metron.common.configuration.writer.WriterConfiguration; import org.apache.metron.common.error.MetronError; @@ -33,17 +42,6 @@ import org.apache.storm.tuple.Tuple; import org.slf4j.Logger; import org.slf4j.LoggerFactory; -import java.util.ArrayList; -import java.util.Collection; -import java.util.HashMap; -import java.util.HashSet; -import java.util.List; -import java.util.Map; -import java.util.Optional; -import java.util.concurrent.TimeUnit; - -import static java.lang.String.format; - /** * This component implements message batching, with both flush on queue size, and flush on queue timeout. * There is a queue for each sensorType. @@ -54,7 +52,7 @@ import static java.lang.String.format; * modified by batchTimeoutDivisor, in case multiple batching writers are daisy-chained in one topology. * - If some sensors configure their own batchTimeouts, they are compared with the default. Batch * timeouts greater than the default will be ignored, because they can cause message recycling in Storm. - * Batch timeouts configured to <= zero, or undefined, mean use the default. + * Batch timeouts configured to {@literal <}= zero, or undefined, mean use the default. * - The *smallest* configured batchTimeout among all sensor types, greater than zero and less than * the default, will be used to configure the 'topology.tick.tuple.freq.secs' for the Bolt. If there are no * valid configured batchTimeouts, the defaultBatchTimeout will be used. http://git-wip-us.apache.org/repos/asf/metron/blob/2a1cbbbf/metron-stellar/stellar-common/src/main/java/org/apache/metron/stellar/common/CachingStellarProcessor.java ---------------------------------------------------------------------- diff --git a/metron-stellar/stellar-common/src/main/java/org/apache/metron/stellar/common/CachingStellarProcessor.java b/metron-stellar/stellar-common/src/main/java/org/apache/metron/stellar/common/CachingStellarProcessor.java index 19de14e..28d69b3 100644 --- a/metron-stellar/stellar-common/src/main/java/org/apache/metron/stellar/common/CachingStellarProcessor.java +++ b/metron-stellar/stellar-common/src/main/java/org/apache/metron/stellar/common/CachingStellarProcessor.java @@ -184,7 +184,7 @@ public class CachingStellarProcessor extends StellarProcessor { } /** - * Create a cache given a config. Note that if the cache size is <= 0, then no cache will be returned. + * Create a cache given a config. Note that if the cache size is {@literal <}= 0, then no cache will be returned. * @param config * @return A cache. */ http://git-wip-us.apache.org/repos/asf/metron/blob/2a1cbbbf/metron-stellar/stellar-common/src/main/java/org/apache/metron/stellar/dsl/Context.java ---------------------------------------------------------------------- diff --git a/metron-stellar/stellar-common/src/main/java/org/apache/metron/stellar/dsl/Context.java b/metron-stellar/stellar-common/src/main/java/org/apache/metron/stellar/dsl/Context.java index 8a477c4..0f04151 100644 --- a/metron-stellar/stellar-common/src/main/java/org/apache/metron/stellar/dsl/Context.java +++ b/metron-stellar/stellar-common/src/main/java/org/apache/metron/stellar/dsl/Context.java @@ -63,7 +63,7 @@ public class Context implements Serializable { SHELL_VARIABLES , /** - * This capability indicates that the StellarProcessor should use a Caffeine cache to cache expression -> results. If an expression + * This capability indicates that the StellarProcessor should use a Caffeine cache to cache expression -{@literal >} results. If an expression * is in the cache, then the cached result will be returned instead of recomputing. */ CACHE
