From 4996428ea12be7e381d76614e34a15ad1cc6d275 Mon Sep 17 00:00:00 2001 From: Reinier Zwitserloot Date: Thu, 8 May 2014 06:25:38 +0200 Subject: @Delegate has moved to lombok.experimental. Some work on the aliasing system to make that go smoothly. --- doc/changelog.markdown | 2 + src/core/lombok/Delegate.java | 18 +---- src/core/lombok/core/LombokInternalAliasing.java | 20 +++-- src/core/lombok/eclipse/EclipseImportList.java | 14 +++- src/core/lombok/eclipse/handlers/HandleGetter.java | 2 +- src/core/lombok/experimental/Delegate.java | 64 +++++++++++++++ src/core/lombok/javac/JavacImportList.java | 19 +++-- src/core/lombok/javac/handlers/HandleDelegate.java | 6 +- src/core/lombok/javac/handlers/HandleGetter.java | 2 +- website/features/Delegate.html | 82 ------------------- website/features/Log.html | 2 +- website/features/experimental/Delegate.html | 93 ++++++++++++++++++++++ website/features/experimental/FieldDefaults.html | 2 +- website/features/experimental/Wither.html | 2 +- website/features/experimental/index.html | 2 + website/features/index.html | 2 - 16 files changed, 208 insertions(+), 124 deletions(-) create mode 100644 src/core/lombok/experimental/Delegate.java delete mode 100644 website/features/Delegate.html create mode 100644 website/features/experimental/Delegate.html diff --git a/doc/changelog.markdown b/doc/changelog.markdown index 10fedb75..b49f6de8 100644 --- a/doc/changelog.markdown +++ b/doc/changelog.markdown @@ -2,9 +2,11 @@ Lombok Changelog ---------------- ### v1.12.7 "Edgy Guinea Pig" +* DEPRECATION: `@Delegate` has been moved to `lombok.experimental.Delegate`, and corner cases such as recursive delegation (delegating a type that itself has fields or methods annotated with `@Delegate`) are now error conditions. See the [feature documentation](http://projectlombok.org/features/experimental/Delegate.html) for more information. * FEATURE: It is now possible to put annotations, such as `@Nullable`, on the one parameter of generated `equals()` methods by specifying the `onParam=` option on `@EqualsAndHashCode`, similar to how that feature already exists for `@Setter`. [Issue #674](https://code.google.com/p/projectlombok/issues/detail?id=674) * CHANGE: suppressConstructorProperties should now be configured via lombok configuration. [Issue #659](https://code.google.com/p/projectlombok/issues/detail?id=659) * CHANGE: The `canEqual` method generated by `@EqualsAndHashCode`, `@Value` and `@Data` is now `protected` instead of `public`. [Issue #660](https://code.google.com/p/projectlombok/issues/detail?id=660) +* BUGFIX: Major work on improving support for JDK8, both for javac and eclipse. * BUGFIX: Deadlocks would occasionally occur in eclipse when using lazy getters [Issue #590](https://code.google.com/p/projectlombok/issues/detail?id=590) * BUGFIX: Usage of `@SneakyThrows` with a javac from JDK8 with `-target 1.8` would result in a post compiler error. [Issue #655](https://code.google.com/p/projectlombok/issues/detail?id=655) * BUGFIX: Switching workspace on some versions of eclipse resulted in a 'duplicate field' error. [Issue #666](https://code.google.com/p/projectlombok/issues/detail?id=666) diff --git a/src/core/lombok/Delegate.java b/src/core/lombok/Delegate.java index 534cfb3d..d5b4b48c 100644 --- a/src/core/lombok/Delegate.java +++ b/src/core/lombok/Delegate.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2010-2013 The Project Lombok Authors. + * Copyright (C) 2010-2014 The Project Lombok Authors. * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -27,23 +27,11 @@ import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; /** - * Put on any field to make lombok generate delegate methods that forward the call to this field. - * - * Example: - * 
- *     private @Delegate List<String> foo;
- *
- * - * will generate for example an {@code boolean add(String)} method, which contains: {@code return foo.add(arg);}, as well as all other methods in {@code List}. - * - * All public instance methods of the field's type, as well as all public instance methods of all the field's type's superfields are delegated, except for all methods - * that exist in {@link Object}, the {@code canEqual(Object)} method, and any methods that appear in types - * that are listed in the {@code excludes} property. - *

