Skip to content

HHH-18649 nice Javadoc for static TypedQueryReferences #9003

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
merged 1 commit into from
Sep 23, 2024
Merged

HHH-18649 nice Javadoc for static TypedQueryReferences #9003

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
6 changes: 3 additions & 3 deletions .../metamodel-generator/src/main/java/org/hibernate/processor/annotation/AnnotationMeta.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ && getAnnotationValue( mirror, "resultClass" ) == null ) {
if ( resultType != null ) {
putMember( "QUERY_" + name,
new TypedMetaAttribute( this, name, "QUERY_", resultType,
"jakarta.persistence.TypedQueryReference" ) );
"jakarta.persistence.TypedQueryReference", hql ) );
}
}
}
Expand Down Expand Up @@ -205,11 +205,11 @@ private NameMetaAttribute auxiliaryMember(AnnotationMirror mirror, String prefix
// and then we will replace this TypedMetaAttribute
return new TypedMetaAttribute( this, name, prefix,
resultClass == null ? JAVA_OBJECT : resultClass.getValue().toString(),
"jakarta.persistence.TypedQueryReference" );
"jakarta.persistence.TypedQueryReference", null );
}
else if ( !isJakartaDataStyle() && "GRAPH_".equals(prefix) ) {
return new TypedMetaAttribute( this, name, prefix, getQualifiedName(),
"jakarta.persistence.EntityGraph" );
"jakarta.persistence.EntityGraph", null );
}
else {
return new NameMetaAttribute( this, name, prefix);
Expand Down
25 changes: 21 additions & 4 deletions ...amodel-generator/src/main/java/org/hibernate/processor/annotation/TypedMetaAttribute.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,28 +4,34 @@
*/
package org.hibernate.processor.annotation;

import org.checkerframework.checker.nullness.qual.Nullable;
import org.hibernate.processor.model.Metamodel;

import static org.hibernate.processor.util.StringUtil.nameToMethodName;

/**
* Represents a named query or named entity graph.
*
* @author Gavin King
*/
class TypedMetaAttribute extends NameMetaAttribute {
private final String prefix;
private final String resultType;
private final String referenceType;
private final @Nullable String query;

public TypedMetaAttribute(
Metamodel annotationMetaEntity,
String name,
String prefix,
String resultType,
String referenceType) {
String referenceType,
@Nullable String query) {
super( annotationMetaEntity, name, prefix );
this.prefix = prefix;
this.resultType = resultType;
this.referenceType = referenceType;
this.query = query;
}

@Override
Expand All @@ -35,14 +41,25 @@ public boolean hasTypedAttribute() {

@Override
public String getAttributeDeclarationString() {
final boolean isQuery = "QUERY_".equals(prefix); //UGLY!
final Metamodel entity = getHostingEntity();
final StringBuilder declaration = new StringBuilder();
declaration
.append("\n/**")
.append("\n * The query named {@value ")
.append("\n * The ")
.append(isQuery ? "query" : "entity graph")
.append(" named {@value ")
.append(prefix)
.append(fieldName())
.append("}\n *\n * @see ")
.append("}\n");
if ( query != null ) {
declaration.append(" * <pre>");
query.lines()
.forEach( line -> declaration.append("\n * ").append( line ) );
declaration.append("\n * </pre>\n");
}
declaration
.append(" *\n * @see ")
.append(entity.getQualifiedName())
.append("\n **/\n")
.append("public static volatile ")
Expand All @@ -53,7 +70,7 @@ public String getAttributeDeclarationString() {
.append(' ')
.append('_')
.append(nameToMethodName(getPropertyName()));
if ( "QUERY_".equals(prefix) ) { //UGLY!
if ( isQuery ) {
declaration.append('_');
}
declaration.append(';');
Expand Down
Loading