org.inferred.freebuilder.processor.OptionalPropertyFactory Maven / Gradle / Ivy
Show all versions of freebuilder Show documentation
/*
* Copyright 2014 Google Inc. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.inferred.freebuilder.processor;
import static org.inferred.freebuilder.processor.BuilderMethods.clearMethod;
import static org.inferred.freebuilder.processor.BuilderMethods.getter;
import static org.inferred.freebuilder.processor.BuilderMethods.mapper;
import static org.inferred.freebuilder.processor.BuilderMethods.nullableSetter;
import static org.inferred.freebuilder.processor.BuilderMethods.setter;
import static org.inferred.freebuilder.processor.Util.erasesToAnyOf;
import static org.inferred.freebuilder.processor.Util.upperBound;
import static org.inferred.freebuilder.processor.util.ModelUtils.maybeDeclared;
import static org.inferred.freebuilder.processor.util.ModelUtils.maybeUnbox;
import static org.inferred.freebuilder.processor.util.feature.FunctionPackage.FUNCTION_PACKAGE;
import javax.lang.model.type.DeclaredType;
import javax.lang.model.type.TypeMirror;
import javax.lang.model.type.WildcardType;
import javax.lang.model.util.SimpleTypeVisitor6;
import org.inferred.freebuilder.processor.Metadata.Property;
import org.inferred.freebuilder.processor.PropertyCodeGenerator.Config;
import org.inferred.freebuilder.processor.util.ParameterizedType;
import org.inferred.freebuilder.processor.util.PreconditionExcerpts;
import org.inferred.freebuilder.processor.util.QualifiedName;
import org.inferred.freebuilder.processor.util.SourceBuilder;
import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.Optional;
/**
* {@link PropertyCodeGenerator.Factory} providing a default value (absent) and convenience
* setter methods for {@link Optional} properties.
*/
public class OptionalPropertyFactory implements PropertyCodeGenerator.Factory {
@VisibleForTesting
static enum OptionalType {
GUAVA(QualifiedName.of(Optional.class), "absent", "fromNullable") {
@Override
protected void applyMapper(SourceBuilder code, Metadata metadata, Property property) {
// Guava's transform method throws a NullPointerException if mapper returns null,
// and it has no flatMap-equivalent. We choose to follow the Java 8 convention of
// turning a null into an empty (absent) optional as that is the de facto standard
// now.
code.add(PreconditionExcerpts.checkNotNull("mapper"))
.addLine(" %s old%s = %s();",
property.getType(), property.getCapitalizedName(), getter(property))
.addLine(" if (old%s.isPresent()) {", property.getCapitalizedName())
.addLine(" %s(mapper.apply(old%s.get()));",
nullableSetter(property), property.getCapitalizedName())
.addLine(" }")
.addLine(" return (%s) this;", metadata.getBuilder());
}
},
JAVA8(QualifiedName.of("java.util", "Optional"), "empty", "ofNullable") {
@Override
protected void applyMapper(SourceBuilder code, Metadata metadata, Property property) {
code.addLine(" return %s(%s().map(mapper));", setter(property), getter(property));
}
};
private final QualifiedName cls;
private final String empty;
private final String ofNullable;
private OptionalType(QualifiedName cls, String empty, String ofNullable) {
this.cls = cls;
this.empty = empty;
this.ofNullable = ofNullable;
}
protected abstract void applyMapper(SourceBuilder code, Metadata metadata, Property property);
}
@Override
public Optional create(Config config) {
DeclaredType type = maybeDeclared(config.getProperty().getType()).orNull();
if (type == null) {
return Optional.absent();
}
OptionalType optionalType = maybeOptional(type).orNull();
if (optionalType == null) {
return Optional.absent();
}
TypeMirror elementType = upperBound(config.getElements(), type.getTypeArguments().get(0));
Optional unboxedType = maybeUnbox(elementType, config.getTypes());
// Issue 29: In Java 7 and earlier, wildcards are not correctly handled when inferring the
// type parameter of a static method (i.e. Optional.fromNullable(t)). We need to set the
// type parameter explicitly (i.e. Optional.fromNullable(t)).
boolean requiresExplicitTypeParameters = HAS_WILDCARD.visit(elementType);
return Optional.of(new CodeGenerator(
config.getProperty(),
optionalType,
elementType,
unboxedType,
requiresExplicitTypeParameters));
}
private static Optional maybeOptional(DeclaredType type) {
for (OptionalType optionalType : OptionalType.values()) {
if (erasesToAnyOf(type, optionalType.cls)) {
return Optional.of(optionalType);
}
}
return Optional.absent();
}
@VisibleForTesting static class CodeGenerator extends PropertyCodeGenerator {
private final OptionalType optional;
private final TypeMirror elementType;
private final Optional unboxedType;
private final boolean requiresExplicitTypeParameters;
@VisibleForTesting CodeGenerator(
Property property,
OptionalType optional,
TypeMirror elementType,
Optional unboxedType,
boolean requiresExplicitTypeParametersInJava7) {
super(property);
this.optional = optional;
this.elementType = elementType;
this.unboxedType = unboxedType;
this.requiresExplicitTypeParameters = requiresExplicitTypeParametersInJava7;
}
@Override
public Type getType() {
return Type.OPTIONAL;
}
@Override
public void addValueFieldDeclaration(SourceBuilder code, String finalField) {
code.addLine("// Store a nullable object instead of an Optional. Escape analysis then")
.addLine("// allows the JVM to optimize away the Optional objects created by our")
.addLine("// getter method.")
.addLine("private final %s %s;", elementType, finalField);
}
@Override
public void addBuilderFieldDeclaration(SourceBuilder code) {
code.addLine("// Store a nullable object instead of an Optional. Escape analysis then")
.addLine("// allows the JVM to optimize away the Optional objects created by and")
.addLine("// passed to our API.")
.addLine("private %s %s = null;", elementType, property.getName());
}
@Override
public void addBuilderFieldAccessors(SourceBuilder code, Metadata metadata) {
addSetter(code, metadata);
addOptionalSetter(code, metadata);
addNullableSetter(code, metadata);
addMapper(code, metadata);
addClear(code, metadata);
addGetter(code, metadata);
}
private void addSetter(SourceBuilder code, Metadata metadata) {
code.addLine("")
.addLine("/**")
.addLine(" * Sets the value to be returned by %s.",
metadata.getType().javadocNoArgMethodLink(property.getGetterName()))
.addLine(" *")
.addLine(" * @return this {@code %s} object", metadata.getBuilder().getSimpleName());
if (!unboxedType.isPresent()) {
code.addLine(" * @throws NullPointerException if {@code %s} is null", property.getName());
}
code.addLine(" */")
.addLine("public %s %s(%s %s) {",
metadata.getBuilder(),
setter(property),
unboxedType.or(elementType),
property.getName());
if (unboxedType.isPresent()) {
code.addLine(" this.%1$s = %1$s;", property.getName());
} else {
code.add(PreconditionExcerpts.checkNotNullPreamble(property.getName()))
.addLine(" this.%s = %s;",
property.getName(), PreconditionExcerpts.checkNotNullInline(property.getName()));
}
code.addLine(" return (%s) this;", metadata.getBuilder())
.addLine("}");
}
private void addOptionalSetter(SourceBuilder code, Metadata metadata) {
code.addLine("")
.addLine("/**")
.addLine(" * Sets the value to be returned by %s.",
metadata.getType().javadocNoArgMethodLink(property.getGetterName()))
.addLine(" *")
.addLine(" * @return this {@code %s} object", metadata.getBuilder().getSimpleName())
.addLine(" */");
addAccessorAnnotations(code);
code.addLine("public %s %s(%s %s) {",
metadata.getBuilder(),
setter(property),
optional.cls,
elementType,
property.getName())
.addLine(" if (%s.isPresent()) {", property.getName())
.addLine(" return %s(%s.get());", setter(property), property.getName())
.addLine(" } else {")
.addLine(" return %s();", clearMethod(property))
.addLine(" }")
.addLine("}");
}
private void addNullableSetter(SourceBuilder code, Metadata metadata) {
code.addLine("")
.addLine("/**")
.addLine(" * Sets the value to be returned by %s.",
metadata.getType().javadocNoArgMethodLink(property.getGetterName()))
.addLine(" *")
.addLine(" * @return this {@code %s} object", metadata.getBuilder().getSimpleName())
.addLine(" */")
.addLine("public %s %s(@%s %s %s) {",
metadata.getBuilder(),
nullableSetter(property),
javax.annotation.Nullable.class,
elementType,
property.getName())
.addLine(" if (%s != null) {", property.getName())
.addLine(" return %s(%s);", setter(property), property.getName())
.addLine(" } else {")
.addLine(" return %s();", clearMethod(property))
.addLine(" }")
.addLine("}");
}
private void addMapper(SourceBuilder code, Metadata metadata) {
ParameterizedType unaryOperator = code.feature(FUNCTION_PACKAGE).unaryOperator().orNull();
if (unaryOperator == null) {
return;
}
code.addLine("")
.addLine("/**")
.addLine(" * If the value to be returned by %s is present,",
metadata.getType().javadocNoArgMethodLink(property.getGetterName()))
.addLine(" * replaces it by applying {@code mapper} to it and using the result.")
.addLine(" *")
.addLine(" * If the result is null, clears the value.")
.addLine(" *")
.addLine(" * @return this {@code %s} object", metadata.getBuilder().getSimpleName())
.addLine(" * @throws NullPointerException if {@code mapper} is null")
.addLine(" */")
.addLine("public %s %s(%s mapper) {",
metadata.getBuilder(),
mapper(property),
unaryOperator.withParameters(elementType));
optional.applyMapper(code, metadata, property);
code.addLine("}");
}
private void addClear(SourceBuilder code, Metadata metadata) {
code.addLine("")
.addLine("/**")
.addLine(" * Sets the value to be returned by %s",
metadata.getType().javadocNoArgMethodLink(property.getGetterName()))
.addLine(" * to {@link %1$s#%2$s() Optional.%2$s()}.", optional.cls, optional.empty)
.addLine(" *")
.addLine(" * @return this {@code %s} object", metadata.getBuilder().getSimpleName())
.addLine(" */")
.addLine("public %s %s() {", metadata.getBuilder(), clearMethod(property))
.addLine(" this.%s = null;", property.getName())
.addLine(" return (%s) this;", metadata.getBuilder())
.addLine("}");
}
private void addGetter(SourceBuilder code, Metadata metadata) {
code.addLine("")
.addLine("/**")
.addLine(" * Returns the value that will be returned by %s.",
metadata.getType().javadocNoArgMethodLink(property.getGetterName()))
.addLine(" */")
.addLine("public %s %s() {", property.getType(), getter(property));
code.add(" return %s.", optional.cls);
if (requiresExplicitTypeParameters) {
code.add("<%s>", elementType);
}
code.add("%s(%s);\n", optional.ofNullable, property.getName())
.addLine("}");
}
@Override
public void addFinalFieldAssignment(SourceBuilder code, String finalField, String builder) {
code.addLine("%s = %s.%s;", finalField, builder, property.getName());
}
@Override
public void addMergeFromValue(SourceBuilder code, String value) {
code.addLine("%s(%s.%s());", setter(property), value, property.getGetterName());
}
@Override
public void addMergeFromBuilder(SourceBuilder code, Metadata metadata, String builder) {
code.addLine("%s(%s.%s());", setter(property), builder, getter(property));
}
@Override
public void addReadValueFragment(SourceBuilder code, String finalField) {
code.add("%s.", optional.cls);
if (requiresExplicitTypeParameters) {
code.add("<%s>", elementType);
}
code.add("%s(%s)", optional.ofNullable, finalField);
}
@Override
public void addSetFromResult(SourceBuilder code, String builder, String variable) {
code.addLine("%s.%s(%s);", builder, setter(property), variable);
}
@Override
public boolean isTemplateRequiredInClear() {
return true;
}
@Override
public void addClear(SourceBuilder code, String template) {
code.addLine("%1$s = %2$s.%1$s;", property.getName(), template);
}
@Override
public void addPartialClear(SourceBuilder code) {
code.addLine("%s = null;", property.getName());
}
}
private static final SimpleTypeVisitor6 HAS_WILDCARD =
new SimpleTypeVisitor6() {
@Override protected Boolean defaultAction(TypeMirror e, Void p) {
return false;
}
@Override
public Boolean visitDeclared(DeclaredType t, Void p) {
for (TypeMirror typeArgument : t.getTypeArguments()) {
if (visit(typeArgument)) {
return true;
}
}
return false;
}
@Override
public Boolean visitWildcard(WildcardType t, Void p) {
return true;
}
};
}