Skip to content

MLE-27841 More 'since' annotations #1918

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rjrudin merged 1 commit into from
Mar 4, 2026
Merged

MLE-27841 More 'since' annotations #1918

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions marklogic-client-api/src/main/java/com/marklogic/client/expression/PlanBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -249,6 +249,8 @@ protected PlanBuilder(
/**
* Create column definitions which can be used in op:from-docs. Below functions are used to create column definitions. op:add-column, op:type, op:xpath, op:expr, op:nullable, op:default, op:dimension, op:coordinate-system, op:units, op:collation.
* @return a PlanColumnBuilder object
*
* @since 8.1.0; requires MarkLogic 12.1 or higher
*/
public abstract PlanColumnBuilder columnBuilder();
/**
Expand Down Expand Up @@ -1189,6 +1191,8 @@ protected PlanBuilder(
/**
* This helper function returns the node from the current processing row. It is to be used in op:xpath, to reference the 'current item' instead of a doc column.
* @return a PlanContextExprCall object
*
* @since 8.1.0; requires MarkLogic 12.1 or higher
*/
public abstract PlanContextExprCall context();
/**
Expand Down Expand Up @@ -1236,6 +1240,8 @@ protected PlanBuilder(
* @param expression The server expression (such as op:context()) from which to extract the child nodes.
* @param path An XPath (specified as a string) to apply to each node. (of <a href="{@docRoot}/doc-files/types/xs_string.html">xs:string</a>)
* @return a server expression with the <a href="{@docRoot}/doc-files/types/node.html">node</a> server data type
*
* @since 8.1.0; requires MarkLogic 12.1 or higher
*/
Comment on lines 1241 to 1245
Copy link

Copilot AI Mar 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The @since annotation added here uses inconsistent indentation (extra leading space) and the wording differs from most other @since tags in this file (missing "or higher" and trailing period). Align indentation with the rest of the Javadoc and consider using "requires MarkLogic 12.1 or higher." for consistency and to clarify this is a minimum server version.

Copilot uses AI. Check for mistakes.
public abstract ServerExpression xpath(ServerExpression expression, String path);
/**
Expand All @@ -1245,6 +1251,8 @@ protected PlanBuilder(
* @param expression The server expression (such as op:context()) from which to extract the child nodes.
* @param path An XPath to apply to each node. (of <a href="{@docRoot}/doc-files/types/xs_string.html">xs:string</a>)
* @return a server expression with the <a href="{@docRoot}/doc-files/types/node.html">node</a> server data type
*
* @since 8.1.0; requires MarkLogic 12.1 or higher
*/
Comment on lines 1252 to 1256
Copy link

Copilot AI Mar 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as above: the newly added blank line and @since line have inconsistent indentation, and the @since wording differs from the established pattern in this file (typically "requires MarkLogic 12.1 or higher." with a period). Adjust the indentation and wording for consistent generated Javadocs and clearer minimum server requirements.

Copilot uses AI. Check for mistakes.
public abstract ServerExpression xpath(ServerExpression expression, ServerExpression path);
/**
Expand Down
1 change: 1 addition & 0 deletions marklogic-client-api/src/main/java/com/marklogic/client/expression/PlanBuilderBase.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -362,6 +362,7 @@ public interface PlanBuilderBase {
* operator. Use the fluent methods of the transitive closure option object
* to set the configuration.
* @return the configuration object
* @since 8.1.0; requires MarkLogic 12.1 or higher
*/
PlanTransitiveClosureOptions transitiveClosureOptions();

Expand Down