net.bytebuddy.implementation

Class EqualsMethod

java.lang.Object

net.bytebuddy.implementation.EqualsMethod

All Implemented Interfaces:

InstrumentedType.Prepareable, Implementation

@HashCodeAndEqualsPlugin.Enhance
public class EqualsMethod
extends Object
implements Implementation

An implementation of Object.equals(Object) that takes a class's declared fields into consideration. Equality is resolved by comparing two instances of the same or a compatible class field by field where reference fields must either both be null or where the field value of the instance upon which the method is invoked returns true upon calling the value's equals method. For arrays, the corresponding utilities of Arrays are used.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	EqualsMethod.Appender A byte code appender to implement the EqualsMethod.
protected static class	EqualsMethod.ConditionalReturn A conditional return aborts the equality computation if a given condition was reached.
protected static interface	EqualsMethod.NullValueGuard Guards a field value against a potential null value.
protected static class	EqualsMethod.SuperClassCheck Checks the equality contract against the super class.
protected static class	EqualsMethod.TypeCompatibilityCheck Checks the overall type of the provided argument.
protected static class	EqualsMethod.ValueComparator A value comparator is responsible to compare to values of a given type.

Nested classes/interfaces inherited from interface net.bytebuddy.implementation.Implementation

Implementation.Composable, Implementation.Compound, Implementation.Context, Implementation.Simple, Implementation.SpecialMethodInvocation, Implementation.Target

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EqualsMethod(EqualsMethod.SuperClassCheck superClassCheck) Creates a new equals method implementation.

Method Summary

Modifier and Type	Method and Description
ByteCodeAppender	appender(Implementation.Target implementationTarget) Creates a byte code appender that determines the implementation of the instrumented type's methods.
static EqualsMethod	isolated() Creates an equals method implementation that does not invoke the super class's Object.equals(Object) method.
InstrumentedType	prepare(InstrumentedType instrumentedType) Prepares a given instrumented type.
static EqualsMethod	requiringSuperClassEquality() Creates an equals implementation that invokes the super class's Object.equals(Object) method first.
EqualsMethod	withIgnoredFields(ElementMatcher<? super FieldDescription.InDefinedShape> ignored) Returns a new version of this equals method implementation that ignores the specified fields additionally to any previously specified fields.
EqualsMethod	withNonNullableFields(ElementMatcher<? super FieldDescription.InDefinedShape> nonNullable) Returns a new version of this equals method implementation that does not apply a null value check for the specified fields if they have a reference type additionally to any previously specified fields.
Implementation	withSubclassEquality() Returns a new version of this equals method implementation that permits subclasses of the instrumented type to be equal to instances of the instrumented type instead of requiring an exact match.

Methods inherited from class java.lang.Object

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

Constructor Detail

EqualsMethod

protected EqualsMethod(EqualsMethod.SuperClassCheck superClassCheck)

Creates a new equals method implementation.

Parameters:

superClassCheck - The baseline equality to check.

Method Detail

requiringSuperClassEquality

public static EqualsMethod requiringSuperClassEquality()

Creates an equals implementation that invokes the super class's Object.equals(Object) method first.

Returns:

An equals implementation that invokes the super class's Object.equals(Object) method first.

isolated

public static EqualsMethod isolated()

Creates an equals method implementation that does not invoke the super class's Object.equals(Object) method.

Returns:

An equals method implementation that does not invoke the super class's Object.equals(Object) method.

withIgnoredFields

public EqualsMethod withIgnoredFields(ElementMatcher<? super FieldDescription.InDefinedShape> ignored)

Returns a new version of this equals method implementation that ignores the specified fields additionally to any previously specified fields.

Parameters:

ignored - A matcher to specify any fields that should be ignored.

Returns:

A new version of this equals method implementation that also ignores any fields matched by the provided matcher.

withNonNullableFields

public EqualsMethod withNonNullableFields(ElementMatcher<? super FieldDescription.InDefinedShape> nonNullable)

Returns a new version of this equals method implementation that does not apply a null value check for the specified fields if they have a reference type additionally to any previously specified fields.

Parameters:

nonNullable - A matcher to specify any fields that should not be guarded against null values.

Returns:

A new version of this equals method implementation that also does not apply null value checks to any fields matched by the provided matcher.

withSubclassEquality

public Implementation withSubclassEquality()

Returns a new version of this equals method implementation that permits subclasses of the instrumented type to be equal to instances of the instrumented type instead of requiring an exact match.

Returns:

A new version of this equals method implementation that permits subclasses of the instrumented type to be equal to instances of the instrumented type instead of requiring an exact match.

prepare

public InstrumentedType prepare(InstrumentedType instrumentedType)

Description copied from interface: InstrumentedType.Prepareable

Prepares a given instrumented type.

Specified by:

prepare in interface InstrumentedType.Prepareable

Parameters:

instrumentedType - The instrumented type in its current form.

Returns:

The prepared instrumented type.

appender

public ByteCodeAppender appender(Implementation.Target implementationTarget)

Description copied from interface: Implementation

Creates a byte code appender that determines the implementation of the instrumented type's methods.

Specified by:

appender in interface Implementation

Parameters:

implementationTarget - The target of the current implementation.

Returns:

A byte code appender for implementing methods delegated to this implementation. This byte code appender is also responsible for handling methods that were added by this implementation on the call to InstrumentedType.Prepareable.prepare(InstrumentedType).