Modifier and Type	Class and Description
protected static enum	HashCodeAndEqualsPlugin.AnnotationOrderComparator A comparator that arranges fields in the order of `Sorted`.
public 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.
public static @interface	HashCodeAndEqualsPlugin.Sorted Determines the sort order of fields for the equality check when implementing the `Object#equals(Object)` method.
public 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 `ValueHandling` annotation.
public static class	HashCodeAndEqualsPlugin.WithNonNullableFields A version of the `HashCodeAndEqualsPlugin` that assumes that all fields are non-nullable unless they are explicitly marked.

Modifier and Type	Field and Description
private final 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 final MethodDescription.InDefinedShape	ENHANCE_INCLUDE_SYNTHETIC_FIELDS A description of the `Enhance#includeSyntheticFields()` method.
private static final MethodDescription.InDefinedShape	ENHANCE_INVOKE_SUPER A description of the `Enhance#invokeSuper()` method.
private static final MethodDescription.InDefinedShape	ENHANCE_PERMIT_SUBCLASS_EQUALITY A description of the `Enhance#permitSubclassEquality()` method.
private static final MethodDescription.InDefinedShape	ENHANCE_SIMPLE_COMPARISON_FIRST A description of the `Enhance#simpleComparisonsFirst()` method.
private static final MethodDescription.InDefinedShape	ENHANCE_USE_TYPE_HASH_CONSTANT A description of the `Enhance#useTypeHashConstant()` method.
private static final MethodDescription.InDefinedShape	SORTED_VALUE A description of the `Sorted#value()` method.
private static final MethodDescription.InDefinedShape	VALUE_HANDLING_VALUE A description of the `ValueHandling#value()` method.

Access	Constructor and Description
public	HashCodeAndEqualsPlugin() Creates a new hash code equals plugin.
public	HashCodeAndEqualsPlugin(String 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. annotationType) Creates a new hash code equals plugin.

Method Summary

Modifier and Type	Method and Description
public DynamicType.Builder<?>	apply(DynamicType.Builder<?> The builder to use as a basis for the applied transformation. builder, TypeDescription The type being transformed. typeDescription, ClassFileLocator A class file locator that can locate other types in the scope of the project. classFileLocator) Implements net.bytebuddy.build.Plugin.apply. Applies this plugin.
public void	apply(MethodVisitor The method visitor to which the attributes that are represented by this attribute appender are written to. methodVisitor, MethodDescription The description of the method for which the given method visitor creates an instrumentation for. methodDescription, AnnotationValueFilter The annotation value filter to apply when the annotations are written. annotationValueFilter) Implements net.bytebuddy.implementation.attribute.MethodAttributeAppender.apply. Applies this attribute appender to a given method visitor.
public void	close() Implements java.io.Closeable.close. Closes this stream and releases any system resources associated with it.
public Plugin	make() Implements net.bytebuddy.build.Plugin.Factory.make. Returns a plugin that can be used for a transformation and which is subsequently closed.
public MethodAttributeAppender	make(TypeDescription The type for which a method attribute appender is to be applied for. typeDescription) Implements net.bytebuddy.implementation.attribute.MethodAttributeAppender.Factory.make. Returns a method attribute appender that is applicable for a given type description.
public boolean	matches(TypeDescription The instance to be matched or `null`. target) Implements net.bytebuddy.matcher.ElementMatcher.matches. Matches a target against this element matcher.
protected ElementMatcher<FieldDescription>	Returns: The actual matcher to identify non-nullable fields. nonNullable(ElementMatcher<FieldDescription> The matcher that identifies fields that are either nullable or non-nullable. matcher) Resolves the matcher to identify non-nullable fields.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

annotationType	back to summary
private final 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. Annotations @MaybeNull @ValueHandling:REVERSE_NULLABILITY

ENHANCE_INCLUDE_SYNTHETIC_FIELDS	back to summary
private static final MethodDescription.InDefinedShape ENHANCE_INCLUDE_SYNTHETIC_FIELDS A description of the `Enhance#includeSyntheticFields()` method.

