Package net.bytebuddy.build

Class HashCodeAndEqualsPlugin

java.lang.Object

net.bytebuddy.build.HashCodeAndEqualsPlugin

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, Plugin, Plugin.Factory, MethodAttributeAppender, MethodAttributeAppender.Factory, ElementMatcher<TypeDescription>

Direct Known Subclasses:

HashCodeAndEqualsPlugin.WithNonNullableFields

@Enhance
public class HashCodeAndEqualsPlugin
extends java.lang.Object
implements Plugin, Plugin.Factory, MethodAttributeAppender.Factory, MethodAttributeAppender

A build tool plugin that adds Object.hashCode() and Object.equals(Object) methods to a class if the HashCodeAndEqualsPlugin.Enhance annotation is present and no explicit method declaration was added. This plugin does not need to be closed.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	HashCodeAndEqualsPlugin.AnnotationOrderComparator	A comparator that arranges fields in the order of HashCodeAndEqualsPlugin.Sorted.
static interface	HashCodeAndEqualsPlugin.Enhance	Instructs the HashCodeAndEqualsPlugin to generate Object.hashCode() and Object.equals(Object) for the annotated class unless these methods are already declared explicitly.
static interface	HashCodeAndEqualsPlugin.Identity	Indicates that a field should be compared by identity.
static interface	HashCodeAndEqualsPlugin.Sorted	Determines the sort order of fields for the equality check when implementing the Object.equals(Object) method.
static interface	HashCodeAndEqualsPlugin.ValueHandling	Determines how a field should be used within generated hash code and equality methods.
protected static class	HashCodeAndEqualsPlugin.ValueMatcher	An element matcher for a HashCodeAndEqualsPlugin.ValueHandling annotation.
static class	HashCodeAndEqualsPlugin.WithNonNullableFields	A version of the HashCodeAndEqualsPlugin that assumes that all fields are non-nullable unless they are explicitly marked.

Nested classes/interfaces inherited from interface net.bytebuddy.matcher.ElementMatcher

ElementMatcher.Junction<S>

Nested classes/interfaces inherited from interface net.bytebuddy.implementation.attribute.MethodAttributeAppender

MethodAttributeAppender.Compound, MethodAttributeAppender.Explicit, MethodAttributeAppender.Factory, MethodAttributeAppender.ForInstrumentedMethod, MethodAttributeAppender.ForReceiverType, MethodAttributeAppender.NoOp

Nested classes/interfaces inherited from interface net.bytebuddy.implementation.attribute.MethodAttributeAppender.Factory

MethodAttributeAppender.Factory.Compound

Nested classes/interfaces inherited from interface net.bytebuddy.build.Plugin

Plugin.Engine, Plugin.Factory, Plugin.ForElementMatcher, Plugin.NoOp, Plugin.WithInitialization, Plugin.WithPreprocessor

Nested classes/interfaces inherited from interface net.bytebuddy.build.Plugin.Factory

Plugin.Factory.Simple, Plugin.Factory.UsingReflection

Field Summary

Fields

Modifier and Type	Field	Description
private java.lang.String	annotationType	Defines the binary name of a runtime-visible annotation type that should be added to the parameter of the Object.equals(Object) method, or null if no such name should be defined.
private static MethodDescription.InDefinedShape	ENHANCE_INCLUDE_SYNTHETIC_FIELDS	A description of the HashCodeAndEqualsPlugin.Enhance.includeSyntheticFields() method.
private static MethodDescription.InDefinedShape	ENHANCE_INVOKE_SUPER	A description of the HashCodeAndEqualsPlugin.Enhance.invokeSuper() method.
private static MethodDescription.InDefinedShape	ENHANCE_PERMIT_SUBCLASS_EQUALITY	A description of the HashCodeAndEqualsPlugin.Enhance.permitSubclassEquality() method.
private static MethodDescription.InDefinedShape	ENHANCE_SIMPLE_COMPARISON_FIRST	A description of the HashCodeAndEqualsPlugin.Enhance.simpleComparisonsFirst() method.
private static MethodDescription.InDefinedShape	ENHANCE_USE_TYPE_HASH_CONSTANT	A description of the HashCodeAndEqualsPlugin.Enhance.useTypeHashConstant() method.
private static MethodDescription.InDefinedShape	SORTED_VALUE	A description of the HashCodeAndEqualsPlugin.Sorted.value() method.
private static MethodDescription.InDefinedShape	VALUE_HANDLING_VALUE	A description of the HashCodeAndEqualsPlugin.ValueHandling.value() method.

Constructor Summary

Constructors

Constructor	Description
HashCodeAndEqualsPlugin()	Creates a new hash code equals plugin.
HashCodeAndEqualsPlugin(java.lang.String annotationType)	Creates a new hash code equals plugin.

Method Summary

