diff options
20 files changed, 18 insertions, 32 deletions
diff --git a/common/src/main/java/com/google/auto/common/MoreTypes.java b/common/src/main/java/com/google/auto/common/MoreTypes.java index e09680bc..eb34717d 100644 --- a/common/src/main/java/com/google/auto/common/MoreTypes.java +++ b/common/src/main/java/com/google/auto/common/MoreTypes.java @@ -873,7 +873,7 @@ public final class MoreTypes { * {@link Optional#absent()} if {@code type} is an interface or {@link Object} or its superclass * is {@link Object}. */ - // TODO(user): Remove unused parameter Elements? + // TODO(bcorso): Remove unused parameter Elements? public static Optional<DeclaredType> nonObjectSuperclass(Types types, Elements elements, DeclaredType type) { checkNotNull(types); @@ -1005,7 +1005,7 @@ public final class MoreTypes { } return true; } - + private static boolean isJavaLangObject(TypeMirror type) { if (type.getKind() != TypeKind.DECLARED) { return false; diff --git a/common/src/test/java/com/google/auto/common/AnnotationMirrorsTest.java b/common/src/test/java/com/google/auto/common/AnnotationMirrorsTest.java index dfc043ab..f63ee031 100644 --- a/common/src/test/java/com/google/auto/common/AnnotationMirrorsTest.java +++ b/common/src/test/java/com/google/auto/common/AnnotationMirrorsTest.java @@ -211,5 +211,4 @@ public class AnnotationMirrorsTest { private AnnotationMirror annotationOn(Class<?> clazz) { return getOnlyElement(elements.getTypeElement(clazz.getCanonicalName()).getAnnotationMirrors()); } - } diff --git a/factory/src/it/functional/src/main/java/com/google/auto/factory/ReferencePackage.java b/factory/src/it/functional/src/main/java/com/google/auto/factory/ReferencePackage.java index 22aff651..22aff651 100644..100755 --- a/factory/src/it/functional/src/main/java/com/google/auto/factory/ReferencePackage.java +++ b/factory/src/it/functional/src/main/java/com/google/auto/factory/ReferencePackage.java diff --git a/factory/src/it/functional/src/main/java/com/google/auto/factory/otherpackage/OtherPackage.java b/factory/src/it/functional/src/main/java/com/google/auto/factory/otherpackage/OtherPackage.java index b9925a18..b9925a18 100644..100755 --- a/factory/src/it/functional/src/main/java/com/google/auto/factory/otherpackage/OtherPackage.java +++ b/factory/src/it/functional/src/main/java/com/google/auto/factory/otherpackage/OtherPackage.java diff --git a/factory/src/test/resources/expected/ConstructorAnnotatedNonFinalFactory.java b/factory/src/test/resources/expected/ConstructorAnnotatedNonFinalFactory.java index f662642d..528ea03f 100644 --- a/factory/src/test/resources/expected/ConstructorAnnotatedNonFinalFactory.java +++ b/factory/src/test/resources/expected/ConstructorAnnotatedNonFinalFactory.java @@ -25,7 +25,7 @@ import javax.inject.Provider; ) class ConstructorAnnotatedNonFinalFactory { private final Provider<Object> objProvider; - + @Inject ConstructorAnnotatedNonFinalFactory(Provider<Object> objProvider) { this.objProvider = checkNotNull(objProvider, 1); } @@ -37,11 +37,11 @@ class ConstructorAnnotatedNonFinalFactory { ConstructorAnnotatedNonFinal create(String s) { return new ConstructorAnnotatedNonFinal(checkNotNull(s, 1)); } - + ConstructorAnnotatedNonFinal create(int i) { return new ConstructorAnnotatedNonFinal(checkNotNull(objProvider.get(), 1), i); } - + ConstructorAnnotatedNonFinal create(char c) { return new ConstructorAnnotatedNonFinal(checkNotNull(objProvider.get(), 1), c); } diff --git a/factory/src/test/resources/expected/FactoryImplementingCreateMethod_ConcreteClassFactory.java b/factory/src/test/resources/expected/FactoryImplementingCreateMethod_ConcreteClassFactory.java index f23dc9ab..1f3bb0e3 100644 --- a/factory/src/test/resources/expected/FactoryImplementingCreateMethod_ConcreteClassFactory.java +++ b/factory/src/test/resources/expected/FactoryImplementingCreateMethod_ConcreteClassFactory.java @@ -28,7 +28,7 @@ final class FactoryImplementingCreateMethod_ConcreteClassFactory @Inject FactoryImplementingCreateMethod_ConcreteClassFactory() {} - + @Override public FactoryImplementingCreateMethod.ConcreteClass create() { return new FactoryImplementingCreateMethod.ConcreteClass(); @@ -44,7 +44,7 @@ final class FactoryImplementingCreateMethod_ConcreteClassFactory return new FactoryImplementingCreateMethod.ConcreteClass( checkNotNull(genericWithDifferentArgumentName, 1)); } - + FactoryImplementingCreateMethod.ConcreteClass create(int a, boolean b) { return new FactoryImplementingCreateMethod.ConcreteClass(a, b); } diff --git a/factory/src/test/resources/expected/NestedClasses_SimpleNestedClassFactory.java b/factory/src/test/resources/expected/NestedClasses_SimpleNestedClassFactory.java index f982e86f..041737fe 100644 --- a/factory/src/test/resources/expected/NestedClasses_SimpleNestedClassFactory.java +++ b/factory/src/test/resources/expected/NestedClasses_SimpleNestedClassFactory.java @@ -24,7 +24,7 @@ import javax.inject.Inject; ) final class NestedClasses_SimpleNestedClassFactory { @Inject NestedClasses_SimpleNestedClassFactory() {} - + NestedClasses.SimpleNestedClass create() { return new NestedClasses.SimpleNestedClass(); } diff --git a/factory/src/test/resources/expected/SimpleClassImplementingMarkerFactory.java b/factory/src/test/resources/expected/SimpleClassImplementingMarkerFactory.java index 6c611e99..3fd72a2f 100644 --- a/factory/src/test/resources/expected/SimpleClassImplementingMarkerFactory.java +++ b/factory/src/test/resources/expected/SimpleClassImplementingMarkerFactory.java @@ -25,7 +25,7 @@ import javax.inject.Inject; ) final class SimpleClassImplementingMarkerFactory implements RandomAccess { @Inject SimpleClassImplementingMarkerFactory() {} - + SimpleClassImplementingMarker create() { return new SimpleClassImplementingMarker(); } diff --git a/factory/src/test/resources/expected/SimpleClassImplementingSimpleInterfaceFactory.java b/factory/src/test/resources/expected/SimpleClassImplementingSimpleInterfaceFactory.java index 720e7d0f..1b13c2f0 100644 --- a/factory/src/test/resources/expected/SimpleClassImplementingSimpleInterfaceFactory.java +++ b/factory/src/test/resources/expected/SimpleClassImplementingSimpleInterfaceFactory.java @@ -25,7 +25,7 @@ import javax.inject.Inject; final class SimpleClassImplementingSimpleInterfaceFactory implements SimpleClassImplementingSimpleInterface.SimpleInterface { @Inject SimpleClassImplementingSimpleInterfaceFactory() {} - + SimpleClassImplementingSimpleInterface create() { return new SimpleClassImplementingSimpleInterface(); } diff --git a/factory/src/test/resources/expected/SimpleClassProvidedDepsFactory.java b/factory/src/test/resources/expected/SimpleClassProvidedDepsFactory.java index 05d1e5ab..53765700 100644 --- a/factory/src/test/resources/expected/SimpleClassProvidedDepsFactory.java +++ b/factory/src/test/resources/expected/SimpleClassProvidedDepsFactory.java @@ -28,7 +28,7 @@ final class SimpleClassProvidedDepsFactory { private final Provider<Integer> providedPrimitiveBProvider; private final Provider<String> providedDepAProvider; private final Provider<String> providedDepBProvider; - + @Inject SimpleClassProvidedDepsFactory( @AQualifier Provider<Integer> providedPrimitiveAProvider, @@ -40,7 +40,7 @@ final class SimpleClassProvidedDepsFactory { this.providedDepAProvider = checkNotNull(providedDepAProvider, 3); this.providedDepBProvider = checkNotNull(providedDepBProvider, 4); } - + SimpleClassProvidedDeps create() { return new SimpleClassProvidedDeps( checkNotNull(providedPrimitiveAProvider.get(), 1), diff --git a/factory/src/test/resources/good/MultipleProvidedParamsSameKey.java b/factory/src/test/resources/good/MultipleProvidedParamsSameKey.java index b338d344..21da6c1e 100644 --- a/factory/src/test/resources/good/MultipleProvidedParamsSameKey.java +++ b/factory/src/test/resources/good/MultipleProvidedParamsSameKey.java @@ -28,6 +28,7 @@ final class MultipleProvidedParamsSameKey { private final Provider<String> providerOne; private final Provider<String> providerTwo; + public MultipleProvidedParamsSameKey( @Provided String one, @Provided String two, diff --git a/value/src/main/java/com/google/auto/value/extension/serializable/userguide/index.md b/value/src/main/java/com/google/auto/value/extension/serializable/g3doc/index.md index e7661839..0282404b 100644 --- a/value/src/main/java/com/google/auto/value/extension/serializable/userguide/index.md +++ b/value/src/main/java/com/google/auto/value/extension/serializable/g3doc/index.md @@ -4,7 +4,6 @@ An [`AutoValue`] extension that enables `@AutoValue` classes with un-serializable properties to be serializable. - ## Usage To use the [`SerializableAutoValueExtension`] with your `AutoValue` class, the @@ -100,4 +99,3 @@ un-serializable types with [SerializerExtensions]. [`SerializableAutoValue`]: https://github.com/google/auto/blob/master/value/src/main/java/com/google/auto/value/extension/serializable/SerializableAutoValue.java [`SerializableAutoValueExtension`]: https://github.com/google/auto/blob/master/value/src/main/java/com/google/auto/value/extension/serializable/extension/SerializableAutoValueExtension.java [SerializerExtensions]: https://github.com/google/auto/blob/master/value/src/main/java/com/google/auto/value/extension/serializable/userguide/serializer-extension.md - diff --git a/value/src/main/java/com/google/auto/value/extension/serializable/userguide/serializer-extension.md b/value/src/main/java/com/google/auto/value/extension/serializable/g3doc/serializer-extension.md index edfa3ca3..aaec7c02 100644 --- a/value/src/main/java/com/google/auto/value/extension/serializable/userguide/serializer-extension.md +++ b/value/src/main/java/com/google/auto/value/extension/serializable/g3doc/serializer-extension.md @@ -243,4 +243,3 @@ as-is. [`SerializableAutoValueExtension`]: https://github.com/google/auto/blob/master/value/src/main/java/com/google/auto/value/extension/serializable/extension/SerializableAutoValueExtension.java [`SerializerExtension`]: https://github.com/google/auto/blob/master/value/src/main/java/com/google/auto/value/extension/serializable/serializer/interfaces/SerializerExtension.java [`Serializer`]: https://github.com/google/auto/blob/master/value/src/main/java/com/google/auto/value/extension/serializable/serializer/interfaces/Serializer.java - diff --git a/value/userguide/builders-howto.md b/value/userguide/builders-howto.md index 00038e70..8e5ac00b 100644 --- a/value/userguide/builders-howto.md +++ b/value/userguide/builders-howto.md @@ -598,5 +598,4 @@ If `speciesBuilder()` is never called then the final `species()` property will be set as if by `speciesBuilder().build()`. In the example, that would result in an exception because the required properties of `Species` have not been set. - [protobuf]: https://developers.google.com/protocol-buffers/docs/reference/java-generated#builders diff --git a/value/userguide/builders.md b/value/userguide/builders.md index 11c68c68..56642307 100644 --- a/value/userguide/builders.md +++ b/value/userguide/builders.md @@ -10,15 +10,14 @@ Fortunately, AutoValue can generate builder classes too! This page explains how. Note that we recommend reading and understanding the basic usage shown in the [introduction](index.md) first. - -## How to use AutoValue with Builders<a name="howto"></a> +## How to use AutoValue with Builders <a name="howto"></a> As explained in the introduction, the AutoValue concept is that **you write an abstract value class, and AutoValue implements it**. Builder generation works in the exact same way: you also create an abstract builder class, nesting it inside your abstract value class, and AutoValue generates implementations for both. -### In `Animal.java`<a name="example_java"></a> +### In `Animal.java` <a name="example_java"></a> ```java import com.google.auto.value.AutoValue; @@ -45,7 +44,7 @@ Note that in real life, some classes and methods would presumably be public and have **Javadoc**. We're leaving these off in the User Guide only to keep the examples clean and short. -### Usage<a name="usage"></a> +### Usage <a name="usage"></a> ```java public void testAnimal() { @@ -65,12 +64,12 @@ public void testAnimal() { } ``` -### What does AutoValue generate?<a name="generated"></a> +### What does AutoValue generate? <a name="generated"></a> For the `Animal` example shown above, here is [typical code AutoValue might generate](generated-builder-example.md). -## Warnings<a name="warnings"></a> +## Warnings <a name="warnings"></a> Be sure to put the static `builder()` method directly in your value class (e.g., `Animal`) and not the nested abstract `Builder` class. That ensures that the diff --git a/value/userguide/extensions.md b/value/userguide/extensions.md index ec6c4675..6acb3ca9 100644 --- a/value/userguide/extensions.md +++ b/value/userguide/extensions.md @@ -9,7 +9,6 @@ AutoValue can be extended to implement new features for classes annotated with Each extension is a class. If that class is on the `processorpath` when you compile your `@AutoValue` class, the extension can run. - Some extensions are triggered by their own annotations, which you add to your class; others may be triggered in other ways. Consult the extension's documentation for usage instructions. @@ -40,4 +39,3 @@ behavior by overriding or implementing new methods. [AutoService]: https://github.com/google/auto/tree/master/service [`AutoValueExtension`]: https://github.com/google/auto/blob/master/value/src/main/java/com/google/auto/value/extension/AutoValueExtension.java [`ServiceLoader`]: http://docs.oracle.com/javase/7/docs/api/java/util/ServiceLoader.html - diff --git a/value/userguide/howto.md b/value/userguide/howto.md index 6f9142c1..4e018256 100644 --- a/value/userguide/howto.md +++ b/value/userguide/howto.md @@ -347,7 +347,6 @@ This is not allowed. Object arrays are very badly-behaved and unlike primitive arrays, they can be replaced with a proper `List` implementation for very little added cost. - If it's important to accept an object array at construction time, refer to the *first* example shown [here](#mutable_property). @@ -675,4 +674,3 @@ final class AutoValue_Example extends Example { ``` [`@AutoValue.CopyAnnotations`]: http://static.javadoc.io/com.google.auto.value/auto-value/1.6/com/google/auto/value/AutoValue.CopyAnnotations.html - diff --git a/value/userguide/index.md b/value/userguide/index.md index 2e05d54b..8d067c19 100644 --- a/value/userguide/index.md +++ b/value/userguide/index.md @@ -13,7 +13,6 @@ > > -- *Joshua Bloch, author, Effective Java* - ## <a name="background"></a>Background **Value classes** are extremely common in Java projects. These are classes for @@ -161,7 +160,6 @@ annotation processing plugin [as described in these instructions][tbroyer-apt]. [tbroyer-apt]: https://plugins.gradle.org/plugin/net.ltgt.apt - ### <a name="usage"></a>Usage Your choice to use AutoValue is essentially *API-invisible*. This means that, to @@ -285,4 +283,3 @@ See the links in the sidebar at the top left. <!-- TODO(kevinb): there are some tidbits of information that don't seem to belong anywhere yet; such as how it implements floating-point equality --> - diff --git a/value/userguide/practices.md b/value/userguide/practices.md index 0121bd83..e78c6e5a 100644 --- a/value/userguide/practices.md +++ b/value/userguide/practices.md @@ -1,7 +1,6 @@ # Best practices - ## <a name="interchangeable"></a>"Equals means interchangeable" Don't use AutoValue to implement value semantics unless you really want value diff --git a/value/userguide/why.md b/value/userguide/why.md index 603abb83..40c994f6 100644 --- a/value/userguide/why.md +++ b/value/userguide/why.md @@ -15,5 +15,4 @@ This [slide presentation] compares AutoValue to numerous alternatives and explains why we think it is better. - [slide presentation]: https://docs.google.com/presentation/d/14u_h-lMn7f1rXE1nDiLX0azS3IkgjGl5uxp5jGJ75RE/edit |