![JAR search and dependency download from the Maven repository](/logo.png)
lombok.javac.handlers.HandleBuilderAndExtension Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of lombok-pg Show documentation
Show all versions of lombok-pg Show documentation
lombok-pg is a collection of extensions to Project Lombok
/*
* Copyright © 2010-2011 Philipp Eichhorn
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package lombok.javac.handlers;
import static lombok.core.util.ErrorMessages.*;
import static lombok.core.util.Names.*;
import static lombok.javac.handlers.JavacHandlerUtil.*;
import static com.sun.tools.javac.code.Flags.*;
import java.util.*;
import lombok.*;
import lombok.core.AnnotationValues;
import lombok.core.handlers.BuilderAndExtensionHandler;
import lombok.core.handlers.BuilderAndExtensionHandler.IExtensionCollector;
import lombok.javac.JavacASTVisitor;
import lombok.javac.JavacAnnotationHandler;
import lombok.javac.JavacNode;
import lombok.javac.handlers.ast.JavacField;
import lombok.javac.handlers.ast.JavacMethod;
import lombok.javac.handlers.ast.JavacType;
import com.sun.tools.javac.tree.JCTree;
import com.sun.tools.javac.tree.JCTree.JCAssign;
import com.sun.tools.javac.tree.JCTree.JCAnnotation;
import com.sun.tools.javac.tree.JCTree.JCMethodDecl;
import org.mangosdk.spi.ProviderFor;
public class HandleBuilderAndExtension {
/**
* Handles the {@code lombok.Builder} annotation for javac.
*/
@ProviderFor(JavacAnnotationHandler.class)
public static class HandleBuilder extends JavacAnnotationHandler {
@Override
public void handle(final AnnotationValues annotation, final JCAnnotation source, final JavacNode annotationNode) {
deleteAnnotationIfNeccessary(annotationNode, Builder.class);
final JavacType type = JavacType.typeOf(annotationNode, source);
if (type.isInterface() || type.isEnum() || type.isAnnotation()) {
annotationNode.addError(canBeUsedOnClassOnly(Builder.class));
return;
}
switch (methodExists(decapitalize(type.name()), type.node(), false, 0)) {
case EXISTS_BY_LOMBOK:
return;
case EXISTS_BY_USER:
final String message = "Not generating 'public static %s %s()' A method with that name already exists";
annotationNode.addWarning(String.format(message, BuilderAndExtensionHandler.BUILDER, decapitalize(type.name())));
return;
default:
case NOT_EXISTS:
// continue with creating the builder
}
new JavacBuilderAndExtensionHandler().handleBuilder(type, annotation.getInstance());
}
}
/**
* Handles the {@code lombok.Builder.Extension} annotation for javac.
*/
@ProviderFor(JavacAnnotationHandler.class)
public static class HandleBuilderExtension extends JavacAnnotationHandler {
@Override
public void handle(final AnnotationValues annotation, final JCAnnotation source, final JavacNode annotationNode) {
deleteAnnotationIfNeccessary(annotationNode, Builder.Extension.class);
final JavacMethod method = JavacMethod.methodOf(annotationNode, source);
if (method == null) {
annotationNode.addError(canBeUsedOnMethodOnly(Builder.Extension.class));
return;
}
if (method.isAbstract() || method.isEmpty()) {
annotationNode.addError(canBeUsedOnConcreteMethodOnly(Builder.Extension.class));
return;
}
JavacType type = JavacType.typeOf(annotationNode, source);
JavacNode builderNode = type.getAnnotation(Builder.class);
if (builderNode == null) {
annotationNode.addError("@Builder.Extension is only allowed in types annotated with @Builder");
return;
}
AnnotationValues builderAnnotation = createAnnotation(Builder.class, builderNode);
if (!type.hasMethod(decapitalize(type.name()), 0)) {
new HandleBuilder().handle(builderAnnotation, (JCAnnotation) builderNode.get(), builderNode);
}
new JavacBuilderAndExtensionHandler().handleExtension(type, method, new JavacParameterValidator(), new JavacParameterSanitizer(), builderAnnotation.getInstance());
}
}
private static class JavacBuilderAndExtensionHandler extends BuilderAndExtensionHandler {
@Override
protected void collectExtensions(final JavacMethod method, final IExtensionCollector collector) {
method.node().traverse((JavacASTVisitor) collector);
}
@Override
protected IExtensionCollector getExtensionCollector() {
return new ExtensionCollector();
}
}
private static class ExtensionCollector extends JavacASTAdapterWithTypeDepth implements IExtensionCollector {
private final Set allRequiredFieldNames = new HashSet();
private final Set requiredFieldNames = new HashSet();
@Getter
private boolean isRequiredFieldsExtension;
@Getter
private boolean isExtension;
private boolean containsRequiredFields;
public ExtensionCollector() {
super(1);
}
@Override
public ExtensionCollector withRequiredFieldNames(final List fieldNames) {
allRequiredFieldNames.clear();
allRequiredFieldNames.addAll(fieldNames);
return this;
}
@Override
public void visitMethod(final JavacNode methodNode, final JCMethodDecl method) {
if (isOfInterest() && !"".equals(method.name.toString())) {
containsRequiredFields = false;
isRequiredFieldsExtension = false;
isExtension = false;
requiredFieldNames.clear();
requiredFieldNames.addAll(allRequiredFieldNames);
}
}
@Override
public void visitStatement(final JavacNode statementNode, final JCTree statement) {
if (isOfInterest()) {
if (statement instanceof JCAssign) {
JCAssign assign = (JCAssign) statement;
String fieldName = assign.lhs.toString();
if (fieldName.startsWith("this.")) {
fieldName = fieldName.substring(5);
}
if (requiredFieldNames.remove(fieldName)) {
containsRequiredFields = true;
}
}
}
}
@Override
public void endVisitMethod(final JavacNode methodNode, final JCMethodDecl method) {
if (isOfInterest() && !"".equals(method.name.toString())) {
if (((method.mods.flags & PRIVATE) != 0) && "void".equals(method.restype.toString())) {
if (containsRequiredFields) {
if (requiredFieldNames.isEmpty()) {
isRequiredFieldsExtension = true;
isExtension = true;
} else {
methodNode.addWarning("@Builder.Extension: The method '" + methodNode.getName() + "' does not contain all required fields and was skipped.");
}
} else {
isExtension = true;
}
} else {
methodNode.addWarning("@Builder.Extension: The method '" + methodNode.getName() + "' is not a valid extension and was skipped.");
}
}
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy