com.atlassian.plugin.descriptors

Class ModuleDescriptors.EqualsBuilder

java.lang.Object

com.atlassian.plugin.descriptors.ModuleDescriptors.EqualsBuilder

Enclosing class:

ModuleDescriptors

@NotThreadSafe
public static class ModuleDescriptors.EqualsBuilder
extends Object

Assists in implementing a consistent implementation of ModuleDescriptor.equals(Object) methods for module descriptors based on the complete key of the descriptor.

The full specification of the equals(Object obj) contract is defined by ModuleDescriptor.equals(Object)

Usage:

1. If you are using this builder to implement the equals(Object obj) method in a module descriptor implementation:

   new ModuleDescriptors.EqualsBuilder().descriptor(this).isEqualTo(obj);

2. If you are using this builder to compare descriptors from outside a module descriptor implementation; given two descriptor instances, descriptor1 and descriptor2:

   new ModuleDescriptors.EqualsBuilder().descriptor(descriptor1).isEqualTo(descriptor2);

Since:

2.8.0

Constructor Summary

Constructors

Constructor and Description
ModuleDescriptors.EqualsBuilder()

Method Summary

Methods

Modifier and Type	Method and Description
ModuleDescriptors.EqualsBuilder	descriptor(ModuleDescriptor descriptor) Sets the module descriptor to create an equals implementation for.
boolean	isEqualTo(Object obj) Returns true if the given object is also a module descriptor and the two descriptors have the same "complete key" as determined by ModuleDescriptor.getCompleteKey().

Methods inherited from class java.lang.Object

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

Constructor Detail

ModuleDescriptors.EqualsBuilder

public ModuleDescriptors.EqualsBuilder()

Method Detail

descriptor

public ModuleDescriptors.EqualsBuilder descriptor(ModuleDescriptor descriptor)

Sets the module descriptor to create an equals implementation for.

Parameters:

descriptor - the module descriptor.

Returns:

this builder instance.

isEqualTo

public boolean isEqualTo(Object obj)

Returns true if the given object is also a module descriptor and the two descriptors have the same "complete key" as determined by ModuleDescriptor.getCompleteKey().

Parameters:

obj - object to be compared for equality with this module descriptor.

Returns:

true if the specified object is equal to this module descriptor.