ENHANCE_INVOKE_SUPER	back to summary
private static final MethodDescription.InDefinedShape ENHANCE_INVOKE_SUPER A description of the `Enhance#invokeSuper()` method.

ENHANCE_PERMIT_SUBCLASS_EQUALITY	back to summary
private static final MethodDescription.InDefinedShape ENHANCE_PERMIT_SUBCLASS_EQUALITY A description of the `Enhance#permitSubclassEquality()` method.

ENHANCE_SIMPLE_COMPARISON_FIRST	back to summary
private static final MethodDescription.InDefinedShape ENHANCE_SIMPLE_COMPARISON_FIRST A description of the `Enhance#simpleComparisonsFirst()` method.

ENHANCE_USE_TYPE_HASH_CONSTANT	back to summary
private static final MethodDescription.InDefinedShape ENHANCE_USE_TYPE_HASH_CONSTANT A description of the `Enhance#useTypeHashConstant()` method.

SORTED_VALUE	back to summary
private static final MethodDescription.InDefinedShape SORTED_VALUE A description of the `Sorted#value()` method.

VALUE_HANDLING_VALUE	back to summary
private static final MethodDescription.InDefinedShape VALUE_HANDLING_VALUE A description of the `ValueHandling#value()` method.

Constructor Detail

HashCodeAndEqualsPlugin	back to summary
public HashCodeAndEqualsPlugin() Creates a new hash code equals plugin.

HashCodeAndEqualsPlugin back to summary

HashCodeAndEqualsPlugin	back to summary
public HashCodeAndEqualsPlugin(String annotationType) Creates a new hash code equals plugin. Parameters annotationType:String 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.

public HashCodeAndEqualsPlugin(String annotationType)

Creates a new hash code equals plugin.

Parameters

annotationType:String: 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

apply	back to summary
public DynamicType.Builder<?> apply(DynamicType.Builder<?> builder, TypeDescription typeDescription, ClassFileLocator classFileLocator) Implements net.bytebuddy.build.Plugin.apply. Doc from net.bytebuddy.build.Plugin.apply. Applies this plugin. Parameters builder:DynamicType.Builder<?> The builder to use as a basis for the applied transformation. typeDescription:TypeDescription The type being transformed. classFileLocator:ClassFileLocator A class file locator that can locate other types in the scope of the project. Returns:DynamicType.Builder<?> The supplied builder with additional transformations registered. Annotations @SuppressFBWarnings:NP_NULL_ON_SOME_PATH_FROM_RETURN_VALUE justification:Annotation presence is required by matcher.

apply

back to summary

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

Implements net.bytebuddy.build.Plugin.apply.

Doc from net.bytebuddy.build.Plugin.apply.

Applies this plugin.

Parameters

builder:DynamicType.Builder<?>: The builder to use as a basis for the applied transformation.
typeDescription:TypeDescription: The type being transformed.
classFileLocator:ClassFileLocator: A class file locator that can locate other types in the scope of the project.

Returns:DynamicType.Builder<?>

The supplied builder with additional transformations registered.

Annotations

@SuppressFBWarnings:NP_NULL_ON_SOME_PATH_FROM_RETURN_VALUE
justification:Annotation presence is required by matcher.

apply	back to summary
public void apply(MethodVisitor methodVisitor, MethodDescription methodDescription, AnnotationValueFilter annotationValueFilter) Implements net.bytebuddy.implementation.attribute.MethodAttributeAppender.apply. Doc from net.bytebuddy.implementation.attribute.MethodAttributeAppender.apply. Applies this attribute appender to a given method visitor. Parameters methodVisitor:MethodVisitor The method visitor to which the attributes that are represented by this attribute appender are written to. methodDescription:MethodDescription The description of the method for which the given method visitor creates an instrumentation for. annotationValueFilter:AnnotationValueFilter The annotation value filter to apply when the annotations are written.

apply

back to summary

public void apply(MethodVisitor methodVisitor, MethodDescription methodDescription, AnnotationValueFilter annotationValueFilter)