Modifier and Type	Method	Description
DynamicType.Builder<?>	apply(DynamicType.Builder<?> builder, TypeDescription typeDescription, ClassFileLocator classFileLocator)	Applies this plugin.
void	apply(org.objectweb.asm.MethodVisitor methodVisitor, MethodDescription methodDescription, AnnotationValueFilter annotationValueFilter)	Applies this attribute appender to a given method visitor.
void	close()
Plugin	make()	Returns a plugin that can be used for a transformation and which is subsequently closed.
MethodAttributeAppender	make(TypeDescription typeDescription)	Returns a method attribute appender that is applicable for a given type description.
boolean	matches(TypeDescription target)	Matches a target against this element matcher.
protected ElementMatcher<FieldDescription>	nonNullable(ElementMatcher<FieldDescription> matcher)	Resolves the matcher to identify non-nullable fields.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ENHANCE_INVOKE_SUPER

private static final MethodDescription.InDefinedShape ENHANCE_INVOKE_SUPER

A description of the HashCodeAndEqualsPlugin.Enhance.invokeSuper() method.

ENHANCE_SIMPLE_COMPARISON_FIRST

private static final MethodDescription.InDefinedShape ENHANCE_SIMPLE_COMPARISON_FIRST

A description of the HashCodeAndEqualsPlugin.Enhance.simpleComparisonsFirst() method.

ENHANCE_INCLUDE_SYNTHETIC_FIELDS

private static final MethodDescription.InDefinedShape ENHANCE_INCLUDE_SYNTHETIC_FIELDS

A description of the HashCodeAndEqualsPlugin.Enhance.includeSyntheticFields() method.

ENHANCE_PERMIT_SUBCLASS_EQUALITY

private static final MethodDescription.InDefinedShape ENHANCE_PERMIT_SUBCLASS_EQUALITY

A description of the HashCodeAndEqualsPlugin.Enhance.permitSubclassEquality() method.

ENHANCE_USE_TYPE_HASH_CONSTANT

private static final MethodDescription.InDefinedShape ENHANCE_USE_TYPE_HASH_CONSTANT

A description of the HashCodeAndEqualsPlugin.Enhance.useTypeHashConstant() method.

VALUE_HANDLING_VALUE

private static final MethodDescription.InDefinedShape VALUE_HANDLING_VALUE

A description of the HashCodeAndEqualsPlugin.ValueHandling.value() method.

SORTED_VALUE

private static final MethodDescription.InDefinedShape SORTED_VALUE

A description of the HashCodeAndEqualsPlugin.Sorted.value() method.

annotationType

@MaybeNull
@ValueHandling(REVERSE_NULLABILITY)
private final java.lang.String annotationType

Defines the binary name of a runtime-visible annotation type that should be added to the parameter of the Object.equals(Object) method, or null if no such name should be defined.

Constructor Detail

HashCodeAndEqualsPlugin

public HashCodeAndEqualsPlugin()

Creates a new hash code equals plugin.

HashCodeAndEqualsPlugin

public HashCodeAndEqualsPlugin(@MaybeNull
                               java.lang.String annotationType)

Creates a new hash code equals plugin.

Parameters:

annotationType - Defines the binary name of a runtime-visible annotation type that should be added to the parameter of the Object.equals(Object) method, or null if no such name should be defined.

Method Detail

make

public Plugin make()

Returns a plugin that can be used for a transformation and which is subsequently closed.

Specified by:

make in interface Plugin.Factory

Returns:

The plugin to use for type transformations.

matches

public boolean matches(@MaybeNull
                       TypeDescription target)

Matches a target against this element matcher.

Specified by:

matches in interface ElementMatcher<TypeDescription>

Parameters:

target - The instance to be matched or null.

Returns:

true if the given element is matched by this matcher or false otherwise.

apply

public DynamicType.Builder<?> apply(DynamicType.Builder<?> builder,
                                    TypeDescription typeDescription,
                                    ClassFileLocator classFileLocator)

Applies this plugin.

Specified by:

apply in interface Plugin

Parameters:

builder - The builder to use as a basis for the applied transformation.

typeDescription - The type being transformed.

classFileLocator - A class file locator that can locate other types in the scope of the project.

Returns:

The supplied builder with additional transformations registered.

nonNullable

protected ElementMatcher<FieldDescription> nonNullable(ElementMatcher<FieldDescription> matcher)

Resolves the matcher to identify non-nullable fields.

Parameters:

matcher - The matcher that identifies fields that are either nullable or non-nullable.

Returns:

The actual matcher to identify non-nullable fields.

close

public void close()

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable

make

public MethodAttributeAppender make(TypeDescription typeDescription)

Returns a method attribute appender that is applicable for a given type description.

Specified by:

make in interface MethodAttributeAppender.Factory

Parameters:

typeDescription - The type for which a method attribute appender is to be applied for.

Returns:

The method attribute appender which should be applied for the given type.

apply

public void apply(org.objectweb.asm.MethodVisitor methodVisitor,
                  MethodDescription methodDescription,
                  AnnotationValueFilter annotationValueFilter)

Applies this attribute appender to a given method visitor.

Specified by:

apply in interface MethodAttributeAppender

Parameters:

methodVisitor - The method visitor to which the attributes that are represented by this attribute appender are written to.

methodDescription - The description of the method for which the given method visitor creates an instrumentation for.

annotationValueFilter - The annotation value filter to apply when the annotations are written.