Skip to content

Commit

Permalink
@DeleGate has moved to lombok.experimental.
Browse files Browse the repository at this point in the history
Some work on the aliasing system to make that go smoothly.
  • Loading branch information
rzwitserloot committed May 20, 2014
1 parent 05ca21b commit 4996428
Show file tree
Hide file tree
Showing 15 changed files with 148 additions and 64 deletions.
2 changes: 2 additions & 0 deletions doc/changelog.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
18 changes: 3 additions & 15 deletions src/core/lombok/Delegate.java
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -27,23 +27,11 @@
import java.lang.annotation.Target;

/**
* Put on any field to make lombok generate delegate methods that forward the call to this field.
*
* Example:
* <pre>
* private &#64;Delegate List&lt;String&gt; foo;
* </pre>
*
* 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.
* <p>
* Complete documentation is found at <a href="http://projectlombok.org/features/Delegate.html">the project lombok features page for &#64;Delegate</a>.
* @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
Expand Down
20 changes: 12 additions & 8 deletions src/core/lombok/core/LombokInternalAliasing.java
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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<String, String> 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<String, Collection<String>> IMPLIED_EXTRA_STAR_IMPORTS;
public static final Map<String, String> ALIASES;

/**
Expand All @@ -41,12 +43,14 @@ public static String processAliases(String in) {
}

static {
Map<String, String> m = new HashMap<String, String>();
m.put("lombok.experimental", "lombok");
IMPLIED_EXTRA_STAR_IMPORTS = Collections.unmodifiableMap(m);
Map<String, Collection<String>> m1 = new HashMap<String, Collection<String>>();
m1.put("lombok.experimental", Collections.singleton("lombok"));
m1.put("lombok", Collections.singleton("lombok.experimental"));
IMPLIED_EXTRA_STAR_IMPORTS = Collections.unmodifiableMap(m1);

m = new HashMap<String, String>();
m.put("lombok.experimental.Value", "lombok.Value");
ALIASES = Collections.unmodifiableMap(m);
Map<String, String> m2 = new HashMap<String, String>();
m2.put("lombok.experimental.Value", "lombok.Value");
m2.put("lombok.Delegate", "lombok.experimental.Delegate");
ALIASES = Collections.unmodifiableMap(m2);
}
}
14 changes: 11 additions & 3 deletions src/core/lombok/eclipse/EclipseImportList.java
Original file line number Diff line number Diff line change
Expand Up @@ -62,15 +62,23 @@ public EclipseImportList(CompilationUnitDeclaration cud) {
}

@Override public boolean hasStarImport(String packageName) {
for (Map.Entry<String, String> 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<String, Collection<String>> 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<String, Collection<String>> e : LombokInternalAliasing.IMPLIED_EXTRA_STAR_IMPORTS.entrySet()) {
if (isEqual(e.getKey(), imp) && e.getValue().contains(packageName)) return true;
}

}
return false;
}
Expand Down
2 changes: 1 addition & 1 deletion src/core/lombok/eclipse/handlers/HandleGetter.java
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@

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;
Expand Down
64 changes: 64 additions & 0 deletions src/core/lombok/experimental/Delegate.java
Original file line number Diff line number Diff line change
@@ -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:
* <pre>
* private &#64;Delegate List&lt;String&gt; foo;
* </pre>
*
* 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.
* <p>
* Complete documentation is found at <a href="http://projectlombok.org/features/experimental/Delegate.html">the project lombok features page for &#64;Delegate</a>.
*/
@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 <em>not</em> be delegated.
*
* NB: All methods in {@code Object}, as well as {@code canEqual(Object other)} will never be delegated.
*/
Class<?>[] excludes() default {};
}
19 changes: 12 additions & 7 deletions src/core/lombok/javac/JavacImportList.java
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -23,7 +23,6 @@

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;
Expand Down Expand Up @@ -59,20 +58,26 @@ public JavacImportList(JCCompilationUnit cud) {
}

