Addressed issue #32: The @EqualsAndHashCode and @ToString annotations now support explicitly listing the fields to use, via the new 'of' parameter.

We've also added any fields that start with $ to the default excludes list. Lombok itself can generate these fields ($lock of @Synchronized, for example), and in general they probably should count as effectively not part of the class.

3 files changed, 125 insertions, 68 deletions

diff --git a/src/lombok/eclipse/handlers/HandleEqualsAndHashCode.java b/src/lombok/eclipse/handlers/HandleEqualsAndHashCode.java
index 5896dc2d..46792236 100644
--- a/src/lombok/eclipse/handlers/HandleEqualsAndHashCode.java
+++ b/src/lombok/eclipse/handlers/HandleEqualsAndHashCode.java
@@ -91,24 +91,17 @@ public class HandleEqualsAndHashCode implements EclipseAnnotationHandler<EqualsA
 	private static final Set<String> BUILT_IN_TYPES = Collections.unmodifiableSet(new HashSet<String>(Arrays.asList(
 			"byte", "short", "int", "long", "char", "boolean", "double", "float")));
 	
-	private void checkForBogusExcludes(Node type, AnnotationValues<EqualsAndHashCode> annotation) {
-		List<String> list = Arrays.asList(annotation.getInstance().exclude());
-		boolean[] matched = new boolean[list.size()];
-		
-		for ( Node child : type.down() ) {
-			if ( list.isEmpty() ) break;
-			if ( child.getKind() != Kind.FIELD ) continue;
-			if ( (((FieldDeclaration)child.get()).modifiers & ClassFileConstants.AccStatic) != 0 ) continue;
-			if ( (((FieldDeclaration)child.get()).modifiers & ClassFileConstants.AccTransient) != 0 ) continue;
-			int idx = list.indexOf(child.getName());
-			if ( idx > -1 ) matched[idx] = true;
-		}
-		
-		for ( int i = 0 ; i < list.size() ; i++ ) {
-			if ( !matched[i] ) {
+	private void checkForBogusFieldNames(Node type, AnnotationValues<EqualsAndHashCode> annotation) {
+		if ( annotation.isExplicit("exclude") ) {
+			for ( int i : createListOfNonExistentFields(Arrays.asList(annotation.getInstance().exclude()), type, true, true) ) {
 				annotation.setWarning("exclude", "This field does not exist, or would have been excluded anyway.", i);
 			}
 		}
+		if ( annotation.isExplicit("of") ) {
+			for ( int i : createListOfNonExistentFields(Arrays.asList(annotation.getInstance().of()), type, false, false) ) {
+				annotation.setWarning("of", "This field does not exist.", i);
+			}
+		}
 	}
 	
 	public void generateEqualsAndHashCodeForType(Node typeNode, Node errorNode) {
@@ -121,26 +114,34 @@ public class HandleEqualsAndHashCode implements EclipseAnnotationHandler<EqualsA
 			}
 		}
 		
-		boolean callSuper = false;
-		try {
-			callSuper = ((Boolean)EqualsAndHashCode.class.getMethod("callSuper").getDefaultValue()).booleanValue();
-		} catch ( Exception ignore ) {}
-		generateMethods(typeNode, errorNode, Collections.<String>emptyList(), callSuper, true, false);
+		generateMethods(typeNode, errorNode, null, null, null, false);
 	}
 	
 	@Override public boolean handle(AnnotationValues<EqualsAndHashCode> annotation, Annotation ast, Node annotationNode) {
 		EqualsAndHashCode ann = annotation.getInstance();
 		List<String> excludes = Arrays.asList(ann.exclude());
+		List<String> includes = Arrays.asList(ann.of());
 		Node typeNode = annotationNode.up();
 		
-		checkForBogusExcludes(typeNode, annotation);
+		checkForBogusFieldNames(typeNode, annotation);
+		
+		Boolean callSuper = ann.callSuper();
+		if ( !annotation.isExplicit("callSuper") ) callSuper = null;
+		if ( !annotation.isExplicit("exclude") ) excludes = null;
+		if ( !annotation.isExplicit("of") ) includes = null;
+		
+		if ( excludes != null && includes != null ) {
+			excludes = null;
+			annotation.setWarning("exclude", "exclude and of are mutually exclusive; the 'exclude' parameter will be ignored.");
+		}
 		
-		return generateMethods(typeNode, annotationNode, excludes,
-				ann.callSuper(), annotation.getRawExpression("callSuper") == null, true);
+		return generateMethods(typeNode, annotationNode, excludes, includes, callSuper, true);
 	}
 	
-	public boolean generateMethods(Node typeNode, Node errorNode, List<String> excludes,
-			boolean callSuper, boolean implicit, boolean whineIfExists) {
+	public boolean generateMethods(Node typeNode, Node errorNode, List<String> excludes, List<String> includes,
+			Boolean callSuper, boolean whineIfExists) {
+		assert excludes == null || includes == null;
+		
 		TypeDeclaration typeDecl = null;
 		
 		if ( typeNode.get() instanceof TypeDeclaration ) typeDecl = (TypeDeclaration) typeNode.get();
@@ -153,6 +154,14 @@ public class HandleEqualsAndHashCode implements EclipseAnnotationHandler<EqualsA
 			return false;
 		}
 		
+		boolean implicitCallSuper = callSuper == null;
+		
+		if ( callSuper == null ) {
+			try {
+				callSuper = ((Boolean)EqualsAndHashCode.class.getMethod("callSuper").getDefaultValue()).booleanValue();
+			} catch ( Exception ignore ) {}
+		}
+		
 		boolean isDirectDescendantOfObject = true;
 		
 		if ( typeDecl.superclass != null ) {
@@ -165,21 +174,31 @@ public class HandleEqualsAndHashCode implements EclipseAnnotationHandler<EqualsA
 			return true;
 		}
 		
-		if ( !isDirectDescendantOfObject && !callSuper && implicit ) {
+		if ( !isDirectDescendantOfObject && !callSuper && implicitCallSuper ) {
 			errorNode.addWarning("Generating equals/hashCode implementation but without a call to superclass, even though this class does not extend java.lang.Object. If this is intentional, add '@EqualsAndHashCode(callSuper=false)' to your type.");
 		}
 		
 		List<Node> nodesForEquality = new ArrayList<Node>();
-		for ( Node child : typeNode.down() ) {
-			if ( child.getKind() != Kind.FIELD ) continue;
-			FieldDeclaration fieldDecl = (FieldDeclaration) child.get();
-			//Skip static fields.
-			if ( (fieldDecl.modifiers & ClassFileConstants.AccStatic) != 0 ) continue;
-			//Skip transient fields.
-			if ( (fieldDecl.modifiers & ClassFileConstants.AccTransient) != 0 ) continue;
-			//Skip excluded fields.
-			if ( excludes.contains(new String(fieldDecl.name)) ) continue;
-			nodesForEquality.add(child);
+		if ( includes != null ) {
+			for ( Node child : typeNode.down() ) {
+				if ( child.getKind() != Kind.FIELD ) continue;
+				FieldDeclaration fieldDecl = (FieldDeclaration) child.get();
+				if ( includes.contains(new String(fieldDecl.name)) ) nodesForEquality.add(child);
+			}
+		} else {
+			for ( Node child : typeNode.down() ) {
+				if ( child.getKind() != Kind.FIELD ) continue;
+				FieldDeclaration fieldDecl = (FieldDeclaration) child.get();
+				//Skip static fields.
+				if ( (fieldDecl.modifiers & ClassFileConstants.AccStatic) != 0 ) continue;
+				//Skip transient fields.
+				if ( (fieldDecl.modifiers & ClassFileConstants.AccTransient) != 0 ) continue;
+				//Skip excluded fields.
+				if ( excludes != null && excludes.contains(new String(fieldDecl.name)) ) continue;
+				//Skip fields that start with $.
+				if ( fieldDecl.name.length > 0 && fieldDecl.name[0] == '$' ) continue;
+				nodesForEquality.add(child);
+			}
 		}
 		
 		switch ( methodExists("hashCode", typeNode) ) {
diff --git a/src/lombok/eclipse/handlers/HandleToString.java b/src/lombok/eclipse/handlers/HandleToString.java
index f2c4e9cf..d639e3fd 100644
--- a/src/lombok/eclipse/handlers/HandleToString.java
+++ b/src/lombok/eclipse/handlers/HandleToString.java
@@ -66,25 +66,20 @@ import org.mangosdk.spi.ProviderFor;
  */
 @ProviderFor(EclipseAnnotationHandler.class)
 public class HandleToString implements EclipseAnnotationHandler<ToString> {
-	private void checkForBogusExcludes(Node type, AnnotationValues<ToString> annotation) {
-		List<String> list = Arrays.asList(annotation.getInstance().exclude());
-		boolean[] matched = new boolean[list.size()];
-		
-		for ( Node child : type.down() ) {
-			if ( list.isEmpty() ) break;
-			if ( child.getKind() != Kind.FIELD ) continue;
-			if ( (((FieldDeclaration)child.get()).modifiers & ClassFileConstants.AccStatic) != 0 ) continue;
-			int idx = list.indexOf(child.getName());
-			if ( idx > -1 ) matched[idx] = true;
-		}
-		
-		for ( int i = 0 ; i < list.size() ; i++ ) {
-			if ( !matched[i] ) {
+	private void checkForBogusFieldNames(Node type, AnnotationValues<ToString> annotation) {
+		if ( annotation.isExplicit("exclude") ) {
+			for ( int i : createListOfNonExistentFields(Arrays.asList(annotation.getInstance().exclude()), type, true, false) ) {
 				annotation.setWarning("exclude", "This field does not exist, or would have been excluded anyway.", i);
 			}
 		}
+		if ( annotation.isExplicit("of") ) {
+			for ( int i : createListOfNonExistentFields(Arrays.asList(annotation.getInstance().of()), type, false, false) ) {
+				annotation.setWarning("of", "This field does not exist.", i);
+			}
+		}
 	}
 	
+	
 	public void generateToStringForType(Node typeNode, Node errorNode) {
 		for ( Node child : typeNode.down() ) {
 			if ( child.getKind() == Kind.ANNOTATION ) {
@@ -95,29 +90,31 @@ public class HandleToString implements EclipseAnnotationHandler<ToString> {
 			}
 		}
 		
-		boolean includeFieldNames = false;
-		boolean callSuper = false;
+		boolean includeFieldNames = true;
 		try {
 			includeFieldNames = ((Boolean)ToString.class.getMethod("includeFieldNames").getDefaultValue()).booleanValue();
 		} catch ( Exception ignore ) {}
-		try {
-			callSuper = ((Boolean)ToString.class.getMethod("callSuper").getDefaultValue()).booleanValue();
-		} catch ( Exception ignore ) {}
-		generateToString(typeNode, errorNode, Collections.<String>emptyList(), includeFieldNames, callSuper, false);
+		generateToString(typeNode, errorNode, null, null, includeFieldNames, null, false);
 	}
 	
 	public boolean handle(AnnotationValues<ToString> annotation, Annotation ast, Node annotationNode) {
 		ToString ann = annotation.getInstance();
 		List<String> excludes = Arrays.asList(ann.exclude());
+		List<String> includes = Arrays.asList(ann.of());
 		Node typeNode = annotationNode.up();
+		Boolean callSuper = ann.callSuper();
 		
-		checkForBogusExcludes(typeNode, annotation);
+		if ( !annotation.isExplicit("callSuper") ) callSuper = null;
+		if ( !annotation.isExplicit("exclude") ) excludes = null;
+		if ( !annotation.isExplicit("of") ) includes = null;
 		
-		return generateToString(typeNode, annotationNode, excludes, ann.includeFieldNames(), ann.callSuper(), true);
+		checkForBogusFieldNames(typeNode, annotation);
+		
+		return generateToString(typeNode, annotationNode, excludes, includes, ann.includeFieldNames(), callSuper, true);
 	}
 	
-	public boolean generateToString(Node typeNode, Node errorNode, List<String> excludes,
-			boolean includeFieldNames, boolean callSuper, boolean whineIfExists) {
+	public boolean generateToString(Node typeNode, Node errorNode, List<String> excludes, List<String> includes,
+			boolean includeFieldNames, Boolean callSuper, boolean whineIfExists) {
 		TypeDeclaration typeDecl = null;
 		
 		if ( typeNode.get() instanceof TypeDeclaration ) typeDecl = (TypeDeclaration) typeNode.get();
@@ -130,15 +127,31 @@ public class HandleToString implements EclipseAnnotationHandler<ToString> {
 			return false;
 		}
 		
+		if ( callSuper == null ) {
+			try {
+				callSuper = ((Boolean)ToString.class.getMethod("callSuper").getDefaultValue()).booleanValue();
+			} catch ( Exception ignore ) {}
+		}
+		
 		List<Node> nodesForToString = new ArrayList<Node>();
-		for ( Node child : typeNode.down() ) {
-			if ( child.getKind() != Kind.FIELD ) continue;
-			FieldDeclaration fieldDecl = (FieldDeclaration) child.get();
-			//Skip static fields.
-			if ( (fieldDecl.modifiers & ClassFileConstants.AccStatic) != 0 ) continue;
-			//Skip excluded fields.
-			if ( excludes.contains(new String(fieldDecl.name)) ) continue;
-			nodesForToString.add(child);
+		if ( includes != null ) {
+			for ( Node child : typeNode.down() ) {
+				if ( child.getKind() != Kind.FIELD ) continue;
+				FieldDeclaration fieldDecl = (FieldDeclaration) child.get();
+				if ( includes.contains(new String(fieldDecl.name)) ) nodesForToString.add(child);
+			}
+		} else {
+			for ( Node child : typeNode.down() ) {
+				if ( child.getKind() != Kind.FIELD ) continue;
+				FieldDeclaration fieldDecl = (FieldDeclaration) child.get();
+				//Skip static fields.
+				if ( (fieldDecl.modifiers & ClassFileConstants.AccStatic) != 0 ) continue;
+				//Skip excluded fields.
+				if ( excludes.contains(new String(fieldDecl.name)) ) continue;
+				//Skip fields that start with $
+				if ( fieldDecl.name.length > 0 && fieldDecl.name[0] == '$' ) continue;
+				nodesForToString.add(child);
+			}
 		}
 		
 		switch ( methodExists("toString", typeNode) ) {
diff --git a/src/lombok/eclipse/handlers/PKG.java b/src/lombok/eclipse/handlers/PKG.java
index 98c60524..58fac4a1 100644
--- a/src/lombok/eclipse/handlers/PKG.java
+++ b/src/lombok/eclipse/handlers/PKG.java
@@ -33,6 +33,7 @@ import lombok.core.TransformationsUtil;
 import lombok.core.AST.Kind;
 import lombok.eclipse.Eclipse;
 import lombok.eclipse.EclipseAST;
+import lombok.eclipse.EclipseAST.Node;
 
 import org.eclipse.jdt.internal.compiler.ast.ASTNode;
 import org.eclipse.jdt.internal.compiler.ast.AbstractMethodDeclaration;
@@ -54,6 +55,7 @@ import org.eclipse.jdt.internal.compiler.ast.StringLiteral;
 import org.eclipse.jdt.internal.compiler.ast.ThrowStatement;
 import org.eclipse.jdt.internal.compiler.ast.TypeDeclaration;
 import org.eclipse.jdt.internal.compiler.ast.TypeReference;
+import org.eclipse.jdt.internal.compiler.classfmt.ClassFileConstants;
 
 class PKG {
 	private PKG() {}
@@ -273,4 +275,27 @@ class PKG {
 		ann.bits |= ASTNode.HasBeenGenerated;
 		return ann;
 	}
+	
+	static List<Integer> createListOfNonExistentFields(List<String> list, Node type, boolean excludeStandard, boolean excludeTransient) {
+		boolean[] matched = new boolean[list.size()];
+		
+		for ( Node child : type.down() ) {
+			if ( list.isEmpty() ) break;
+			if ( child.getKind() != Kind.FIELD ) continue;
+			if ( excludeStandard ) {
+				if ( (((FieldDeclaration)child.get()).modifiers & ClassFileConstants.AccStatic) != 0 ) continue;
+				if ( child.getName().startsWith("$") ) continue;
+			}
+			if ( excludeTransient && (((FieldDeclaration)child.get()).modifiers & ClassFileConstants.AccTransient) != 0 ) continue;
+			int idx = list.indexOf(child.getName());
+			if ( idx > -1 ) matched[idx] = true;
+		}
+		
+		List<Integer> problematic = new ArrayList<Integer>();
+		for ( int i = 0 ; i < list.size() ; i++ ) {
+			if ( !matched[i] ) problematic.add(i);
+		}
+		
+		return problematic;
+	}
 }