Implements net.bytebuddy.implementation.attribute.MethodAttributeAppender.apply.

Doc from net.bytebuddy.implementation.attribute.MethodAttributeAppender.apply.

Applies this attribute appender to a given method visitor.

Parameters

methodVisitor:MethodVisitor: The method visitor to which the attributes that are represented by this attribute appender are written to.
methodDescription:MethodDescription: The description of the method for which the given method visitor creates an instrumentation for.
annotationValueFilter:AnnotationValueFilter: The annotation value filter to apply when the annotations are written.

close back to summary

close	back to summary
public void close() Implements java.io.Closeable.close. Doc from java.io.Closeable.close. Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect. As noted in `AutoCloseable#close()`, cases where the close may fail require careful attention. It is strongly advised to relinquish the underlying resources and to internally mark the `Closeable` as closed, prior to throwing the `IOException`.

public void close()

Implements java.io.Closeable.close.

Doc from java.io.Closeable.close.

Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect.

As noted in AutoCloseable#close(), cases where the close may fail require careful attention. It is strongly advised to relinquish the underlying resources and to internally mark the Closeable as closed, prior to throwing the IOException.

make	back to summary
public Plugin make() Implements net.bytebuddy.build.Plugin.Factory.make. Doc from net.bytebuddy.build.Plugin.Factory.make. Returns a plugin that can be used for a transformation and which is subsequently closed. Returns:Plugin The plugin to use for type transformations.

make

back to summary

public Plugin make()

Implements net.bytebuddy.build.Plugin.Factory.make.

Doc from net.bytebuddy.build.Plugin.Factory.make.

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

Returns:Plugin: The plugin to use for type transformations.

make	back to summary
public MethodAttributeAppender make(TypeDescription typeDescription) Implements net.bytebuddy.implementation.attribute.MethodAttributeAppender.Factory.make. Doc from net.bytebuddy.implementation.attribute.MethodAttributeAppender.Factory.make. Returns a method attribute appender that is applicable for a given type description. Parameters typeDescription:TypeDescription The type for which a method attribute appender is to be applied for. Returns:MethodAttributeAppender The method attribute appender which should be applied for the given type.

make

back to summary

public MethodAttributeAppender make(TypeDescription typeDescription)

Implements net.bytebuddy.implementation.attribute.MethodAttributeAppender.Factory.make.

Doc from net.bytebuddy.implementation.attribute.MethodAttributeAppender.Factory.make.

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

Parameters

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

Returns:MethodAttributeAppender

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

matches back to summary

matches	back to summary
public boolean matches(TypeDescription target) Implements net.bytebuddy.matcher.ElementMatcher.matches. Doc from net.bytebuddy.matcher.ElementMatcher.matches. Matches a target against this element matcher. Parameters target:TypeDescription The instance to be matched or `null`. Returns:boolean `true` if the given element is matched by this matcher or `false` otherwise.

public boolean matches(TypeDescription target)

Implements net.bytebuddy.matcher.ElementMatcher.matches.

Doc from net.bytebuddy.matcher.ElementMatcher.matches.

Matches a target against this element matcher.

Parameters

target:TypeDescription: The instance to be matched or null.

Returns:boolean

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

nonNullable	back to summary
protected ElementMatcher<FieldDescription> nonNullable(ElementMatcher<FieldDescription> matcher) Resolves the matcher to identify non-nullable fields. Parameters matcher:ElementMatcher<FieldDescription> The matcher that identifies fields that are either nullable or non-nullable. Returns:ElementMatcher<FieldDescription> The actual matcher to identify non-nullable fields.

nonNullable

back to summary

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

Resolves the matcher to identify non-nullable fields.

Parameters

matcher:ElementMatcher<FieldDescription>: The matcher that identifies fields that are either nullable or non-nullable.

Returns:ElementMatcher<FieldDescription>

The actual matcher to identify non-nullable fields.

net.bytebuddy.build back to summary

protected final Enum HashCodeAndEqualsPlugin.AnnotationOrderComparator

Class Inheritance