- * Complete documentation is found at the project lombok features page for @Delegate. + * @deprecated Use {@link lombok.experimental.Delegate} instead. */ @Target({ElementType.FIELD, ElementType.METHOD}) @Retention(RetentionPolicy.SOURCE) +@Deprecated public @interface Delegate { /** * Normally the type of the field is used as delegate type. However, to choose a different type to delegate, you can list one (or more) types here. Note that types with diff --git a/src/core/lombok/core/LombokInternalAliasing.java b/src/core/lombok/core/LombokInternalAliasing.java index 4fd7b29d..8d6794ae 100644 --- a/src/core/lombok/core/LombokInternalAliasing.java +++ b/src/core/lombok/core/LombokInternalAliasing.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2013 The Project Lombok Authors. + * Copyright (C) 2013-2014 The Project Lombok Authors. * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -21,12 +21,14 @@ */ package lombok.core; +import java.util.Collection; import java.util.Collections; import java.util.HashMap; import java.util.Map; public class LombokInternalAliasing { - public static final Map IMPLIED_EXTRA_STAR_IMPORTS; + /** Maps a package name to a space separated list of packages. If the key package is star-imported, assume all packages in the 'value' part of the MapEntry are too. */ + public static final Map> IMPLIED_EXTRA_STAR_IMPORTS; public static final Map ALIASES; /** @@ -41,12 +43,14 @@ public class LombokInternalAliasing { } static { - Map m = new HashMap(); - m.put("lombok.experimental", "lombok"); - IMPLIED_EXTRA_STAR_IMPORTS = Collections.unmodifiableMap(m); + Map> m1 = new HashMap>(); + m1.put("lombok.experimental", Collections.singleton("lombok")); + m1.put("lombok", Collections.singleton("lombok.experimental")); + IMPLIED_EXTRA_STAR_IMPORTS = Collections.unmodifiableMap(m1); - m = new HashMap(); - m.put("lombok.experimental.Value", "lombok.Value"); - ALIASES = Collections.unmodifiableMap(m); + Map m2 = new HashMap(); + m2.put("lombok.experimental.Value", "lombok.Value"); + m2.put("lombok.Delegate", "lombok.experimental.Delegate"); + ALIASES = Collections.unmodifiableMap(m2); } } diff --git a/src/core/lombok/eclipse/EclipseImportList.java b/src/core/lombok/eclipse/EclipseImportList.java index 69246b3c..47167ec6 100644 --- a/src/core/lombok/eclipse/EclipseImportList.java +++ b/src/core/lombok/eclipse/EclipseImportList.java @@ -62,15 +62,23 @@ public class EclipseImportList implements ImportList { } @Override public boolean hasStarImport(String packageName) { - for (Map.Entry e : LombokInternalAliasing.IMPLIED_EXTRA_STAR_IMPORTS.entrySet()) { - if (e.getValue().equals(packageName) && hasStarImport(e.getKey())) return true; - } if (isEqual(packageName, pkg)) return true; if ("java.lang".equals(packageName)) return true; + + if (pkg != null && pkg.tokens != null && pkg.tokens.length == 0) { + for (Map.Entry> e : LombokInternalAliasing.IMPLIED_EXTRA_STAR_IMPORTS.entrySet()) { + if (isEqual(e.getKey(), pkg) && e.getValue().contains(packageName)) return true; + } + } + if (imports != null) for (ImportReference imp : imports) { if ((imp.bits & ASTNode.OnDemand) == 0) continue; if (imp.isStatic()) continue; if (isEqual(packageName, imp)) return true; + for (Map.Entry> e : LombokInternalAliasing.IMPLIED_EXTRA_STAR_IMPORTS.entrySet()) { + if (isEqual(e.getKey(), imp) && e.getValue().contains(packageName)) return true; + } + } return false; } diff --git a/src/core/lombok/eclipse/handlers/HandleGetter.java b/src/core/lombok/eclipse/handlers/HandleGetter.java index 8cffaa2c..d3d974c9 100644 --- a/src/core/lombok/eclipse/handlers/HandleGetter.java +++ b/src/core/lombok/eclipse/handlers/HandleGetter.java @@ -34,7 +34,7 @@ import java.util.Map; import lombok.AccessLevel; import lombok.ConfigurationKeys; -import lombok.Delegate; +import lombok.experimental.Delegate; import lombok.Getter; import lombok.core.AST.Kind; import lombok.core.AnnotationValues; diff --git a/src/core/lombok/experimental/Delegate.java b/src/core/lombok/experimental/Delegate.java new file mode 100644 index 00000000..806d5871 --- /dev/null +++ b/src/core/lombok/experimental/Delegate.java @@ -0,0 +1,64 @@ +/* + * Copyright (C) 2010-2014 The Project Lombok Authors. + * + * 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.experimental; + +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +/** + * Put on any field to make lombok generate delegate methods that forward the call to this field. + * + * Example: + * 

+ *     private @Delegate List<String> foo;
+ *
+ * + * will generate for example an {@code boolean add(String)} method, which contains: {@code return foo.add(arg);}, as well as all other methods in {@code List}. + * + * All public instance methods of the field's type, as well as all public instance methods of all the field's type's superfields are delegated, except for all methods + * that exist in {@link Object}, the {@code canEqual(Object)} method, and any methods that appear in types + * that are listed in the {@code excludes} property. + *

+ * Complete documentation is found at the project lombok features page for @Delegate. + */ +@Target({ElementType.FIELD, ElementType.METHOD}) +@Retention(RetentionPolicy.SOURCE) +public @interface Delegate { + /** + * Normally the type of the field is used as delegate type. However, to choose a different type to delegate, you can list one (or more) types here. Note that types with + * type arguments can only be done as a field type. A solution for this is to create a private inner interface/class with the appropriate types extended, and possibly + * with all methods you'd like to delegate listed, and then supply that class here. The field does not actually have to implement the type you're delegating; the + * type listed here is used only to determine which delegate methods to generate. + * + * NB: All methods in {@code Object}, as well as {@code canEqual(Object other)} will never be delegated. + */ + Class[] types() default {}; + + /** + * Each method in any of the types listed here (include supertypes) will not be delegated. + * + * NB: All methods in {@code Object}, as well as {@code canEqual(Object other)} will never be delegated. + */ + Class[] excludes() default {}; +} diff --git a/src/core/lombok/javac/JavacImportList.java b/src/core/lombok/javac/JavacImportList.java index d5d7460a..2665ca7c 100644 --- a/src/core/lombok/javac/JavacImportList.java +++ b/src/core/lombok/javac/JavacImportList.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2013 The Project Lombok Authors. + * Copyright (C) 2013-2014 The Project Lombok Authors. * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -23,7 +23,6 @@ package lombok.javac; import java.util.ArrayList; import java.util.Collection; -import java.util.Map; import com.sun.tools.javac.tree.JCTree; import com.sun.tools.javac.tree.JCTree.JCCompilationUnit; @@ -59,12 +58,15 @@ public class JavacImportList implements ImportList { } @Override public boolean hasStarImport(String packageName) { - for (Map.Entry e : LombokInternalAliasing.IMPLIED_EXTRA_STAR_IMPORTS.entrySet()) { - if (e.getValue().equals(packageName) && hasStarImport(e.getKey())) return true; - } - if (pkg != null && pkg.toString().equals(packageName)) return true; + String pkgStr = pkg == null ? null : pkg.toString(); + if (pkgStr != null && pkgStr.equals(packageName)) return true; if ("java.lang".equals(packageName)) return true; + if (pkgStr != null) { + Collection extra = LombokInternalAliasing.IMPLIED_EXTRA_STAR_IMPORTS.get(pkgStr); + if (extra != null && extra.contains(packageName)) return true; + } + for (JCTree def : defs) { if (!(def instanceof JCImport)) continue; if (((JCImport) def).staticImport) continue; @@ -72,7 +74,10 @@ public class JavacImportList implements ImportList { if (!(qual instanceof JCFieldAccess)) continue; String simpleName = ((JCFieldAccess) qual).name.toString(); if (!"*".equals(simpleName)) continue; - if (packageName.equals(((JCFieldAccess) qual).selected.toString())) return true; + String starImport = ((JCFieldAccess) qual).selected.toString(); + if (packageName.equals(starImport)) return true; + Collection extra = LombokInternalAliasing.IMPLIED_EXTRA_STAR_IMPORTS.get(starImport); + if (extra != null && extra.contains(packageName)) return true; } return false; diff --git a/src/core/lombok/javac/handlers/HandleDelegate.java b/src/core/lombok/javac/handlers/HandleDelegate.java index ec6ea20c..9cd8844e 100644 --- a/src/core/lombok/javac/handlers/HandleDelegate.java +++ b/src/core/lombok/javac/handlers/HandleDelegate.java @@ -25,6 +25,7 @@ import static lombok.core.handlers.HandlerUtil.*; import static lombok.javac.handlers.JavacHandlerUtil.*; import static com.sun.tools.javac.code.Flags.*; +import java.lang.annotation.Annotation; import java.util.ArrayList; import java.util.Arrays; import java.util.Collections; @@ -42,7 +43,7 @@ import javax.lang.model.type.TypeKind; import javax.lang.model.type.TypeMirror; import lombok.ConfigurationKeys; -import lombok.Delegate; +import lombok.experimental.Delegate; import lombok.core.AST.Kind; import lombok.core.AnnotationValues; import lombok.core.HandlerPriority; @@ -101,7 +102,8 @@ public class HandleDelegate extends JavacAnnotationHandler { @Override public void handle(AnnotationValues annotation, JCAnnotation ast, JavacNode annotationNode) { handleFlagUsage(annotationNode, ConfigurationKeys.DELEGATE_FLAG_USAGE, "@Delegate"); - deleteAnnotationIfNeccessary(annotationNode, Delegate.class); + @SuppressWarnings("deprecation") Class oldDelegate = lombok.Delegate.class; + deleteAnnotationIfNeccessary(annotationNode, Delegate.class, oldDelegate); Type delegateType; Name delegateName = annotationNode.toName(annotationNode.up().getName()); diff --git a/src/core/lombok/javac/handlers/HandleGetter.java b/src/core/lombok/javac/handlers/HandleGetter.java index 48a13bde..063741e2 100644 --- a/src/core/lombok/javac/handlers/HandleGetter.java +++ b/src/core/lombok/javac/handlers/HandleGetter.java @@ -33,7 +33,7 @@ import java.util.Map; import lombok.AccessLevel; import lombok.ConfigurationKeys; -import lombok.Delegate; +import lombok.experimental.Delegate; import lombok.Getter; import lombok.core.AST.Kind; import lombok.core.AnnotationValues; diff --git a/website/features/Delegate.html b/website/features/Delegate.html deleted file mode 100644 index 02cdf290..00000000 --- a/website/features/Delegate.html +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - - - @Delegate -

-
-
-
Project Lombok
-

@Delegate

-
Don't lose your composition.
-
-

Overview

-

- NEW IN Lombok 0.10: Any field or no-argument method can be annotated with @Delegate to let lombok generate delegate methods - that forward the call to this field (or the result of invoking this method). -

-

- Lombok delegates all public methods of the field's type (or method's return type), as well as those of its supertype except for all - methods declared in java.lang.Object. -

-

- You can pass any number of classes into the @Delegate annotation's types parameter. - If you do that, then lombok will delegate all public methods in those types (and their supertypes, except - java.lang.Object) instead of looking at the field/method's type. -

-

- All public non-Object methods that are part of the calculated type(s) are - copied, whether or not you also wrote implementations for those methods. That would thus result in duplicate method errors. You can avoid these - by using the @Delegate(excludes=SomeType.class) parameter to exclude all public methods in the excluded type(s), and their supertypes. -

-

- To have very precise control over what is delegated and what isn't, write private inner interfaces with method signatures, then specify these - private inner interfaces as types in @Delegate(types=PrivateInnerInterfaceWithIncludesList.class, excludes=SameForExcludes.class). -

-
-
-
-

With Lombok

-
@HTML_PRE@
-
-
-
-

Vanilla Java

-
@HTML_POST@
-
-
-
-
-

Small print

-

- When passing classes to the annotation's types or excludes parameter, you cannot include generics. - This is a limitation of java. Use private inner interfaces or classes that extend the intended type including the - generics parameter to work around this problem. -

- When passing classes to the annotation, these classes do not need to be supertypes of the field. See the example. -

- @Delegate cannot be used on static fields or methods. -

-
-
-
- Back to features | Previous feature (@Log) | Next feature
- credits | Copyright © 2010-2013 The Project Lombok Authors, licensed under the MIT license. -
-
-
-
- - - diff --git a/website/features/Log.html b/website/features/Log.html index bc9e017e..f47835c1 100644 --- a/website/features/Log.html +++ b/website/features/Log.html @@ -59,7 +59,7 @@
- Back to features | Previous feature (@Getter(lazy=true)) | Next feature (@Delegate)
+ Back to features | Previous feature (@Getter(lazy=true)) | Next feature
credits | Copyright © 2009-2013 The Project Lombok Authors, licensed under the MIT license.
diff --git a/website/features/experimental/Delegate.html b/website/features/experimental/Delegate.html new file mode 100644 index 00000000..6f745f31 --- /dev/null +++ b/website/features/experimental/Delegate.html @@ -0,0 +1,93 @@ + + + + + + + + @Delegate +
+
+
+
Project Lombok
+

@Delegate

+
Don't lose your composition.
+
+

Since

+

+ @Delegate was introduced as feature in lombok v0.10. It was moved to the experimental package in lombok v1.14; the old version from the main lombok package is now deprecated. +

+
+
+

Experimental

+

+ Experimental because: +

    +
  • Not used that much
    • +
  • Difficult to support for edge cases, such as recursive delegation.
    • +
  • API is rather unfriendly; it would be a lot nicer if you can simply implement some methods and let @Delegate generate delegates for whatever you didn't manually implement, but due to issues with generics erasure this also can't be made to work without caveats. +
+ Current status: negative - Currently we feel this feature will not move out of experimental status anytime soon, and support for this feature may be dropped if future versions of javac or ecj make it difficult to continue to maintain the feature. +
+
+

Overview

+

+ Any field or no-argument method can be annotated with @Delegate to let lombok generate delegate methods that forward the call to this field (or the result of invoking this method). +

+ Lombok delegates all public methods of the field's type (or method's return type), as well as those of its supertypes except for all + methods declared in java.lang.Object. +

+ You can pass any number of classes into the @Delegate annotation's types parameter. + If you do that, then lombok will delegate all public methods in those types (and their supertypes, except java.lang.Object) instead of looking at the field/method's type. +

+ All public non-Object methods that are part of the calculated type(s) are copied, whether or not you also wrote implementations for those methods. That would thus result in duplicate method errors. You can avoid these + by using the @Delegate(excludes=SomeType.class) parameter to exclude all public methods in the excluded type(s), and their supertypes. +

+ To have very precise control over what is delegated and what isn't, write private inner interfaces with method signatures, then specify these + private inner interfaces as types in @Delegate(types=PrivateInnerInterfaceWithIncludesList.class, excludes=SameForExcludes.class). +

+
+
+
+

With Lombok

+
@HTML_PRE@
+
+
+
+

Vanilla Java

+
@HTML_POST@
+
+
+
+
+

Small print

+

+ When passing classes to the annotation's types or excludes parameter, you cannot include generics. + This is a limitation of java. Use private inner interfaces or classes that extend the intended type including the + generics parameter to work around this problem. +

+ When passing classes to the annotation, these classes do not need to be supertypes of the field. See the example. +

+ @Delegate cannot be used on static fields or methods. +

+ @Delegate cannot be used when the calculated type(s) to delegate / exclude themselves contain @Delegate annotations; in other words, @Delegate will error if you attempt to use it recursively. +

+
+
+ Back to features | Previous feature (@FieldDefaults) | Next feature (@Wither)
+ credits | Copyright © 2010-2013 The Project Lombok Authors, licensed under the MIT license. +
+
+
+
+ + + diff --git a/website/features/experimental/FieldDefaults.html b/website/features/experimental/FieldDefaults.html index eff709ca..969da230 100644 --- a/website/features/experimental/FieldDefaults.html +++ b/website/features/experimental/FieldDefaults.html @@ -65,7 +65,7 @@
- Back to experimental features | Previous feature (@ExtensionMethod) | Next feature (@Wither)
+ Back to experimental features | Previous feature (@ExtensionMethod) | Next feature (@Delegate)
credits | Copyright © 2009-2013 The Project Lombok Authors, licensed under the MIT license.
diff --git a/website/features/experimental/Wither.html b/website/features/experimental/Wither.html index 46d3b08b..b6634be4 100644 --- a/website/features/experimental/Wither.html +++ b/website/features/experimental/Wither.html @@ -85,7 +85,7 @@
- Back to experimental features | Previous feature (@FieldDefaults) | Next feature (onX)
+ Back to experimental features | Previous feature (@Delegate) | Next feature (onX)
credits | Copyright © 2009-2013 The Project Lombok Authors, licensed under the MIT license.
diff --git a/website/features/experimental/index.html b/website/features/experimental/index.html index 1128787c..9a1c505f 100644 --- a/website/features/experimental/index.html +++ b/website/features/experimental/index.html @@ -30,6 +30,8 @@
Annoying API? Fix it yourself: Add new methods to existing types!
@FieldDefaults
New default field modifiers for the 21st century.
+
@Delegate
+
Don't lose your composition.
@Wither
Immutable 'setters' - methods that create a clone but with one changed field.
onMethod= / onConstructor= / onParam=
diff --git a/website/features/index.html b/website/features/index.html index f9b8cdfa..537ed166 100644 --- a/website/features/index.html +++ b/website/features/index.html @@ -40,8 +40,6 @@
Laziness is a virtue!
@Log
Captain's Log, stardate 24435.7: "What was that line again?"
-
@Delegate
-
Don't lose your composition.
experimental features
Here be dragons: Extra features which aren't quite ready for prime time yet.
-- cgit