mirror of
https://github.com/tiennm99/lombok.git
synced 2026-10-13 22:16:11 +00:00
Add configuration key, handle whereever NULLABLE is handled, support Eclipse.
This commit is contained in:
1 parent
7a575e1e5d
commit
79bfcc4f7a
14 files changed
+78
-11
No files matched your search
@@ -563,4 +563,12 @@ public class ConfigurationKeys {
|
||||
* If set to {@code true}, no further {@code lombok.config} files will be checked.
|
||||
*/
|
||||
public static final ConfigurationKey<Boolean> STOP_BUBBLING = new ConfigurationKey<Boolean>("config.stopBubbling", "Tell the configuration system it should stop looking for other configuration files (default: false).") {};
|
||||
|
||||
/**
|
||||
* lombok configuration: {@code lombok.copyAnnotations} += <String: fully-qualified annotation class name>.
|
||||
*
|
||||
* Copy these annotations to getters, setters, etc.
|
||||
*/
|
||||
public static final ConfigurationKey<List<String>> COPY_ANNOTATIONS = new ConfigurationKey<List<String>>("lombok.copyAnnotations", "Copy these annotations to getters, setters, etc.") {};
|
||||
|
||||
}
|
||||
@@ -230,6 +230,11 @@ public class HandlerUtil {
|
||||
|
||||
public static final String DEFAULT_EXCEPTION_FOR_NON_NULL = "java.lang.NullPointerException";
|
||||
|
||||
/** Returns the configuration value for ConfigurationKeys.COPY_ANNOTATIONS. */
|
||||
public static List<String> copyAnnotationNames(AST<?, ?, ?> ast) {
|
||||
return ast.readConfiguration(ConfigurationKeys.COPY_ANNOTATIONS);
|
||||
}
|
||||
|
||||
/**
|
||||
* Generates a getter name from a given field name.
|
||||
*
|
||||
|
||||
@@ -106,6 +106,7 @@ public class HandleBuilder extends EclipseAnnotationHandler<Builder> {
|
||||
}
|
||||
|
||||
private static class BuilderFieldData {
|
||||
Annotation[] annotations;
|
||||
TypeReference type;
|
||||
char[] rawName;
|
||||
char[] name;
|
||||
@@ -199,9 +200,14 @@ public class HandleBuilder extends EclipseAnnotationHandler<Builder> {
|
||||
EclipseNode isDefault = findAnnotation(Builder.Default.class, fieldNode);
|
||||
boolean isFinal = ((fd.modifiers & ClassFileConstants.AccFinal) != 0) || (valuePresent && !hasAnnotation(NonFinal.class, fieldNode));
|
||||
|
||||
Annotation[] nonNulls = findAnnotations(fd, NON_NULL_PATTERN);
|
||||
Annotation[] nullables = findAnnotations(fd, NULLABLE_PATTERN);
|
||||
Annotation[] copyAnnotations = findExactAnnotations(fd, copyAnnotationNames(fieldNode.getAst()));
|
||||
|
||||
BuilderFieldData bfd = new BuilderFieldData();
|
||||
bfd.rawName = fieldNode.getName().toCharArray();
|
||||
bfd.name = removePrefixFromField(fieldNode);
|
||||
bfd.annotations = copyAnnotations(fd, nonNulls, nullables, copyAnnotations);
|
||||
bfd.type = fd.type;
|
||||
bfd.singularData = getSingularData(fieldNode, ast);
|
||||
bfd.originalFieldNode = fieldNode;
|
||||
@@ -744,13 +750,13 @@ public class HandleBuilder extends EclipseAnnotationHandler<Builder> {
|
||||
public void makeSetterMethodsForBuilder(EclipseNode builderType, BuilderFieldData bfd, EclipseNode sourceNode, boolean fluent, boolean chain) {
|
||||
boolean deprecate = isFieldDeprecated(bfd.originalFieldNode);
|
||||
if (bfd.singularData == null || bfd.singularData.getSingularizer() == null) {
|
||||
makeSimpleSetterMethodForBuilder(builderType, deprecate, bfd.createdFields.get(0), bfd.nameOfSetFlag, sourceNode, fluent, chain);
|
||||
makeSimpleSetterMethodForBuilder(builderType, deprecate, bfd.createdFields.get(0), bfd.nameOfSetFlag, sourceNode, fluent, chain, bfd.annotations);
|
||||
} else {
|
||||
bfd.singularData.getSingularizer().generateMethods(bfd.singularData, deprecate, builderType, fluent, chain);
|
||||
}
|
||||
}
|
||||
|
||||
private void makeSimpleSetterMethodForBuilder(EclipseNode builderType, boolean deprecate, EclipseNode fieldNode, char[] nameOfSetFlag, EclipseNode sourceNode, boolean fluent, boolean chain) {
|
||||
private void makeSimpleSetterMethodForBuilder(EclipseNode builderType, boolean deprecate, EclipseNode fieldNode, char[] nameOfSetFlag, EclipseNode sourceNode, boolean fluent, boolean chain, Annotation[] annotations) {
|
||||
TypeDeclaration td = (TypeDeclaration) builderType.get();
|
||||
AbstractMethodDeclaration[] existing = td.methods;
|
||||
if (existing == null) existing = EMPTY;
|
||||
@@ -767,7 +773,7 @@ public class HandleBuilder extends EclipseAnnotationHandler<Builder> {
|
||||
String setterName = fluent ? fieldNode.getName() : HandlerUtil.buildAccessorName("set", fieldNode.getName());
|
||||
|
||||
MethodDeclaration setter = HandleSetter.createSetter(td, deprecate, fieldNode, setterName, nameOfSetFlag, chain, ClassFileConstants.AccPublic,
|
||||
sourceNode, Collections.<Annotation>emptyList(), Collections.<Annotation>emptyList());
|
||||
sourceNode, Collections.<Annotation>emptyList(), Arrays.asList(annotations));
|
||||
injectMethod(builderType, setter);
|
||||
}
|
||||
|
||||
|
||||
@@ -405,11 +405,12 @@ public class HandleConstructor {
|
||||
Argument parameter = new Argument(fieldName, fieldPos, copyType(field.type, source), Modifier.FINAL);
|
||||
Annotation[] nonNulls = findAnnotations(field, NON_NULL_PATTERN);
|
||||
Annotation[] nullables = findAnnotations(field, NULLABLE_PATTERN);
|
||||
Annotation[] copyAnnotations = findExactAnnotations(field, copyAnnotationNames(fieldNode.getAst()));
|
||||
if (nonNulls.length != 0) {
|
||||
Statement nullCheck = generateNullCheck(parameter, sourceNode);
|
||||
if (nullCheck != null) nullChecks.add(nullCheck);
|
||||
}
|
||||
parameter.annotations = copyAnnotations(source, nonNulls, nullables);
|
||||
parameter.annotations = copyAnnotations(source, nonNulls, nullables, copyAnnotations);
|
||||
params.add(parameter);
|
||||
}
|
||||
|
||||
|
||||
@@ -274,6 +274,7 @@ public class HandleGetter extends EclipseAnnotationHandler<Getter> {
|
||||
onMethod.toArray(new Annotation[0]),
|
||||
findAnnotations(field, NON_NULL_PATTERN),
|
||||
findAnnotations(field, NULLABLE_PATTERN),
|
||||
findExactAnnotations(field, copyAnnotationNames(fieldNode.getAst())),
|
||||
findDelegatesAndMarkAsHandled(fieldNode),
|
||||
deprecated);
|
||||
}
|
||||
|
||||
@@ -238,6 +238,7 @@ public class HandleSetter extends EclipseAnnotationHandler<Setter> {
|
||||
|
||||
Annotation[] nonNulls = findAnnotations(field, NON_NULL_PATTERN);
|
||||
Annotation[] nullables = findAnnotations(field, NULLABLE_PATTERN);
|
||||
Annotation[] copyAnnotations = findExactAnnotations(field, copyAnnotationNames(fieldNode.getAst()));
|
||||
List<Statement> statements = new ArrayList<Statement>(5);
|
||||
if (nonNulls.length == 0) {
|
||||
statements.add(assignment);
|
||||
@@ -255,7 +256,7 @@ public class HandleSetter extends EclipseAnnotationHandler<Setter> {
|
||||
statements.add(returnStatement);
|
||||
}
|
||||
method.statements = statements.toArray(new Statement[0]);
|
||||
param.annotations = copyAnnotations(source, nonNulls, nullables, onParam.toArray(new Annotation[0]));
|
||||
param.annotations = copyAnnotations(source, nonNulls, nullables, copyAnnotations, onParam.toArray(new Annotation[0]));
|
||||
|
||||
method.traverse(new SetGeneratedByVisitor(source), parent.scope);
|
||||
return method;
|
||||
|
||||
@@ -242,6 +242,7 @@ public class HandleWither extends EclipseAnnotationHandler<Wither> {
|
||||
|
||||
Annotation[] nonNulls = findAnnotations(field, NON_NULL_PATTERN);
|
||||
Annotation[] nullables = findAnnotations(field, NULLABLE_PATTERN);
|
||||
Annotation[] copyAnnotations = findExactAnnotations(field, copyAnnotationNames(fieldNode.getAst()));
|
||||
|
||||
if (!makeAbstract) {
|
||||
List<Expression> args = new ArrayList<Expression>();
|
||||
@@ -285,7 +286,7 @@ public class HandleWither extends EclipseAnnotationHandler<Wither> {
|
||||
|
||||
method.statements = statements.toArray(new Statement[0]);
|
||||
}
|
||||
param.annotations = copyAnnotations(source, nonNulls, nullables, onParam.toArray(new Annotation[0]));
|
||||
param.annotations = copyAnnotations(source, nonNulls, nullables, copyAnnotations, onParam.toArray(new Annotation[0]));
|
||||
|
||||
method.traverse(new SetGeneratedByVisitor(source), parent.scope);
|
||||
return method;
|
||||
|
||||
@@ -149,10 +149,15 @@ public class HandleBuilder extends JavacAnnotationHandler<Builder> {
|
||||
JCVariableDecl fd = (JCVariableDecl) fieldNode.get();
|
||||
JavacNode isDefault = findAnnotation(Builder.Default.class, fieldNode, false);
|
||||
boolean isFinal = (fd.mods.flags & Flags.FINAL) != 0 || (valuePresent && !hasAnnotation(NonFinal.class, fieldNode));
|
||||
|
||||
List<JCAnnotation> nonNulls = findAnnotations(fieldNode, NON_NULL_PATTERN);
|
||||
List<JCAnnotation> nullables = findAnnotations(fieldNode, NULLABLE_PATTERN);
|
||||
List<JCAnnotation> copyAnnotations = findExactAnnotations(fieldNode, copyAnnotationNames(fieldNode.getAst()));
|
||||
|
||||
BuilderFieldData bfd = new BuilderFieldData();
|
||||
bfd.rawName = fd.name;
|
||||
bfd.name = removePrefixFromField(fieldNode);
|
||||
bfd.annotations = fd.mods.annotations;
|
||||
bfd.annotations = nonNulls.appendList(nullables).appendList(copyAnnotations);
|
||||
bfd.type = fd.vartype;
|
||||
bfd.singularData = getSingularData(fieldNode);
|
||||
bfd.originalFieldNode = fieldNode;
|
||||
|
||||
@@ -331,8 +331,9 @@ public class HandleConstructor {
|
||||
Name rawName = field.name;
|
||||
List<JCAnnotation> nonNulls = findAnnotations(fieldNode, NON_NULL_PATTERN);
|
||||
List<JCAnnotation> nullables = findAnnotations(fieldNode, NULLABLE_PATTERN);
|
||||
List<JCAnnotation> copyAnnotations = findExactAnnotations(fieldNode, copyAnnotationNames(fieldNode.getAst()));
|
||||
long flags = JavacHandlerUtil.addFinalIfNeeded(Flags.PARAMETER, typeNode.getContext());
|
||||
JCVariableDecl param = maker.VarDef(maker.Modifiers(flags, nonNulls.appendList(nullables)), fieldName, field.vartype, null);
|
||||
JCVariableDecl param = maker.VarDef(maker.Modifiers(flags, nonNulls.appendList(nullables).appendList(copyAnnotations)), fieldName, field.vartype, null);
|
||||
params.append(param);
|
||||
if (!nonNulls.isEmpty()) {
|
||||
JCStatement nullCheck = generateNullCheck(maker, fieldNode, param, source);
|
||||
|
||||
@@ -245,10 +245,11 @@ public class HandleGetter extends JavacAnnotationHandler<Getter> {
|
||||
|
||||
List<JCAnnotation> nonNulls = findAnnotations(field, NON_NULL_PATTERN);
|
||||
List<JCAnnotation> nullables = findAnnotations(field, NULLABLE_PATTERN);
|
||||
List<JCAnnotation> copyAnnotations = findExactAnnotations(field, copyAnnotationNames(field.getAst()));
|
||||
|
||||
List<JCAnnotation> delegates = findDelegatesAndRemoveFromField(field);
|
||||
|
||||
List<JCAnnotation> annsOnMethod = copyAnnotations(onMethod).appendList(nonNulls).appendList(nullables);
|
||||
List<JCAnnotation> annsOnMethod = copyAnnotations(onMethod).appendList(nonNulls).appendList(nullables).appendList(copyAnnotations);
|
||||
if (isFieldDeprecated(field)) {
|
||||
annsOnMethod = annsOnMethod.prepend(treeMaker.Annotation(genJavaLangTypeRef(field, "Deprecated"), List.<JCExpression>nil()));
|
||||
}
|
||||
|
||||
@@ -228,9 +228,10 @@ public class HandleSetter extends JavacAnnotationHandler<Setter> {
|
||||
ListBuffer<JCStatement> statements = new ListBuffer<JCStatement>();
|
||||
List<JCAnnotation> nonNulls = findAnnotations(field, NON_NULL_PATTERN);
|
||||
List<JCAnnotation> nullables = findAnnotations(field, NULLABLE_PATTERN);
|
||||
List<JCAnnotation> copyAnnotations = findExactAnnotations(field, copyAnnotationNames(field.getAst()));
|
||||
|
||||
Name methodName = field.toName(setterName);
|
||||
List<JCAnnotation> annsOnParam = copyAnnotations(onParam).appendList(nonNulls).appendList(nullables);
|
||||
List<JCAnnotation> annsOnParam = copyAnnotations(onParam).appendList(nonNulls).appendList(nullables).appendList(copyAnnotations);
|
||||
|
||||
long flags = JavacHandlerUtil.addFinalIfNeeded(Flags.PARAMETER, field.getContext());
|
||||
JCVariableDecl param = treeMaker.VarDef(treeMaker.Modifiers(flags, annsOnParam), fieldDecl.name, fieldDecl.vartype, null);
|
||||
|
||||
@@ -224,6 +224,7 @@ public class HandleWither extends JavacAnnotationHandler<Wither> {
|
||||
|
||||
List<JCAnnotation> nonNulls = findAnnotations(field, NON_NULL_PATTERN);
|
||||
List<JCAnnotation> nullables = findAnnotations(field, NULLABLE_PATTERN);
|
||||
List<JCAnnotation> copyAnnotations = findExactAnnotations(field, copyAnnotationNames(field.getAst()));
|
||||
|
||||
Name methodName = field.toName(witherName);
|
||||
|
||||
@@ -231,7 +232,7 @@ public class HandleWither extends JavacAnnotationHandler<Wither> {
|
||||
|
||||
JCBlock methodBody = null;
|
||||
long flags = JavacHandlerUtil.addFinalIfNeeded(Flags.PARAMETER, field.getContext());
|
||||
List<JCAnnotation> annsOnParam = copyAnnotations(onParam).appendList(nonNulls).appendList(nullables);
|
||||
List<JCAnnotation> annsOnParam = copyAnnotations(onParam).appendList(nonNulls).appendList(nullables).appendList(copyAnnotations);
|
||||
|
||||
JCVariableDecl param = maker.VarDef(maker.Modifiers(flags, annsOnParam), fieldDecl.name, fieldDecl.vartype, null);
|
||||
|
||||
|
||||
@@ -1335,6 +1335,23 @@ public class JavacHandlerUtil {
|
||||
return result.toList();
|
||||
}
|
||||
|
||||
/**
|
||||
* Searches the given field node for annotations and returns each one that matches the provided list of names.
|
||||
*/
|
||||
public static List<JCAnnotation> findExactAnnotations(JavacNode fieldNode, java.util.List<String> names) {
|
||||
ListBuffer<JCAnnotation> result = new ListBuffer<JCAnnotation>();
|
||||
for (JavacNode child : fieldNode.down()) {
|
||||
if (child.getKind() == Kind.ANNOTATION) {
|
||||
JCAnnotation annotation = (JCAnnotation) child.get();
|
||||
String annoname = annotation.annotationType.toString();
|
||||
if (names.contains(annoname)) {
|
||||
result.append(annotation);
|
||||
}
|
||||
}
|
||||
}
|
||||
return result.toList();
|
||||
}
|
||||
|
||||
/**
|
||||
* Generates a new statement that checks if the given variable is null, and if so, throws a configured exception with the
|
||||
* variable name as message.
|
||||
|
||||
@@ -155,6 +155,24 @@ public class Eclipse {
|
||||
return result.toArray(EMPTY_ANNOTATIONS_ARRAY);
|
||||
}
|
||||
|
||||
/**
|
||||
* Searches the given field node for annotations and returns each one that matches the provided list of names.
|
||||
*/
|
||||
public static Annotation[] findExactAnnotations(FieldDeclaration field, List<String> names) {
|
||||
List<Annotation> result = new ArrayList<Annotation>();
|
||||
if (field.annotations == null) return EMPTY_ANNOTATIONS_ARRAY;
|
||||
for (Annotation annotation : field.annotations) {
|
||||
TypeReference typeRef = annotation.type;
|
||||
if (typeRef != null && typeRef.getTypeName() != null) {
|
||||
String annoname = toQualifiedName(typeRef.getTypeName());
|
||||
if (names.contains(annoname)) {
|
||||
result.add(annotation);
|
||||
}
|
||||
}
|
||||
}
|
||||
return result.toArray(EMPTY_ANNOTATIONS_ARRAY);
|
||||
}
|
||||
|
||||
/** Matches any of the 8 primitive names, such as {@code boolean}. */
|
||||
private static final Pattern PRIMITIVE_TYPE_NAME_PATTERN = Pattern.compile(
|
||||
"^(boolean|byte|short|int|long|float|double|char)$");
|
||||
|
||||
Reference in new issue
Block a user