@Override public boolean hasStarImport(String packageName) {
for (Map.Entry<String, String> 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<String> 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;
JCTree qual = ((JCImport) def).qualid;
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<String> extra = LombokInternalAliasing.IMPLIED_EXTRA_STAR_IMPORTS.get(starImport);
if (extra != null && extra.contains(packageName)) return true;
}

return false;
Expand Down
6 changes: 4 additions & 2 deletions src/core/lombok/javac/handlers/HandleDelegate.java
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
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;
Expand All @@ -42,7 +43,7 @@
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;
Expand Down Expand Up @@ -101,7 +102,8 @@ public class HandleDelegate extends JavacAnnotationHandler<Delegate> {
@Override public void handle(AnnotationValues<Delegate> annotation, JCAnnotation ast, JavacNode annotationNode) {
handleFlagUsage(annotationNode, ConfigurationKeys.DELEGATE_FLAG_USAGE, "@Delegate");

deleteAnnotationIfNeccessary(annotationNode, Delegate.class);
@SuppressWarnings("deprecation") Class<? extends Annotation> oldDelegate = lombok.Delegate.class;
deleteAnnotationIfNeccessary(annotationNode, Delegate.class, oldDelegate);

Type delegateType;
Name delegateName = annotationNode.toName(annotationNode.up().getName());
Expand Down
2 changes: 1 addition & 1 deletion src/core/lombok/javac/handlers/HandleGetter.java
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@

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;
Expand Down
2 changes: 1 addition & 1 deletion website/features/Log.html
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ <h3>Small print</h3><div class="smallprint">
</div>
</div>
<div class="footer">
<a href="index.html">Back to features</a> | <a href="GetterLazy.html">Previous feature (@Getter(lazy=true))</a> | <a href="Delegate.html">Next feature (@Delegate)</a><br />
<a href="index.html">Back to features</a> | <a href="GetterLazy.html">Previous feature (@Getter(lazy=true))</a> | <span class="disabled">Next feature</span><br />
<a href="../credits.html" class="creditsLink">credits</a> | <span class="copyright">Copyright &copy; 2009-2013 The Project Lombok Authors, licensed under the <a href="http://www.opensource.org/licenses/mit-license.php">MIT license</a>.</span>
</div>
<div style="clear: both;"></div>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,38 +1,48 @@
<!DOCTYPE html>
<html><head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<link rel="stylesheet" type="text/css" href="../logi/reset.css" />
<link rel="stylesheet" type="text/css" href="features.css" />
<link rel="shortcut icon" href="../favicon.ico" type="image/x-icon" />
<link rel="stylesheet" type="text/css" href="../../logi/reset.css" />
<link rel="stylesheet" type="text/css" href="../features.css" />
<link rel="shortcut icon" href="../../favicon.ico" type="image/x-icon" />
<meta name="description" content="Spice up your java" />
<title>@Delegate</title>
</head><body><div id="pepper">
<div class="minimumHeight"></div>
<div class="meat">
<div class="header"><a href="../index.html">Project Lombok</a></div>
<div class="header"><a href="../../index.html">Project Lombok</a></div>
<h1>@Delegate</h1>
<div class="byline">Don't lose your composition.</div>
<div class="overview">
<h3>Overview</h3>
<div class="since">
<h3>Since</h3>
<p>
<em> NEW IN Lombok 0.10: </em> Any field or no-argument method can be annotated with <code>@Delegate</code> to let lombok generate delegate methods
that forward the call to this field (or the result of invoking this method).
@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.
</p>
</div>
<div class="experimental">
<h3>Experimental</h3>
<p>
Lombok delegates all <code>public</code> methods of the field's type (or method's return type), as well as those of its supertype except for all
methods declared in <code>java.lang.Object</code>.
</p>
Experimental because:
<ul>
<li>Not used that much</li>
<li>Difficult to support for edge cases, such as recursive delegation.</li>
<li>API is rather unfriendly; it would be a lot nicer if you can simply implement some methods and let <code>@Delegate</code> 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.
</ul>
Current status: <em>negative</em> - 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.
</div>
<div class="overview">
<h3>Overview</h3>
<p>
Any field or no-argument method can be annotated with <code>@Delegate</code> to let lombok generate delegate methods that forward the call to this field (or the result of invoking this method).
</p><p>
Lombok delegates all <code>public</code> methods of the field's type (or method's return type), as well as those of its supertypes except for all
methods declared in <code>java.lang.Object</code>.
</p><p>
You can pass any number of classes into the <code>@Delegate</code> annotation's <code>types</code> parameter.
If you do that, then lombok will delegate all <code>public</code> methods in those types (and their supertypes, except
<code>java.lang.Object</code>) instead of looking at the field/method's type.
</p>
<p>
All public non-<code>Object</code> 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
If you do that, then lombok will delegate all <code>public</code> methods in those types (and their supertypes, except <code>java.lang.Object</code>) instead of looking at the field/method's type.
</p><p>
All public non-<code>Object</code> 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 <code>@Delegate(excludes=SomeType.class)</code> parameter to exclude all public methods in the excluded type(s), and their supertypes.
</p>
<p>
</p><p>
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 <code>@Delegate(types=PrivateInnerInterfaceWithIncludesList.class, excludes=SameForExcludes.class)</code>.
</p>
Expand All @@ -59,12 +69,13 @@ <h3>Small print</h3><div class="smallprint">
When passing classes to the annotation, these classes do not need to be supertypes of the field. See the example.
</p><p>
<code>@Delegate</code> cannot be used on static fields or methods.
</p>
</p><p>
<code>@Delegate</code> cannot be used when the calculated type(s) to delegate / exclude themselves contain <code>@Delegate</code> annotations; in other words, <code>@Delegate</code> will error if you attempt to use it recursively.
</div>
</div>
<div class="footer">
<a href="index.html">Back to features</a> | <a href="Log.html">Previous feature (@Log)</a> | <span class="disabled">Next feature</span><br />
<a href="../credits.html" class="creditsLink">credits</a> | <span class="copyright">Copyright &copy; 2010-2013 The Project Lombok Authors, licensed under the <a href="http://www.opensource.org/licenses/mit-license.php">MIT license</a>.</span>
<a href="index.html">Back to features</a> | <a href="FieldDefaults.html">Previous feature (@FieldDefaults)</a> | <a href="Wither.html">Next feature (@Wither)</a><br />
<a href="../../credits.html" class="creditsLink">credits</a> | <span class="copyright">Copyright &copy; 2010-2013 The Project Lombok Authors, licensed under the <a href="http://www.opensource.org/licenses/mit-license.php">MIT license</a>.</span>
</div>
<div style="clear: both;"></div>
</div>
Expand Down
Loading

4 comments on commit 4996428

@ninja-
Copy link

@ninja- ninja- commented on 4996428 May 28, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

moving this to experimental breaks IDE support(for this annotation)...

@rzwitserloot
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Which IDE?

@ninja-
Copy link

@ninja- ninja- commented on 4996428 May 29, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IntelliJ

@mg6maciej
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Then you should probably go here: https://github.com/mplushnikov/lombok-intellij-plugin

Please sign in to comment.