docs(core): add missing javadoc for Expression by bestbeforetoday · Pull Request #793 · substrait-io/substrait-java

bestbeforetoday · 2026-04-01T16:30:56Z

No description provided.

Signed-off-by: Mark S. Lewis <Mark.S.Lewis@outlook.com>

nielspardon · 2026-04-10T07:54:16Z

core/src/main/java/io/substrait/expression/Expression.java

  @Value.Immutable
  abstract class StrLiteral implements Literal {
+    /**
+     * Returns the string value.


for consistency:

Suggested change

* Returns the string value.

* Returns the string value of this literal.

nielspardon · 2026-04-10T07:57:21Z

core/src/main/java/io/substrait/expression/Expression.java

  @Deprecated
  abstract class TimestampLiteral implements Literal {
+    /**
+     * Returns the timestamp value in microseconds since epoch.


Suggested change

* Returns the timestamp value in microseconds since epoch.

* Returns the timestamp value of this literal in microseconds since epoch.

nielspardon · 2026-04-10T07:57:33Z

core/src/main/java/io/substrait/expression/Expression.java

  @Deprecated
  abstract class TimeLiteral implements Literal {
+    /**
+     * Returns the time value in microseconds since midnight.


Suggested change

* Returns the time value in microseconds since midnight.

* Returns the time value of this literal in microseconds since midnight.

nielspardon · 2026-04-10T07:57:44Z

core/src/main/java/io/substrait/expression/Expression.java

  @Value.Immutable
  abstract class PrecisionTimeLiteral implements Literal {
+    /**
+     * Returns the time value since midnight.


Suggested change

* Returns the time value since midnight.

* Returns the time value of this literal since midnight.

nielspardon · 2026-04-10T07:58:14Z

core/src/main/java/io/substrait/expression/Expression.java

  @Value.Immutable
  abstract class DateLiteral implements Literal {
+    /**
+     * Returns the date value as days since epoch.


Suggested change

* Returns the date value as days since epoch.

* Returns the date value of this literal as days since epoch.

nielspardon · 2026-04-10T07:58:27Z

core/src/main/java/io/substrait/expression/Expression.java

  @Deprecated
  abstract class TimestampTZLiteral implements Literal {
+    /**
+     * Returns the timestamp with timezone value in microseconds since epoch.


Suggested change

* Returns the timestamp with timezone value in microseconds since epoch.

* Returns the timestamp with timezone value of this literal in microseconds since epoch.

nielspardon · 2026-04-10T07:58:37Z

core/src/main/java/io/substrait/expression/Expression.java

  @Value.Immutable
  abstract class PrecisionTimestampLiteral implements Literal {
+    /**
+     * Returns the timestamp value since epoch.


Suggested change

* Returns the timestamp value since epoch.

* Returns the timestamp value of this literal since epoch.

nielspardon · 2026-04-10T07:59:18Z

core/src/main/java/io/substrait/expression/Expression.java

  @Value.Immutable
  abstract class PrecisionTimestampTZLiteral implements Literal {
+    /**
+     * Returns the timestamp with timezone value since epoch.


Suggested change

* Returns the timestamp with timezone value since epoch.

* Returns the timestamp with timezone value of this literal since epoch.

nielspardon · 2026-04-10T07:59:53Z

core/src/main/java/io/substrait/expression/Expression.java

    public abstract long subseconds();

+    /**
+     * Returns the precision of the subseconds component.


Suggested change

* Returns the precision of the subseconds component.

* Returns the precision of the subseconds component of this interval.

nielspardon · 2026-04-10T08:00:12Z

core/src/main/java/io/substrait/expression/Expression.java

    public abstract long subseconds();

+    /**
+     * Returns the precision of the subseconds component.


Suggested change

* Returns the precision of the subseconds component.

* Returns the precision of the subseconds component of this interval.

nielspardon · 2026-04-10T08:00:23Z

core/src/main/java/io/substrait/expression/Expression.java

  @Value.Immutable
  abstract class UUIDLiteral implements Literal {
+    /**
+     * Returns the UUID value.


Suggested change

* Returns the UUID value.

* Returns the UUID value of this literal.

nielspardon · 2026-04-10T08:00:47Z

core/src/main/java/io/substrait/expression/Expression.java

  @Value.Immutable
  abstract class FixedCharLiteral implements Literal {
+    /**
+     * Returns the fixed-length character string value.


Suggested change

* Returns the fixed-length character string value.

* Returns the fixed-length character string value of this literal.

nielspardon · 2026-04-10T08:00:53Z

core/src/main/java/io/substrait/expression/Expression.java

  @Value.Immutable
  abstract class VarCharLiteral implements Literal {
+    /**
+     * Returns the variable-length character string value.


Suggested change

* Returns the variable-length character string value.

* Returns the variable-length character string value of this literal.

nielspardon · 2026-04-10T08:01:36Z

core/src/main/java/io/substrait/expression/Expression.java

    public abstract String value();

+    /**
+     * Returns the maximum length of the string.


Suggested change

* Returns the maximum length of the string.

* Returns the maximum length of the string value of this literal.

nielspardon · 2026-04-10T08:08:34Z

core/src/main/java/io/substrait/expression/Expression.java

  @Value.Immutable
  abstract class FixedBinaryLiteral implements Literal {
+    /**
+     * Returns the fixed-length binary value.


Suggested change

* Returns the fixed-length binary value.

* Returns the fixed-length binary value of this literal.

nielspardon · 2026-04-10T08:08:45Z

core/src/main/java/io/substrait/expression/Expression.java

  @Value.Immutable
  abstract class DecimalLiteral implements Literal {
+    /**
+     * Returns the decimal value as a ByteString.


Suggested change

* Returns the decimal value as a ByteString.

* Returns the decimal value as a ByteString of this literal.

nielspardon · 2026-04-10T08:11:08Z

core/src/main/java/io/substrait/expression/Expression.java

  @Value.Immutable
  abstract class MapLiteral implements Literal {
+    /**
+     * Returns the map of key-value pairs.


Suggested change

* Returns the map of key-value pairs.

* Returns the map of key-value pairs of this literal.

nielspardon · 2026-04-10T08:11:20Z

core/src/main/java/io/substrait/expression/Expression.java

    public abstract ByteString value();

+    /**
+     * Returns the precision of this decimal.


Suggested change

* Returns the precision of this decimal.

* Returns the precision of this decimal literal.

nielspardon · 2026-04-10T08:11:42Z

core/src/main/java/io/substrait/expression/Expression.java

    public abstract int precision();

+    /**
+     * Returns the scale of this decimal.


Suggested change

* Returns the scale of this decimal.

* Returns the scale of this decimal literal.

nielspardon · 2026-04-10T08:12:04Z

core/src/main/java/io/substrait/expression/Expression.java

  @Value.Immutable
  abstract class EmptyMapLiteral implements Literal {
+    /**
+     * Returns the type of keys in this empty map.


Suggested change

* Returns the type of keys in this empty map.

* Returns the type of keys in this empty map literal.

nielspardon · 2026-04-10T08:12:14Z

core/src/main/java/io/substrait/expression/Expression.java

    public abstract Type keyType();

+    /**
+     * Returns the type of values in this empty map.


Suggested change

* Returns the type of values in this empty map.

* Returns the type of values in this empty map literal.

nielspardon · 2026-04-10T08:12:48Z

core/src/main/java/io/substrait/expression/Expression.java

  @Value.Immutable
  abstract class ListLiteral implements Literal {
+    /**
+     * Returns the list of literal values.


Suggested change

* Returns the list of literal values.

* Returns the list of literal values of this list literal.

nielspardon · 2026-04-10T08:12:57Z

core/src/main/java/io/substrait/expression/Expression.java

  @Value.Immutable
  abstract class EmptyListLiteral implements Literal {
+    /**
+     * Returns the type of elements in this empty list.


Suggested change

* Returns the type of elements in this empty list.

* Returns the type of elements in this empty list literal.

nielspardon · 2026-04-10T08:13:16Z

core/src/main/java/io/substrait/expression/Expression.java

  @Value.Immutable
  abstract class StructLiteral implements Literal {
+    /**
+     * Returns the list of field literals in this struct.


Suggested change

* Returns the list of field literals in this struct.

* Returns the list of field literals in this struct literal.

nielspardon · 2026-04-10T08:15:23Z

core/src/main/java/io/substrait/expression/Expression.java

   */
  interface UserDefinedLiteral extends Literal {
+    /**
+     * Returns the URN (Uniform Resource Name) identifying the user-defined type.


Suggested change

* Returns the URN (Uniform Resource Name) identifying the user-defined type.

* Returns the URN (Uniform Resource Name) identifying the user-defined type of this literal.

nielspardon · 2026-04-10T08:15:41Z

core/src/main/java/io/substrait/expression/Expression.java

    String urn();

+    /**
+     * Returns the name of the user-defined type.


Suggested change

* Returns the name of the user-defined type.

* Returns the name of the user-defined type of this literal.

nielspardon · 2026-04-10T08:16:13Z

core/src/main/java/io/substrait/expression/Expression.java

    String name();

+    /**
+     * Returns the list of type parameters for this user-defined type.


Suggested change

* Returns the list of type parameters for this user-defined type.

* Returns the list of type parameters for this user-defined type literal.

nielspardon · 2026-04-10T08:16:34Z

core/src/main/java/io/substrait/expression/Expression.java

    public abstract List<io.substrait.type.Type.Parameter> typeParameters();

+    /**
+     * Returns the value encoded as a protobuf Any.


Suggested change

* Returns the value encoded as a protobuf Any.

* Returns the value of this literal encoded as a protobuf Any.

nielspardon · 2026-04-10T08:16:58Z

core/src/main/java/io/substrait/expression/Expression.java

    public abstract List<io.substrait.type.Type.Parameter> typeParameters();

+    /**
+     * Returns the list of field literals in this user-defined struct.


Suggested change

* Returns the list of field literals in this user-defined struct.

* Returns the list of field literals in this user-defined struct literal.

docs(core): add missing javadoc for Expression

850d109

Signed-off-by: Mark S. Lewis <Mark.S.Lewis@outlook.com>

bestbeforetoday marked this pull request as ready for review April 1, 2026 17:28

mbwhite approved these changes Apr 2, 2026

View reviewed changes

nielspardon reviewed Apr 10, 2026

View reviewed changes

	* Returns the string value.
	* Returns the string value of this literal.

	* Returns the timestamp value in microseconds since epoch.
	* Returns the timestamp value of this literal in microseconds since epoch.

	* Returns the time value in microseconds since midnight.
	* Returns the time value of this literal in microseconds since midnight.

	* Returns the time value since midnight.
	* Returns the time value of this literal since midnight.

	* Returns the date value as days since epoch.
	* Returns the date value of this literal as days since epoch.

	* Returns the timestamp with timezone value in microseconds since epoch.
	* Returns the timestamp with timezone value of this literal in microseconds since epoch.

	* Returns the timestamp value since epoch.
	* Returns the timestamp value of this literal since epoch.

	* Returns the precision of the subseconds component.
	* Returns the precision of the subseconds component of this interval.

	* Returns the UUID value.
	* Returns the UUID value of this literal.

	* Returns the fixed-length character string value.
	* Returns the fixed-length character string value of this literal.

	* Returns the variable-length character string value.
	* Returns the variable-length character string value of this literal.

	* Returns the maximum length of the string.
	* Returns the maximum length of the string value of this literal.

	* Returns the fixed-length binary value.
	* Returns the fixed-length binary value of this literal.

	* Returns the decimal value as a ByteString.
	* Returns the decimal value as a ByteString of this literal.

	* Returns the map of key-value pairs.
	* Returns the map of key-value pairs of this literal.

	* Returns the precision of this decimal.
	* Returns the precision of this decimal literal.

	* Returns the scale of this decimal.
	* Returns the scale of this decimal literal.

	* Returns the type of keys in this empty map.
	* Returns the type of keys in this empty map literal.

	* Returns the type of values in this empty map.
	* Returns the type of values in this empty map literal.

	* Returns the list of literal values.
	* Returns the list of literal values of this list literal.

Conversation

bestbeforetoday commented Apr 1, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	* Returns the type of elements in this empty list.
	* Returns the type of elements in this empty list literal.

	* Returns the list of field literals in this struct.
	* Returns the list of field literals in this struct literal.

	* Returns the URN (Uniform Resource Name) identifying the user-defined type.
	* Returns the URN (Uniform Resource Name) identifying the user-defined type of this literal.

	* Returns the name of the user-defined type.
	* Returns the name of the user-defined type of this literal.

	* Returns the list of type parameters for this user-defined type.
	* Returns the list of type parameters for this user-defined type literal.

	* Returns the value encoded as a protobuf Any.
	* Returns the value of this literal encoded as a protobuf Any.