Interface Output

All Known Subinterfaces:

ResultSetOutput<T>, UpdateCountOutput

public interface Output

Common contract for individual outputs which can be either results or update counts.

API Note:

Although any of the asResultSetOutput() forms may be called multiple times, care should be taken to ensure that the same expected mapping is used each time.

Method Summary

Modifier and Type	Method	Description
ResultSetOutput<?>	asResultSetOutput()	Treat this output as a ResultSetOutput, using the mapping defined when the query was created, if one.
<X> ResultSetOutput<X>	asResultSetOutput(jakarta.persistence.sql.ResultSetMapping<X> resultSetMapping)	Treat this output as a ResultSetOutput, with the specified `resultSetMapping.
<X> ResultSetOutput<X>	asResultSetOutput(Class<X> resultType)	Treat this output as a ResultSetOutput, with the specified resultType.
UpdateCountOutput	asUpdateCountOutput()	Treat this output as a UpdateCountOutput.
boolean	isResultSet()	Determine if this output is a result.

Method Details

isResultSet

boolean isResultSet()

Determine if this output is a result. Negative indicates it is an update count instead.

See Also:

• asResultSetOutput()
• asResultSetOutput(Class)
• asResultSetOutput(ResultSetMapping)
• asUpdateCountOutput()

asResultSetOutput

ResultSetOutput<?> asResultSetOutput()

Treat this output as a ResultSetOutput, using the mapping defined when the query was created, if one.

Throws:

IllegalOutputTypeException - if the output is a UpdateCountOutput.

asResultSetOutput

<X> ResultSetOutput<X> asResultSetOutput(Class<X> resultType)

Treat this output as a ResultSetOutput, with the specified resultType. If a mapping was specified during query creation, we simply validate that the types match. Otherwise, the resultType is used to define a mapping.

Type Parameters:

X - The java type of the mapping.

Throws:

IllegalOutputTypeException - if the output is a UpdateCountOutput.

TypeMismatchException - if the given resultType does not match expectation.

asResultSetOutput

<X> ResultSetOutput<X> asResultSetOutput(jakarta.persistence.sql.ResultSetMapping<X> resultSetMapping)

Treat this output as a ResultSetOutput, with the specified `resultSetMapping. This form will override any mapping specified during query creation.

Type Parameters:

X - The java type of the mapping.

Throws:

IllegalOutputTypeException - if the output is a UpdateCountOutput.

asUpdateCountOutput

UpdateCountOutput asUpdateCountOutput()

Treat this output as a UpdateCountOutput.

Throws:

IllegalOutputTypeException - if the output is a UpdateCountOutput.