merge javadoc and changelog updates

espertechinc · Aug 3, 2017 · a84e949 · a84e949
1 parent fc6d970
commit a84e949
Show file tree

Hide file tree

Showing 21 changed files with 59 additions and 20 deletions.
diff --git a/changelog.txt b/changelog.txt
@@ -1,7 +1,7 @@
 Esper Changelog
 ===================
 
-Changes in version 7.0.0
+Changes in version 7.0.0-beta1
 ------------------------
   - Code generation for all interdependent expressions
   - The following dependent jar files are upgraded:
@@ -11,6 +11,7 @@ Changes in version 7.0.0
 
 Minor API Change:
   - Event property types are boxed types except when the event type is a Java class and the property type is a primitive type.
+    Expressions return boxed types.
 
 Changes in version 6.1.0
 ------------------------

diff --git a/esper/src/main/java/com/espertech/esper/client/ConfigurationEngineDefaults.java b/esper/src/main/java/com/espertech/esper/client/ConfigurationEngineDefaults.java
@@ -2333,7 +2333,7 @@ public boolean isEnableExpression() {
 
         /**
          * Returns indicator whether to enable code generation for expressions (true by default).
-         * @return indicator
+         * @param enableExpression indicator
          */
         public void setEnableExpression(boolean enableExpression) {
             this.enableExpression = enableExpression;
@@ -2383,7 +2383,7 @@ public boolean isIncludeComments() {
 
         /**
          * Sets indicator whether the generated source code should include comments for tracing back
-         * @params includeComments
+         * @param includeComments indicator
          */
         public void setIncludeComments(boolean includeComments) {
             this.includeComments = includeComments;

diff --git a/.../src/main/java/com/espertech/esper/codegen/model/blocks/CodegenLegoBooleanExpression.java b/.../src/main/java/com/espertech/esper/codegen/model/blocks/CodegenLegoBooleanExpression.java
@@ -32,6 +32,10 @@ public class CodegenLegoBooleanExpression {
      * @param block   block
      * @param forge   forge
      * @param context context
+     * @param checkFor indicator
+     * @param earlyExitIfNull indicator
+     * @param resultEarlyExit indicator
+     * @param resultIfCheckPasses indicator
      */
     public static void codegenReturnBoolIfNullOrBool(CodegenBlock block, ExprForge forge, CodegenContext context, boolean earlyExitIfNull, Boolean resultEarlyExit, boolean checkFor, boolean resultIfCheckPasses) {
         Class type = forge.getEvaluationType();
@@ -68,6 +72,7 @@ public static void codegenReturnBoolIfNullOrBool(CodegenBlock block, ExprForge f
      * @param block   block
      * @param forge   forge
      * @param context context
+     * @param value value
      */
     public static void codegenReturnValueIfNullOrNotPass(CodegenBlock block, ExprForge forge, CodegenContext context, CodegenExpression value) {
         codegenDOIfNullOrNotPass(block, forge, context, false, false, true, value);

diff --git a/esper/src/main/java/com/espertech/esper/codegen/model/method/package.html b/esper/src/main/java/com/espertech/esper/codegen/model/method/package.html
@@ -0,0 +1,19 @@
+<!--
+  ~ **************************************************************************************
+  ~ * Copyright (C) 2006-2015 EsperTech Inc. All rights reserved.                        *
+  ~ * http://www.espertech.com/esper                                                          *
+  ~ * http://www.espertech.com                                                           *
+  ~ * ---------------------------------------------------------------------------------- *
+  ~ * The software in this package is published under the terms of the GPL license       *
+  ~ * a copy of which has been included with this distribution in the license.txt file.  *
+  ~ **************************************************************************************
+  -->
+
+<html>
+<head></head>
+<body>
+<p>
+    Code-Generation Method and Method Parameter Model
+</p>
+</body>
+</html>
diff --git a/esper/src/main/java/com/espertech/esper/core/service/InternalEventRouterImpl.java b/esper/src/main/java/com/espertech/esper/core/service/InternalEventRouterImpl.java
@@ -49,6 +49,7 @@ public class InternalEventRouterImpl implements InternalEventRouter {
     /**
      * Ctor.
      * @param engineURI engine URI
+     * @param engineImportService engine imports
      */
     public InternalEventRouterImpl(String engineURI, EngineImportService engineImportService) {
         this.engineURI = engineURI;

diff --git a/...r/src/main/java/com/espertech/esper/epl/agg/service/AggregationServiceFactoryFactory.java b/...r/src/main/java/com/espertech/esper/epl/agg/service/AggregationServiceFactoryFactory.java
@@ -55,6 +55,8 @@ public class AggregationServiceFactoryFactory {
      * @param numStreams                number of streams
      * @param measureExprNodesPerStream measure nodes
      * @param typesPerStream            type information
+     * @param statementName statement name
+     * @param engineImportService engine imports
      * @return service
      * @throws ExprValidationException for validation errors
      */

diff --git a/esper/src/main/java/com/espertech/esper/epl/core/BindProcessor.java b/esper/src/main/java/com/espertech/esper/epl/core/BindProcessor.java
@@ -39,6 +39,10 @@ public class BindProcessor {
      * @param typesPerStream the event types per stream
      * @param streamNames    the stream names
      * @param tableService   table service
+     * @param engineImportService engine imports
+     * @param statementName statement name
+     * @param annotations annotations
+     * @param isFireAndForget fire-and-forget flag
      * @throws ExprValidationException when the validation of the select clause failed
      */
     public BindProcessor(SelectClauseElementCompiled[] selectionList,

diff --git a/esper/src/main/java/com/espertech/esper/epl/core/OrderByProcessorFactoryFactory.java b/esper/src/main/java/com/espertech/esper/epl/core/OrderByProcessorFactoryFactory.java
@@ -43,6 +43,9 @@ public class OrderByProcessorFactoryFactory {
      * @param variableService     for retrieving variable state for use with row limiting
      * @param isSortUsingCollator for string value sorting using compare or Collator
      * @param optionalContextName context name
+     * @param engineImportService engine import svc
+     * @param onDemandQuery fire-and-forget flag
+     * @param statementName statement name
      * @return ordering processor instance
      * @throws com.espertech.esper.epl.expression.core.ExprValidationException when validation of expressions fails
      */

diff --git a/esper/src/main/java/com/espertech/esper/epl/core/OrderByProcessorFactoryImpl.java b/esper/src/main/java/com/espertech/esper/epl/core/OrderByProcessorFactoryImpl.java
@@ -41,6 +41,9 @@ public class OrderByProcessorFactoryImpl implements OrderByProcessorFactory {
      *                            indicates whether this processor needs to have individual
      *                            group by keys to evaluate the sort condition successfully
      * @param isSortUsingCollator for string value sorting using compare or Collator
+     * @param statementName statement name
+     * @param engineImportService engine imports
+     * @param onDemandQuery fire-and-forget flag
      * @throws com.espertech.esper.epl.expression.core.ExprValidationException when order-by items don't divulge a type
      */
     public OrderByProcessorFactoryImpl(final List<OrderByItem> orderByList,

diff --git a/.../java/com/espertech/esper/epl/core/SelectExprProcessorEnumerationAtBeanCollTableEval.java b/.../java/com/espertech/esper/epl/core/SelectExprProcessorEnumerationAtBeanCollTableEval.java
@@ -56,9 +56,9 @@ public static CodegenExpression codegen(SelectExprProcessorEnumerationAtBeanColl
      * @param result result
      * @param eventToPublic conversion
      * @param eventsPerStream events
-     * @param isNewData
-     * @param exprEvaluatorContext
-     * @return
+     * @param isNewData flag
+     * @param exprEvaluatorContext context
+     * @return beans
      */
     public static EventBean[] convertToTableType(Object result, TableMetadataInternalEventToPublic eventToPublic, EventBean[] eventsPerStream, boolean isNewData, ExprEvaluatorContext exprEvaluatorContext) {
         if (result instanceof Collection) {

diff --git a/esper/src/main/java/com/espertech/esper/epl/datetime/calop/CalendarPlusMinusForgeOp.java b/esper/src/main/java/com/espertech/esper/epl/datetime/calop/CalendarPlusMinusForgeOp.java
@@ -115,6 +115,7 @@ public static void actionCalendarPlusMinusNumber(Calendar cal, int factor, Long
      * @param ldt ldt
      * @param factor factor
      * @param duration duration
+     * @return ldt
      */
     public static LocalDateTime actionLDTPlusMinusNumber(LocalDateTime ldt, int factor, Long duration) {
         if (duration == null) {
@@ -135,6 +136,7 @@ public static LocalDateTime actionLDTPlusMinusNumber(LocalDateTime ldt, int fact
      * @param zdt ldt
      * @param factor factor
      * @param duration duration
+     * @return zdt
      */
     public static ZonedDateTime actionZDTPlusMinusNumber(ZonedDateTime zdt, int factor, Long duration) {
         if (duration == null) {
@@ -203,6 +205,7 @@ public static void actionCalendarPlusMinusTimePeriod(Calendar cal, int factor, T
      * @param ldt ldt
      * @param factor factor
      * @param tp duration
+     * @return ldt
      */
     public static LocalDateTime actionLDTPlusMinusTimePeriod(LocalDateTime ldt, int factor, TimePeriod tp) {
         if (tp == null) {
@@ -240,6 +243,7 @@ public static LocalDateTime actionLDTPlusMinusTimePeriod(LocalDateTime ldt, int
      * @param zdt zdt
      * @param factor factor
      * @param tp duration
+     * @return zdt
      */
     public static ZonedDateTime actionZDTPlusMinusTimePeriod(ZonedDateTime zdt, int factor, TimePeriod tp) {
         if (tp == null) {

diff --git a/esper/src/main/java/com/espertech/esper/epl/datetime/calop/CalendarWithTimeForgeOp.java b/esper/src/main/java/com/espertech/esper/epl/datetime/calop/CalendarWithTimeForgeOp.java
@@ -94,7 +94,6 @@ public static CodegenExpression codegenZDT(CalendarWithTimeForge forge, CodegenE
      * @param minute min
      * @param second sec
      * @param msec msec
-     * @return ldt
      */
     public static void actionSetHMSMCalendar(Calendar cal, Integer hour, Integer minute, Integer second, Integer msec) {
         if (hour != null) {

diff --git a/...src/main/java/com/espertech/esper/epl/datetime/interval/IntervalComputerForgeFactory.java b/...src/main/java/com/espertech/esper/epl/datetime/interval/IntervalComputerForgeFactory.java
@@ -335,7 +335,7 @@ public Boolean compute(long leftStart, long leftEnd, long rightStart, long right
          * @param right   right
          * @param start   start
          * @param end     end
-         * @returnflag
+         * @return flag
          */
         public static boolean computeIntervalBefore(long leftEnd, long right, long start, long end) {
             long delta = right - leftEnd;

diff --git a/.../main/java/com/espertech/esper/epl/enummethod/eval/EnumOrderByAscDescEventsForgeEval.java b/.../main/java/com/espertech/esper/epl/enummethod/eval/EnumOrderByAscDescEventsForgeEval.java
@@ -97,7 +97,7 @@ public static CodegenExpression codegen(EnumOrderByAscDescEventsForge forge, Cod
      * @param sort sorted
      * @param hasColl collection flag
      * @param descending true for descending
-     * @return
+     * @return collection
      */
     public static Collection enumOrderBySortEval(TreeMap<Comparable, Object> sort, boolean hasColl, boolean descending) {
         Map<Comparable, Object> sorted;

diff --git a/esper/src/main/java/com/espertech/esper/epl/expression/subquery/ExprSubselectNode.java b/esper/src/main/java/com/espertech/esper/epl/expression/subquery/ExprSubselectNode.java
@@ -149,9 +149,11 @@ public StatementSpecCompiled getStatementSpecCompiled() {
     }
 
     /**
-     * Sets the validate select clause
+     * Sets the validates select clause
      *
      * @param selectClause is the expression representing the select clause
+     * @param engineImportService engine import service
+     * @param statementName name
      */
     public void setSelectClause(ExprNode[] selectClause, EngineImportService engineImportService, String statementName) {
         this.selectClause = selectClause;

diff --git a/esper/src/main/java/com/espertech/esper/epl/join/plan/NStreamOuterQueryPlanBuilder.java b/esper/src/main/java/com/espertech/esper/epl/join/plan/NStreamOuterQueryPlanBuilder.java
@@ -46,6 +46,8 @@ public class NStreamOuterQueryPlanBuilder {
      * @param historicalViewableDesc     historicals
      * @param indexedStreamsUniqueProps  unique props
      * @param tablesPerStream            tables
+     * @param isFireAndForget            fire-and-forget flag
+     * @param engineImportService        engine imports
      * @return query plan
      * @throws ExprValidationException if the query planning failed
      */

diff --git a/esper/src/main/java/com/espertech/esper/epl/join/plan/QueryPlanBuilder.java b/esper/src/main/java/com/espertech/esper/epl/join/plan/QueryPlanBuilder.java
@@ -47,6 +47,8 @@ public class QueryPlanBuilder {
      * @param isQueryPlanLogging         for logging
      * @param exprEvaluatorContext       context
      * @param annotations                annotations
+     * @param isFireAndForget            fire-and-forget flag
+     * @param engineImportService        engine imports
      * @return query plan
      * @throws ExprValidationException if the query plan fails
      */

diff --git a/esper/src/main/java/com/espertech/esper/epl/variable/VariableReadWritePackage.java b/esper/src/main/java/com/espertech/esper/epl/variable/VariableReadWritePackage.java
@@ -51,6 +51,7 @@ public class VariableReadWritePackage {
      * @param assignments         the list of variable assignments
      * @param variableService     variable service
      * @param eventAdapterService event adapters
+     * @param statementName statement name
      * @throws com.espertech.esper.epl.expression.core.ExprValidationException when variables cannot be found
      */
     public VariableReadWritePackage(List<OnTriggerSetAssignment> assignments, VariableService variableService, EventAdapterService eventAdapterService, String statementName)

diff --git a/esper/src/main/java/com/espertech/esper/event/arr/ObjectArrayEventBeanPropertyGetter.java b/esper/src/main/java/com/espertech/esper/event/arr/ObjectArrayEventBeanPropertyGetter.java
@@ -25,11 +25,6 @@ public class ObjectArrayEventBeanPropertyGetter implements ObjectArrayEventPrope
     private final int propertyIndex;
     private final Class underlyingType;
 
-    /**
-     * Ctor.
-     *
-     * @param propertyIndex property to get
-     */
     public ObjectArrayEventBeanPropertyGetter(int propertyIndex, Class underlyingType) {
         this.propertyIndex = propertyIndex;
         this.underlyingType = underlyingType;

diff --git a/esper/src/main/java/com/espertech/esper/event/bean/InstanceManufacturerFastCtor.java b/esper/src/main/java/com/espertech/esper/event/bean/InstanceManufacturerFastCtor.java
@@ -53,6 +53,7 @@ public static Object makeUnderlyingFromFastCtor(Object[] properties, FastConstru
      * NOTE: Code-generation-invoked method, method name and parameter order matters
      * @param targetClassName name
      * @param targetException ex
+     * @return exception
      */
     public static EPException getTargetExceptionAsEPException(String targetClassName, Throwable targetException) {
         return new EPException("InvocationTargetException received invoking constructor for type '" + targetClassName + "': " + targetException.getMessage(), targetException);

diff --git a/esper/src/main/java/com/espertech/esper/event/map/MapEventBeanPropertyGetter.java b/esper/src/main/java/com/espertech/esper/event/map/MapEventBeanPropertyGetter.java
@@ -27,11 +27,6 @@ public class MapEventBeanPropertyGetter implements MapEventPropertyGetter {
     private final String propertyName;
     private final Class underlyingType;
 
-    /**
-     * Ctor.
-     *
-     * @param propertyName property to get
-     */
     public MapEventBeanPropertyGetter(String propertyName, Class underlyingType) {
         this.propertyName = propertyName;
         this.underlyingType = underlyingType;