extends Enum<HashCodeAndEqualsPlugin.AnnotationOrderComparator>
implements Comparator<FieldDescription.InDefinedShape>

java.lang.Object
java.lang.Enum
net.bytebuddy.build.HashCodeAndEqualsPlugin.AnnotationOrderComparator

All Implemented Interfaces

java.util.Comparator

A comparator that arranges fields in the order of Sorted.

Field Summary

Modifier and Type	Field and Description
public static final HashCodeAndEqualsPlugin.AnnotationOrderComparator	INSTANCE The singleton instance.

Constructor Summary

Access	Constructor and Description
private	AnnotationOrderComparator()

Method Summary

Modifier and Type	Method and Description
public int	compare(FieldDescription.InDefinedShape the first object to be compared. left, FieldDescription.InDefinedShape the second object to be compared. right) Implements java.util.Comparator.compare. Compares its two arguments for order.
public static HashCodeAndEqualsPlugin.AnnotationOrderComparator	valueOf(String name)
public static HashCodeAndEqualsPlugin.AnnotationOrderComparator[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

INSTANCE	back to summary
public static final HashCodeAndEqualsPlugin.AnnotationOrderComparator INSTANCE The singleton instance.

Constructor Detail

AnnotationOrderComparator	back to summary
private AnnotationOrderComparator()

Method Detail

compare back to summary

compare	back to summary
public int compare(FieldDescription.InDefinedShape left, FieldDescription.InDefinedShape right) Implements java.util.Comparator.compare. Doc from java.util.Comparator.compare. Compares its two arguments for order. Returns a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second. The implementor must ensure that `signum(compare(x, y)) == -signum(compare(y, x))` for all `x` and `y`. (This implies that `compare(x, y)` must throw an exception if and only if `compare(y, x)` throws an exception.) The implementor must also ensure that the relation is transitive: `((compare(x, y)>0) && (compare(y, z)>0))` implies `compare(x, z)>0`. Finally, the implementor must ensure that `compare(x, y)==0` implies that `signum(compare(x, z))==signum(compare(y, z))` for all `z`. Parameters left:FieldDescription.InDefinedShape the first object to be compared. right:FieldDescription.InDefinedShape the second object to be compared. Returns:int a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.

public int compare(FieldDescription.InDefinedShape left, FieldDescription.InDefinedShape right)

Implements java.util.Comparator.compare.

Doc from java.util.Comparator.compare.

Compares its two arguments for order. Returns a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.

The implementor must ensure that signum(compare(x, y)) == -signum(compare(y, x)) for all x and y. (This implies that compare(x, y) must throw an exception if and only if compare(y, x) throws an exception.)

The implementor must also ensure that the relation is transitive: ((compare(x, y)>0) && (compare(y, z)>0)) implies compare(x, z)>0.

Finally, the implementor must ensure that compare(x, y)==0 implies that signum(compare(x, z))==signum(compare(y, z)) for all z.

Parameters

left:FieldDescription.InDefinedShape: the first object to be compared.
right:FieldDescription.InDefinedShape: the second object to be compared.

Returns:int

a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.

valueOf	back to summary
public static HashCodeAndEqualsPlugin.AnnotationOrderComparator valueOf(String name)

values	back to summary
public static HashCodeAndEqualsPlugin.AnnotationOrderComparator[] values()

net.bytebuddy.build back to summary

public @Interface HashCodeAndEqualsPlugin.Enhance

Annotations

extends Annotation

@Documented
@Target:TYPE
@Retention:RUNTIME

Instructs the HashCodeAndEqualsPlugin to generate Object#hashCode() and Object#equals(Object) for the annotated class unless these methods are already declared explicitly.

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static enum	HashCodeAndEqualsPlugin.Enhance.InvokeSuper A strategy for determining the base value of a hash code or equality contract.

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: `true` if synthetic fields should be included. includeSyntheticFields() Determines if synthetic fields should be included in the hash code and equality contract.
public HashCodeAndEqualsPlugin.Enhance.InvokeSuper	Returns: A strategy for determining the base value. invokeSuper() Determines the base value of any added method, i.e. if hash code or equality is based on the super type or not.
public boolean	Returns: `true` if instances subclasses of the instrumented type are accepted upon an equality check. permitSubclassEquality() Determines if instances subclasses of the instrumented type are accepted upon an equality check.
public boolean	Returns: `true` if fields with simple comparison methods should be compared first. simpleComparisonsFirst() Determines if fields with primitive types, then enumeration types, then primtive wrapper types and then `String` types should be compared for equality before fields with other types.
public boolean	Returns: `true` if the hash code constant should be derived of the instrumented type. useTypeHashConstant() Determines if the hash code constant should be derived of the instrumented type.

Inherited from java.lang.annotation.Annotation:: annotationType equals hashCode toString

Method Detail

includeSyntheticFields back to summary

includeSyntheticFields	back to summary
public boolean includeSyntheticFields() Determines if synthetic fields should be included in the hash code and equality contract. Returns:boolean `true` if synthetic fields should be included.

public boolean includeSyntheticFields()

Determines if synthetic fields should be included in the hash code and equality contract.

Returns:boolean: true if synthetic fields should be included.

invokeSuper	back to summary
public HashCodeAndEqualsPlugin.Enhance.InvokeSuper invokeSuper() Determines the base value of any added method, i.e. if hash code or equality is based on the super type or not. Returns:HashCodeAndEqualsPlugin.Enhance.InvokeSuper A strategy for determining the base value.

invokeSuper

back to summary

public HashCodeAndEqualsPlugin.Enhance.InvokeSuper invokeSuper()

Determines the base value of any added method, i.e. if hash code or equality is based on the super type or not.

Returns:HashCodeAndEqualsPlugin.Enhance.InvokeSuper: A strategy for determining the base value.

permitSubclassEquality back to summary

permitSubclassEquality	back to summary
public boolean permitSubclassEquality() Determines if instances subclasses of the instrumented type are accepted upon an equality check. Returns:boolean `true` if instances subclasses of the instrumented type are accepted upon an equality check.

public boolean permitSubclassEquality()

Determines if instances subclasses of the instrumented type are accepted upon an equality check.

Returns:boolean: true if instances subclasses of the instrumented type are accepted upon an equality check.

simpleComparisonsFirst back to summary

simpleComparisonsFirst	back to summary
public boolean simpleComparisonsFirst() Determines if fields with primitive types, then enumeration types, then primtive wrapper types and then `String` types should be compared for equality before fields with other types. Before determining such a field order, the `Sorted` property is always considered first if it is defined. Returns:boolean `true` if fields with simple comparison methods should be compared first.

public boolean simpleComparisonsFirst()

Determines if fields with primitive types, then enumeration types, then primtive wrapper types and then String types should be compared for equality before fields with other types. Before determining such a field order, the Sorted property is always considered first if it is defined.

Returns:boolean: true if fields with simple comparison methods should be compared first.

useTypeHashConstant back to summary

useTypeHashConstant	back to summary
public boolean useTypeHashConstant() Determines if the hash code constant should be derived of the instrumented type. If `Enhance#permitSubclassEquality()` is set to `true`, this constant is derived of the declared class, otherwise the type hash is computed of the active instance. Returns:boolean `true` if the hash code constant should be derived of the instrumented type.

public boolean useTypeHashConstant()

Determines if the hash code constant should be derived of the instrumented type. If Enhance#permitSubclassEquality() is set to true, this constant is derived of the declared class, otherwise the type hash is computed of the active instance.

Returns:boolean: true if the hash code constant should be derived of the instrumented type.

net.bytebuddy.build back to summary

public sealed Enum HashCodeAndEqualsPlugin.Enhance.InvokeSuper

Class Inheritance

extends Enum<HashCodeAndEqualsPlugin.Enhance.InvokeSuper>

java.lang.Object
java.lang.Enum
net.bytebuddy.build.HashCodeAndEqualsPlugin.Enhance.InvokeSuper

A strategy for determining the base value of a hash code or equality contract.

Field Summary

Modifier and Type	Field and Description
public static final HashCodeAndEqualsPlugin.Enhance.InvokeSuper	ALWAYS Always invokes the super class's hash code and equality methods.
public static final HashCodeAndEqualsPlugin.Enhance.InvokeSuper	IF_ANNOTATED Only invokes the super method's hash code and equality methods if the super class is also annotated with `Enhance`.
public static final HashCodeAndEqualsPlugin.Enhance.InvokeSuper	IF_DECLARED Only invokes the super method's hash code and equality methods if any super class that is not `Object` explicitly defines such a method.
public static final HashCodeAndEqualsPlugin.Enhance.InvokeSuper	NEVER Never invokes the super class's hash code and equality methods.

Constructor Summary

Access	Constructor and Description
private	InvokeSuper()

Method Summary

Modifier and Type	Method and Description
protected abstract EqualsMethod	Returns: The equals method to use. equalsMethod(TypeDescription The instrumented type. instrumentedType) Resolves the equals method to use.
protected abstract HashCodeMethod	Returns: The hash code method to use. hashCodeMethod(TypeDescription The instrumented type. instrumentedType, boolean `true` if the base hash should be based on the instrumented class's type. typeHash, boolean `true` if subclasses can be equal to their base classes. subclassEquality) Resolves the hash code method to use.
public static HashCodeAndEqualsPlugin.Enhance.InvokeSuper	valueOf(String name)
public static HashCodeAndEqualsPlugin.Enhance.InvokeSuper[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

ALWAYS	back to summary
public static final HashCodeAndEqualsPlugin.Enhance.InvokeSuper ALWAYS Always invokes the super class's hash code and equality methods.

IF_ANNOTATED	back to summary
public static final HashCodeAndEqualsPlugin.Enhance.InvokeSuper IF_ANNOTATED Only invokes the super method's hash code and equality methods if the super class is also annotated with `Enhance`.

IF_DECLARED	back to summary
public static final HashCodeAndEqualsPlugin.Enhance.InvokeSuper IF_DECLARED Only invokes the super method's hash code and equality methods if any super class that is not `Object` explicitly defines such a method.

NEVER	back to summary
public static final HashCodeAndEqualsPlugin.Enhance.InvokeSuper NEVER Never invokes the super class's hash code and equality methods.

Constructor Detail

InvokeSuper	back to summary
private InvokeSuper()

Method Detail

equalsMethod	back to summary
protected abstract EqualsMethod equalsMethod(TypeDescription instrumentedType) Resolves the equals method to use. Parameters instrumentedType:TypeDescription The instrumented type. Returns:EqualsMethod The equals method to use.

equalsMethod

back to summary

protected abstract EqualsMethod equalsMethod(TypeDescription instrumentedType)

Resolves the equals method to use.

Parameters

instrumentedType:TypeDescription: The instrumented type.

Returns:EqualsMethod

The equals method to use.

hashCodeMethod back to summary

hashCodeMethod	back to summary
protected abstract HashCodeMethod hashCodeMethod(TypeDescription instrumentedType, boolean typeHash, boolean subclassEquality) Resolves the hash code method to use. Parameters instrumentedType:TypeDescription The instrumented type. typeHash:boolean `true` if the base hash should be based on the instrumented class's type. subclassEquality:boolean `true` if subclasses can be equal to their base classes. Returns:HashCodeMethod The hash code method to use.

protected abstract HashCodeMethod hashCodeMethod(TypeDescription instrumentedType, boolean typeHash, boolean subclassEquality)

Resolves the hash code method to use.

Parameters

instrumentedType:TypeDescription: The instrumented type.
typeHash:boolean: true if the base hash should be based on the instrumented class's type.
subclassEquality:boolean: true if subclasses can be equal to their base classes.

Returns:HashCodeMethod

The hash code method to use.

valueOf	back to summary
public static HashCodeAndEqualsPlugin.Enhance.InvokeSuper valueOf(String name)

values	back to summary
public static HashCodeAndEqualsPlugin.Enhance.InvokeSuper[] values()

net.bytebuddy.build back to summary

public @Interface HashCodeAndEqualsPlugin.Sorted

Annotations

extends Annotation

@Documented
@Target:FIELD
@Retention:RUNTIME

Determines the sort order of fields for the equality check when implementing the Object#equals(Object) method. Any field that is not annotated is considered with a value of Sorted#DEFAULT where fields with a higher value are checked for equality first. This sort order is applied first after which the type order is considered if Enhance#simpleComparisonsFirst() is considered as additional sort criteria.

Field Summary

Modifier and Type	Field and Description
public static final int	DEFAULT The default sort weight.

Method Summary

Modifier and Type	Method and Description
public int	Returns: The value for the sort order where fields with higher values are checked for equality first. value() The value for the sort order where fields with higher values are checked for equality first.

Inherited from java.lang.annotation.Annotation:: annotationType equals hashCode toString

Field Detail

DEFAULT	back to summary
public static final int DEFAULT The default sort weight.

Method Detail

value

back to summary

public int value()

The value for the sort order where fields with higher values are checked for equality first.

Returns:int: The value for the sort order where fields with higher values are checked for equality first.

net.bytebuddy.build back to summary

public @Interface HashCodeAndEqualsPlugin.ValueHandling

Annotations

extends Annotation

@Documented
@Target:FIELD
@Retention:RUNTIME

Determines how a field should be used within generated hash code and equality methods.

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static enum	HashCodeAndEqualsPlugin.ValueHandling.Sort Determines how a field should be handled.

Method Summary

Modifier and Type	Method and Description
public HashCodeAndEqualsPlugin.ValueHandling.Sort	Returns: The handling of the annotated field. value() Determines the handling of the annotated field.

Inherited from java.lang.annotation.Annotation:: annotationType equals hashCode toString

Method Detail

value

back to summary

public HashCodeAndEqualsPlugin.ValueHandling.Sort value()

Determines the handling of the annotated field.

Returns:HashCodeAndEqualsPlugin.ValueHandling.Sort: The handling of the annotated field.

net.bytebuddy.build back to summary

public final Enum HashCodeAndEqualsPlugin.ValueHandling.Sort

Class Inheritance

extends Enum<HashCodeAndEqualsPlugin.ValueHandling.Sort>

java.lang.Object
java.lang.Enum
net.bytebuddy.build.HashCodeAndEqualsPlugin.ValueHandling.Sort

Determines how a field should be handled.

Field Summary

Modifier and Type	Field and Description
public static final HashCodeAndEqualsPlugin.ValueHandling.Sort	IGNORE Excludes the field from hash code and equality methods.
public static final HashCodeAndEqualsPlugin.ValueHandling.Sort	REVERSE_NULLABILITY Reverses the nullability of the field, i.e. assumes this field to be non-null or `null` if `WithNonNullableFields` is used.

Constructor Summary

Access	Constructor and Description
private	Sort()

Method Summary

Modifier and Type	Method and Description
public static HashCodeAndEqualsPlugin.ValueHandling.Sort	valueOf(String name)
public static HashCodeAndEqualsPlugin.ValueHandling.Sort[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

IGNORE	back to summary
public static final HashCodeAndEqualsPlugin.ValueHandling.Sort IGNORE Excludes the field from hash code and equality methods.

REVERSE_NULLABILITY	back to summary
public static final HashCodeAndEqualsPlugin.ValueHandling.Sort REVERSE_NULLABILITY Reverses the nullability of the field, i.e. assumes this field to be non-null or `null` if `WithNonNullableFields` is used.

Constructor Detail

Sort	back to summary
private Sort()

Method Detail

valueOf	back to summary
public static HashCodeAndEqualsPlugin.ValueHandling.Sort valueOf(String name)

values	back to summary
public static HashCodeAndEqualsPlugin.ValueHandling.Sort[] values()

net.bytebuddy.build back to summary

protected Class HashCodeAndEqualsPlugin.ValueMatcher

Class Inheritance

extends ElementMatcher.Junction.ForNonNullValues<FieldDescription>

java.lang.Object
net.bytebuddy.matcher.ElementMatcher.Junction.AbstractBase
net.bytebuddy.matcher.ElementMatcher.Junction.ForNonNullValues
net.bytebuddy.build.HashCodeAndEqualsPlugin.ValueMatcher

Annotations

@Enhance

An element matcher for a ValueHandling annotation.

Field Summary

Modifier and Type	Field and Description
private final HashCodeAndEqualsPlugin.ValueHandling.Sort	sort The matched value.

Constructor Summary

Access	Constructor and Description
protected	ValueMatcher(HashCodeAndEqualsPlugin.ValueHandling.Sort The matched value. sort) Creates a new value matcher.

Method Summary

Modifier and Type	Method and Description
protected boolean	doMatch(FieldDescription The instance to be matched. target) Implements abstract net.bytebuddy.matcher.ElementMatcher.Junction.ForNonNullValues.doMatch. Matches the supplied value if it was found not to be `null`.

Inherited from net.bytebuddy.matcher.ElementMatcher.Junction.ForNonNullValues:: matches

Field Detail

sort	back to summary
private final HashCodeAndEqualsPlugin.ValueHandling.Sort sort The matched value.

Constructor Detail

ValueMatcher

back to summary

protected ValueMatcher(HashCodeAndEqualsPlugin.ValueHandling.Sort sort)

Creates a new value matcher.

Parameters

sort:HashCodeAndEqualsPlugin.ValueHandling.Sort: The matched value.

Method Detail

doMatch back to summary

protected boolean doMatch(FieldDescription target)

Implements abstract net.bytebuddy.matcher.ElementMatcher.Junction.ForNonNullValues.doMatch.

Doc from net.bytebuddy.matcher.ElementMatcher.Junction.ForNonNullValues.doMatch.

Matches the supplied value if it was found not to be null.

Parameters

target:FieldDescription: The instance to be matched.

Returns:boolean

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

net.bytebuddy.build back to summary

public Class HashCodeAndEqualsPlugin.WithNonNullableFields

Class Inheritance

extends HashCodeAndEqualsPlugin

java.lang.Object
net.bytebuddy.build.HashCodeAndEqualsPlugin
net.bytebuddy.build.HashCodeAndEqualsPlugin.WithNonNullableFields

Annotations

@Enhance

A version of the HashCodeAndEqualsPlugin that assumes that all fields are non-nullable unless they are explicitly marked.

Constructor Summary

Access	Constructor and Description
public	WithNonNullableFields() Creates a new hash code equals plugin where fields are assumed nullable by default.
public	WithNonNullableFields(String 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. annotationType) Creates a new hash code equals plugin where fields are assumed nullable by default.

Method Summary

Modifier and Type	Method and Description
protected ElementMatcher<FieldDescription>	nonNullable(ElementMatcher<FieldDescription> The matcher that identifies fields that are either nullable or non-nullable. matcher) Overrides net.bytebuddy.build.HashCodeAndEqualsPlugin.nonNullable. Resolves the matcher to identify non-nullable fields.

Inherited from net.bytebuddy.build.HashCodeAndEqualsPlugin:: apply apply close make make matches

Constructor Detail

WithNonNullableFields	back to summary
public WithNonNullableFields() Creates a new hash code equals plugin where fields are assumed nullable by default.

WithNonNullableFields back to summary

public WithNonNullableFields(String annotationType)

Creates a new hash code equals plugin where fields are assumed nullable by default.

Parameters

annotationType:String: 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

nonNullable

back to summary

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

Overrides net.bytebuddy.build.HashCodeAndEqualsPlugin.nonNullable.

Doc from net.bytebuddy.build.HashCodeAndEqualsPlugin.nonNullable.

Resolves the matcher to identify non-nullable fields.

Parameters

matcher:ElementMatcher<FieldDescription>: The matcher that identifies fields that are either nullable or non-nullable.

Returns:ElementMatcher<FieldDescription>

The actual matcher to identify non-nullable fields.