diff options
Diffstat (limited to 'src/core/lombok')
| -rw-r--r-- | src/core/lombok/EqualsAndHashCode.java | 121 |
1 files changed, 49 insertions, 72 deletions
diff --git a/src/core/lombok/EqualsAndHashCode.java b/src/core/lombok/EqualsAndHashCode.java index 7f60880c..5191ee0c 100644 --- a/src/core/lombok/EqualsAndHashCode.java +++ b/src/core/lombok/EqualsAndHashCode.java @@ -27,21 +27,18 @@ import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; /** - * Generates implementations for the {@code equals} and {@code hashCode} methods - * inherited by all objects, based on relevant fields. + * Generates implementations for the {@code equals} and {@code hashCode} methods inherited by all objects, based on relevant fields. * <p> - * Complete documentation is found at - * <a href="https://projectlombok.org/features/EqualsAndHashCode">the project - * lombok features page for @EqualsAndHashCode</a>. + * Complete documentation is found at <a href="https://projectlombok.org/features/EqualsAndHashCode">the project lombok features page for @EqualsAndHashCode</a>. */ -@Target(ElementType.TYPE) @Retention(RetentionPolicy.SOURCE) public @interface EqualsAndHashCode { +@Target(ElementType.TYPE) +@Retention(RetentionPolicy.SOURCE) +public @interface EqualsAndHashCode { /** - * Any fields listed here will not be taken into account in the generated - * {@code equals} and {@code hashCode} implementations. Mutually exclusive - * with {@link #of()}. + * Any fields listed here will not be taken into account in the generated {@code equals} and {@code hashCode} implementations. + * Mutually exclusive with {@link #of()}. * <p> - * Will soon be marked {@code @Deprecated}; use the - * {@code @EqualsAndHashCode.Exclude} annotation instead. + * Will soon be marked {@code @Deprecated}; use the {@code @EqualsAndHashCode.Exclude} annotation instead. * * @return A list of fields to exclude. */ @@ -53,36 +50,30 @@ import java.lang.annotation.Target; * <p> * Mutually exclusive with {@link #exclude()}. * <p> - * Will soon be marked {@code @Deprecated}; use the - * {@code @EqualsAndHashCode.Include} annotation together with - * {@code @EqualsAndHashCode(onlyExplicitlyIncluded = true)}. + * Will soon be marked {@code @Deprecated}; use the {@code @EqualsAndHashCode.Include} annotation together with {@code @EqualsAndHashCode(onlyExplicitlyIncluded = true)}. * * @return A list of fields to use (<em>default</em>: all of them). */ String[] of() default {}; /** - * Call on the superclass's implementations of {@code equals} and - * {@code hashCode} before calculating for the fields in this class. + * Call on the superclass's implementations of {@code equals} and {@code hashCode} before calculating for the fields in this class. * <strong>default: false</strong> * - * @return Whether to call the superclass's {@code equals} implementation as - * part of the generated equals algorithm. + * @return Whether to call the superclass's {@code equals} implementation as part of the generated equals algorithm. */ boolean callSuper() default false; /** - * Normally, if getters are available, those are called. To suppress this - * and let the generated code use the fields directly, set this to - * {@code true}. <strong>default: false</strong> + * Normally, if getters are available, those are called. To suppress this and let the generated code use the fields directly, set this to {@code true}. + * <strong>default: false</strong> * - * @return If {@code true}, always use direct field access instead of - * calling the getter method. + * @return If {@code true}, always use direct field access instead of calling the getter method. */ boolean doNotUseGetters() default false; - + /** - * Determines how the result of the {@code hashCode} method will be cached. + * Determines how the result of the {@code hashCode} method will be cached. * <strong>default: {@link CacheStrategy#NEVER}</strong> * * @return The {@code hashCode} cache strategy to be used. @@ -90,80 +81,66 @@ import java.lang.annotation.Target; CacheStrategy cacheStrategy() default CacheStrategy.NEVER; /** - * Any annotations listed here are put on the generated parameter of - * {@code equals} and {@code canEqual}. This is useful to add for example a - * {@code Nullable} annotation.<br> - * The syntax for this feature depends on JDK version (nothing we can do - * about that; it's to work around javac bugs).<br> + * Any annotations listed here are put on the generated parameter of {@code equals} and {@code canEqual}. + * This is useful to add for example a {@code Nullable} annotation.<br> + * The syntax for this feature depends on JDK version (nothing we can do about that; it's to work around javac bugs).<br> * up to JDK7:<br> - * {@code @EqualsAndHashCode(onParam=@__({@AnnotationsGoHere}))}<br> + * {@code @EqualsAndHashCode(onParam=@__({@AnnotationsGoHere}))}<br> * from JDK8:<br> - * {@code @EqualsAndHashCode(onParam_={@AnnotationsGohere})} // note the - * underscore after {@code onParam}. - * - * @return List of annotations to apply to the generated parameter in the - * {@code equals()} method. + * {@code @EqualsAndHashCode(onParam_={@AnnotationsGohere})} // note the underscore after {@code onParam}. + * + * @return List of annotations to apply to the generated parameter in the {@code equals()} method. */ AnyAnnotation[] onParam() default {}; /** - * Placeholder annotation to enable the placement of annotations on the - * generated code. - * + * Placeholder annotation to enable the placement of annotations on the generated code. * @deprecated Don't use this annotation, ever - Read the documentation. */ - @Deprecated @Retention(RetentionPolicy.SOURCE) @Target({}) - @interface AnyAnnotation { - } + @Deprecated + @Retention(RetentionPolicy.SOURCE) + @Target({}) + @interface AnyAnnotation {} /** - * Only include fields and methods explicitly marked with - * {@code @EqualsAndHashCode.Include}. Normally, all (non-static, - * non-transient) fields are included by default. + * Only include fields and methods explicitly marked with {@code @EqualsAndHashCode.Include}. + * Normally, all (non-static, non-transient) fields are included by default. * - * @return If {@code true}, don't include non-static non-transient fields - * automatically (default: {@code false}). + * @return If {@code true}, don't include non-static non-transient fields automatically (default: {@code false}). */ boolean onlyExplicitlyIncluded() default false; /** - * If present, do not include this field in the generated {@code equals} and - * {@code hashCode} methods. + * If present, do not include this field in the generated {@code equals} and {@code hashCode} methods. */ - @Target(ElementType.FIELD) @Retention(RetentionPolicy.SOURCE) public @interface Exclude { - } + @Target(ElementType.FIELD) + @Retention(RetentionPolicy.SOURCE) + public @interface Exclude {} /** - * Configure the behaviour of how this member is treated in the - * {@code equals} and {@code hashCode} implementation; if on a method, - * include the method's return value as part of calculating - * hashCode/equality. + * Configure the behaviour of how this member is treated in the {@code equals} and {@code hashCode} implementation; if on a method, include the method's return value as part of calculating hashCode/equality. */ - @Target({ElementType.FIELD, ElementType.METHOD}) @Retention(RetentionPolicy.SOURCE) public @interface Include { + @Target({ElementType.FIELD, ElementType.METHOD}) + @Retention(RetentionPolicy.SOURCE) + public @interface Include { /** - * Defaults to the method name of the annotated member. If on a method - * and the name equals the name of a default-included field, this member - * takes its place. + * Defaults to the method name of the annotated member. + * If on a method and the name equals the name of a default-included field, this member takes its place. * - * @return If present, this method serves as replacement for the named - * field. + * @return If present, this method serves as replacement for the named field. */ String replaces() default ""; - + /** - * Higher ranks are considered first. Members of the same rank are - * considered in the order they appear in the source file. + * Higher ranks are considered first. Members of the same rank are considered in the order they appear in the source file. * - * If not explicitly set, the {@code default} rank for primitives is - * 1000, and for primitive wrappers 800. + * If not explicitly set, the {@code default} rank for primitives is 1000, and for primitive wrappers 800. * - * @return ordering within the generating {@code equals} and - * {@code hashCode} methods; higher numbers are considered - * first. + * @return ordering within the generating {@code equals} and {@code hashCode} methods; higher numbers are considered first. */ int rank() default 0; } - + public enum CacheStrategy { /** * Never cache. Perform the calculation every time the method is called. @@ -171,9 +148,9 @@ import java.lang.annotation.Target; NEVER, /** * Cache the result of the first invocation of {@code hashCode} and use it for subsequent invocations. - * This can improve performance in if all fields used for calculating the {@code hashCode} are immutable + * This can improve performance in if all fields used for calculating the {@code hashCode} are immutable * and thus every invocation of {@code hashCode} will always return the same value. - * <strong>Do not use this if there's <em>any</em> chance that different invocations of {@code hashCode} + * <strong>Do not use this if there's <em>any</em> chance that different invocations of {@code hashCode} * might return different values.</strong> */ LAZY |