Skip to content

Commit

Permalink
merge minor javadoc fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
bernhardttom2 committed Jan 3, 2022
1 parent 628a8c6 commit 5682d2f
Show file tree
Hide file tree
Showing 10 changed files with 12 additions and 4 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@ public static InsertIntoClause create(String streamName, String[] columns, Strea
* @param streamName the name of the stream to insert into
* @param columns is a list of column names
* @param streamSelector selects the stream
* @param precedence event precedence or null when not applicable
* @return clause
*/
public static InsertIntoClause create(String streamName, String[] columns, StreamSelector streamSelector, Expression precedence) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ public class FilterSpecCompilerIndexPlannerConstituent {
* @param streamTypeService stream type service
* @param raw statement info
* @param services compile services
* @param limitedExprExists for checking whether an expression has already been processed
* @return filter parameter representing the expression, or null
* @throws ExprValidationException if the expression is invalid
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,9 @@ public interface InternalEventRouter {
* @param theEvent to route
* @param agentInstanceContext agentInstanceContext
* @param addToFront indicator whether to add to front queue
* @param priority
* @param precedence event precedence
*/
void route(EventBean theEvent, AgentInstanceContext agentInstanceContext, boolean addToFront, int priority);
void route(EventBean theEvent, AgentInstanceContext agentInstanceContext, boolean addToFront, int precedence);

boolean isHasPreprocessing();

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,8 @@ public class StatementAgentInstanceLockRWLogging implements StatementAgentInstan
* Ctor.
*
* @param isFair true if a fair lock, false if not
* @param statementName statement name
* @param cpid context partition id
*/
public StatementAgentInstanceLockRWLogging(boolean isFair, String statementName, int cpid) {
this.lock = new ReentrantReadWriteLock(isFair);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -222,6 +222,7 @@ public EventPropertyDescriptor[] getPropertyDescriptors() {
* @param setOne is the first set of properties
* @param setTwo is the second set of properties
* @param otherName name of the type compared to
* @param lenientPropertyCount true to disregard property count, false to check all properties are provided
* @return null if the property set is equivalent or message if not
*/
public static ExprValidationException isDeepEqualsProperties(String otherName, Map<String, Object> setOne, Map<String, Object> setTwo, boolean lenientPropertyCount) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ public class EventTypeUtility {
* Compare tyoes
* @param newEventType the proposed new type
* @param existingType the existing type
* @throws ExprValidationException
* @throws ExprValidationException when validation fails
*/
public static void compareExistingType(EventType newEventType, EventType existingType) throws ExprValidationException {
ExprValidationException compared = ((EventTypeSPI) newEventType).equalsCompareType(existingType);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ public class MapEntryPropertyGetter implements MapEventPropertyGetter {
* @param propertyName property to get
* @param eventBeanTypedEventFactory factory for event beans and event types
* @param eventType type of the entry returned
* @param canFragment whether the property value can be an EventBean instance
*/
public MapEntryPropertyGetter(String propertyName, BeanEventType eventType, EventBeanTypedEventFactory eventBeanTypedEventFactory, boolean canFragment) {
this.propertyName = propertyName;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@ public class SchemaUtil {
* Returns the Class-type of the schema item.
*
* @param item to to determine type for
* @param xmlxsdHandler xml-xsd handler
* @return type
*/
public static EPTypeClass toReturnType(SchemaItem item, EventTypeXMLXSDHandler xmlxsdHandler) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ public class SchemaXMLPropertyParser {
* @param xmlEventType the resolving type
* @param isAllowFragment whether fragmenting is allowed
* @param defaultNamespace default namespace
* @param xmlxsdHandler
* @param xmlxsdHandler xml-xsd handler
* @return xpath expression
* @throws EPException is there are XPath errors
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ public class InsertIntoLatchWait implements InsertIntoLatch {
* @param earlier the latch before this latch that this latch should be waiting for
* @param msecTimeout the timeout after which delivery occurs
* @param payload the payload is an event to deliver
* @param factory the factory originating the latch
*/
public InsertIntoLatchWait(InsertIntoLatchFactory factory, InsertIntoLatchWait earlier, long msecTimeout, EventBean payload) {
this.factory = factory;
Expand Down

0 comments on commit 5682d2f

Please sign in to comment.