fr.cnes.sirius.patrius.math.parameter

Class ParameterDescriptor

java.lang.Object

fr.cnes.sirius.patrius.math.parameter.ParameterDescriptor

All Implemented Interfaces:

Serializable

public class ParameterDescriptor
extends Object
implements Serializable

Parameter descriptor.

Author:

Hugo Veuillez (CNES), Thibaut Bonit (Thales Services), Pierre Seimandi (GMV)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ParameterDescriptor() Creates a new instance that is not associated with any field.
ParameterDescriptor(FieldDescriptor<T> fieldDescriptor, T fieldValue) Creates a new instance that is associated with a single field.
ParameterDescriptor(Map<FieldDescriptor<?>,Object> fieldsMap) Creates a new instance that is associated with the provided fields.
ParameterDescriptor(String name) Creates a new instance that is associated with a single field representing the name of the parameter.

Method Summary

Modifier and Type	Method and Description
<T> T	addField(FieldDescriptor<T> fieldDescriptor, T fieldValue) Adds a single field descriptor with this parameter descriptor and maps it to the specified value (stored values are overwritten when a field descriptor is already associated with this instance).
<T> T	addFieldIfAbsent(FieldDescriptor<T> fieldDescriptor, T fieldValue) Adds a single field descriptor with this parameter descriptor and maps it to the specified value (stored values are overwritten when a field descriptor is already associated with this instance).
Object	addUntypedField(FieldDescriptor<?> fieldDescriptor, Object fieldValue) Adds a single field descriptor with this parameter descriptor and maps it to the specified value (stored values are overwritten when a field descriptor is already associated with this instance).
void	addUntypedFields(Map<FieldDescriptor<?>,Object> fieldsMap) Adds multiple field descriptors with this parameter descriptor and maps them to the specified values (existing values are overwritten when a field descriptor is already associated with this instance).
static boolean	areEqual(ParameterDescriptor parameterDescriptor1, ParameterDescriptor parameterDescriptor2, Collection<FieldDescriptor<?>> fieldDescriptors) Checks if two parameter descriptors are equal with respect to multiple field descriptors.
static boolean	areEqual(ParameterDescriptor parameterDescriptor1, ParameterDescriptor parameterDescriptor2, FieldDescriptor<?>... fieldDescriptors) Checks if two parameter descriptors are equal with respect to multiple field descriptors.
static boolean	areEqual(ParameterDescriptor parameterDescriptor1, ParameterDescriptor parameterDescriptor2, FieldDescriptor<?> fieldDescriptor) Checks if two parameter descriptors are equal with respect to a given field descriptor.
void	clear() Removes all the fields currently associated with this parameter descriptor.
boolean	contains(FieldDescriptor<?> fieldDescriptor) Checks if a field descriptor is currently associated with this parameter descriptor.
boolean	contains(FieldDescriptor<?> fieldDescriptor, Object fieldValue) Checks if a field descriptor is currently associated with this parameter descriptor and mapped to a given value.
ParameterDescriptor	copy() Performs a shallow copy of the parameter descriptor (the references to the field descriptors and the mapped values are preserved).
boolean	equals(Object object) Indicates whether some other object is "equal to" this one.
boolean	equals(ParameterDescriptor parameterDescriptor, Collection<FieldDescriptor<?>> fieldDescriptors) Checks if this parameter descriptor is equal to another one with respect to multiple field descriptors.
boolean	equals(ParameterDescriptor parameterDescriptor, FieldDescriptor<?>... fieldDescriptors) Checks if this parameter descriptor is equal to another one with respect to multiple field descriptors.
boolean	equals(ParameterDescriptor parameterDescriptor, FieldDescriptor<?> fieldDescriptor) Checks if this parameter descriptor is equal to another one with respect to a given field descriptor.
ParameterDescriptor	extractSubset(Collection<FieldDescriptor<?>> fieldDescriptors) Returns a new ParameterDescriptor instance which is only associated with the selected subset of field descriptors (the ones which are not currently associated with this parameter descriptor are simply ignored; the field values remain unchanged).
ParameterDescriptor	extractSubset(FieldDescriptor<?>... fieldDescriptors) Returns a new ParameterDescriptor instance which is only associated with the selected subset of field descriptors (the ones which are not currently associated with this parameter descriptor are simply ignored; the field values remain unchanged).
Set<FieldDescriptor<?>>	getAssociatedFieldDescriptors() Gets the field descriptors currently associated with this parameter descriptor.
Map<FieldDescriptor<?>,Object>	getAssociatedFields() Gets the field descriptors currently associated with this parameter descriptor and the values mapped to them.
<T> T	getFieldValue(FieldDescriptor<T> fieldDescriptor) Gets the value currently mapped to a given field descriptor.
String	getName() Gets the name of this parameter descriptor, which is comprised of the associated field values separated by an underscore (printed in reverse order by default).
String	getName(boolean reverseOrder) Gets the name of this parameter descriptor, which is comprised of the associated field values separated by an underscore.
String	getName(String separator) Gets the name of this parameter descriptor, which is comprised of the associated field values separated by the specified string (printed in reverse order by default).
String	getName(String separator, boolean reverseOrder) Gets the name of this parameter descriptor, which is comprised of the associated field values separated by the specified string.
int	hashCode()
ParameterDescriptor	intersectionWith(ParameterDescriptor descriptor) Extracts the field descriptors associated with both this parameter descriptor and the one provided, and which are mapped to the same value.
boolean	isEmpty() Checks whether this parameter descriptor is currently associated with anything or not.
boolean	isMutable() Checks if this parameter descriptor is currently mutable or not.
ParameterDescriptor	mergeWith(ParameterDescriptor descriptor) Merges this parameter descriptor with another one.
<T> T	removeField(FieldDescriptor<T> fieldDescriptor) Removes a given field descriptor from this parameter descriptor.
<T> boolean	removeField(FieldDescriptor<T> fieldDescriptor, T fieldValue) Removes a given field descriptor from this parameter descriptor if it is currently mapped to the specified value.
boolean	removeUntypedField(FieldDescriptor<?> fieldDescriptor, Object fieldValue) Removes a given field descriptor from this parameter descriptor if it is currently mapped to the specified value.
void	removeUntypedFields(Collection<FieldDescriptor<?>> fieldDescriptors) Removes multiple field descriptors and the associated values from this parameter descriptor.
void	removeUntypedFields(FieldDescriptor<?>... fieldDescriptors) Removes multiple field descriptors and the associated values from this parameter descriptor.
<T> T	replaceField(FieldDescriptor<T> fieldDescriptor, T fieldValue) Replaces the value mapped to a given field descriptor if it is currently associated with this parameter descriptor.
<T> boolean	replaceField(FieldDescriptor<T> fieldDescriptor, T oldFieldValue, T newFieldValue) Replaces the value mapped to a given field descriptor if it is currently associated with this parameter descriptor and mapped to the specified value.
Object	replaceUntypedField(FieldDescriptor<?> fieldDescriptor, Object fieldValue) Replaces the value mapped to a given field descriptor if it is currently associated with this parameter descriptor.
boolean	replaceUntypedField(FieldDescriptor<?> fieldDescriptor, Object oldFieldValue, Object newFieldValue) Replaces the value mapped to a given field descriptor if it is currently associated with this parameter descriptor and mapped to the specified value.
ParameterDescriptor	setMutability(boolean enabled) Enables or disables the mutability of this parameter descriptor.
String	toString() Gets a string representation of this parameter descriptor which includes the name of this class, the name of associated the field descriptors and their mapped values (printed in reverse order by default).
String	toString(boolean reverseOrder) Gets a string representation of this parameter descriptor which includes the name of this class, the name of associated the field descriptors and their mapped values.
String	toString(String keySeparator, String entrySeparator, boolean printClassName, boolean printFieldName, boolean printFieldValue, boolean reverseOrder) Gets a string representation of this parameter descriptor.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ParameterDescriptor

public ParameterDescriptor()

Creates a new instance that is not associated with any field.

ParameterDescriptor

public ParameterDescriptor(String name)

Creates a new instance that is associated with a single field representing the name of the parameter.

Parameters:

name - the name of the parameter

ParameterDescriptor

public ParameterDescriptor(FieldDescriptor<T> fieldDescriptor,
                           T fieldValue)

Creates a new instance that is associated with a single field.

Type Parameters:

T - the type of the field value

Parameters:

fieldDescriptor - the field descriptor

fieldValue - the value mapped to the provided field descriptor

Throws:

IllegalArgumentException - if the provided field descriptor or field value is null

ParameterDescriptor

public ParameterDescriptor(Map<FieldDescriptor<?>,Object> fieldsMap)

Creates a new instance that is associated with the provided fields.

Important: each of the provided values must be assignable to the the class specified by the corresponding field descriptor. An exception will be automatically thrown if that is not the case.

Parameters:

fieldsMap - the map between the initial field descriptors and the values mapped to them

Throws:

ClassCastException - if one of the provided values cannot be cast to the class specified by its field descriptor

Method Detail

getAssociatedFields

public Map<FieldDescriptor<?>,Object> getAssociatedFields()

Gets the field descriptors currently associated with this parameter descriptor and the values mapped to them.

Returns:

the associated field descriptors and the values mapped to them

getAssociatedFieldDescriptors

public Set<FieldDescriptor<?>> getAssociatedFieldDescriptors()

Gets the field descriptors currently associated with this parameter descriptor.

Returns:

the associated field descriptors

isMutable

public boolean isMutable()

Checks if this parameter descriptor is currently mutable or not.

The mutability of this parameter descriptor can be enabled or disabled at will through the setMutability(boolean) method. Methods updating a parameter descriptor should always check its mutability beforehand.

Returns:

true if this parameter descriptor is currently mutable, false otherwise

setMutability

public ParameterDescriptor setMutability(boolean enabled)

Enables or disables the mutability of this parameter descriptor.

Parameters:

enabled - whether or not to allow this parameter descriptor to be mutable

Returns:

this parameter descriptor (for chaining)

contains

public boolean contains(FieldDescriptor<?> fieldDescriptor)

Checks if a field descriptor is currently associated with this parameter descriptor.

Parameters:

fieldDescriptor - the field descriptor to check

Returns:

true if the provided field descriptor is associated with this parameter descriptor, false otherwise

contains

public boolean contains(FieldDescriptor<?> fieldDescriptor,
                        Object fieldValue)

Checks if a field descriptor is currently associated with this parameter descriptor and mapped to a given value.

Parameters:

fieldDescriptor - the field descriptor to check

fieldValue - the value expected to be mapped to the provided field descriptor

Returns:

true if the provided field descriptor is associated with this parameter descriptor and mapped to the specified value, false otherwise

addField

public final <T> T addField(FieldDescriptor<T> fieldDescriptor,
                            T fieldValue)

Adds a single field descriptor with this parameter descriptor and maps it to the specified value (stored values are overwritten when a field descriptor is already associated with this instance).

Type Parameters:

T - the type of the field value

Parameters:

fieldDescriptor - the field descriptor to add

fieldValue - the value to be mapped to the specified field descriptor

Returns:

the value which was previously mapped to the provided field descriptor, or null if this field descriptor was not already associated with this parameter descriptor

Throws:

IllegalStateException - if this parameter descriptor is currently immutable

NullArgumentException - if the provided field descriptor or field value is null

addFieldIfAbsent

public final <T> T addFieldIfAbsent(FieldDescriptor<T> fieldDescriptor,
                                    T fieldValue)

Adds a single field descriptor with this parameter descriptor and maps it to the specified value (stored values are overwritten when a field descriptor is already associated with this instance).

Note: This method only adds the field if the field descriptor isn't already initialized in the map.

Type Parameters:

T - the type of the field value

Parameters:

fieldDescriptor - the field descriptor to add

fieldValue - the value to be mapped to the specified field descriptor

Returns:

the value which was previously mapped to the provided field descriptor, or null if this field descriptor was not already associated with this parameter descriptor

Throws:

IllegalStateException - if this parameter descriptor is currently immutable

NullArgumentException - if the provided field descriptor or field value is null

addUntypedField

public final Object addUntypedField(FieldDescriptor<?> fieldDescriptor,
                                    Object fieldValue)

Adds a single field descriptor with this parameter descriptor and maps it to the specified value (stored values are overwritten when a field descriptor is already associated with this instance).

Important: the provided value must be assignable to the class specified by the field descriptor. An exception will be automatically thrown if that is not the case.

Parameters:

fieldDescriptor - the field descriptor to add

fieldValue - the value to be associated with the specified field descriptor

Returns:

the value which was previously mapped to the provided field descriptor, or null if this field descriptor was not already associated with this parameter descriptor

Throws:

IllegalStateException - if this parameter descriptor is currently immutable

NullArgumentException - if the provided field descriptor or field value is null

ClassCastException - if the provided field value cannot be cast to the class specified by the field descriptor

addUntypedFields

public final void addUntypedFields(Map<FieldDescriptor<?>,Object> fieldsMap)

Adds multiple field descriptors with this parameter descriptor and maps them to the specified values (existing values are overwritten when a field descriptor is already associated with this instance).

Important: each of the provided values must be assignable to the the class specified by the corresponding field descriptor. An exception will be automatically thrown if that is not the case.

Parameters:

fieldsMap - the field descriptors to be added and the values mapped to them

Throws:

IllegalStateException - if this parameter descriptor is currently immutable

IllegalArgumentException - if one of the field descriptors or field values is null

ClassCastException - if a field value cannot be cast to the class specified by the associated field descriptor

replaceField

public <T> T replaceField(FieldDescriptor<T> fieldDescriptor,
                          T fieldValue)

Replaces the value mapped to a given field descriptor if it is currently associated with this parameter descriptor.

Type Parameters:

T - the type of the field value

Parameters:

fieldDescriptor - the field descriptor whose mapped value is to be replaced

fieldValue - the new value to be mapped to the specified field descriptor

Returns:

the value which was previously mapped to the provided field descriptor, or null if this field descriptor is not associated with this parameter descriptor

Throws:

IllegalStateException - if this parameter descriptor is currently immutable

NullArgumentException - if the new field value is null

replaceField

public <T> boolean replaceField(FieldDescriptor<T> fieldDescriptor,
                                T oldFieldValue,
                                T newFieldValue)

Replaces the value mapped to a given field descriptor if it is currently associated with this parameter descriptor and mapped to the specified value.

Type Parameters:

T - the type of the field values

Parameters:

fieldDescriptor - the field descriptor whose mapped value is to be replaced

oldFieldValue - the value expected to be mapped to the specified field descriptor

newFieldValue - the new value to be mapped to the specified field descriptor

Returns:

true if the value mapped to the specified field descriptor was replaced, false otherwise

Throws:

IllegalStateException - if this parameter descriptor is currently immutable

NullArgumentException - if the new field value is null

replaceUntypedField

public Object replaceUntypedField(FieldDescriptor<?> fieldDescriptor,
                                  Object fieldValue)

Replaces the value mapped to a given field descriptor if it is currently associated with this parameter descriptor.

Important: the provided value must be assignable to the class specified by the field descriptor. An exception will be automatically thrown if that is not the case.

Parameters:

fieldDescriptor - the field descriptor whose mapped value is to be replaced

fieldValue - the new value to be mapped to the specified field descriptor

Returns:

the value which was previously mapped to the provided field descriptor, or null if this field descriptor is not associated with this parameter descriptor

Throws:

IllegalStateException - if this parameter descriptor is currently immutable

NullArgumentException - if the new field value is null

ClassCastException - if the new field value cannot be cast to the class specified by the field descriptor

replaceUntypedField

public boolean replaceUntypedField(FieldDescriptor<?> fieldDescriptor,
                                   Object oldFieldValue,
                                   Object newFieldValue)

Replaces the value mapped to a given field descriptor if it is currently associated with this parameter descriptor and mapped to the specified value.

Important: the provided values must be assignable to the class specified by the field descriptor. An exception will be automatically thrown if that is not the case.

Parameters:

fieldDescriptor - the field descriptor whose mapped value is to be replaced

oldFieldValue - the value expected to be mapped to the specified field descriptor

newFieldValue - the new value to be mapped to the specified field descriptor

Returns:

true if the value mapped to the specified field descriptor was replaced, false otherwise

Throws:

IllegalStateException - if this parameter descriptor is currently immutable

NullArgumentException - if the new field value is null

ClassCastException - if the new field value cannot be cast to the class specified by the field descriptor

removeField

public <T> T removeField(FieldDescriptor<T> fieldDescriptor)

Removes a given field descriptor from this parameter descriptor.

Type Parameters:

T - the type of the associated with the field descriptor

Parameters:

fieldDescriptor - the field descriptor to be removed

Returns:

the value which was previously mapped to the provided field descriptor, or null if this field descriptor was not associated with this parameter descriptor

Throws:

IllegalStateException - if this parameter descriptor is currently immutable

removeField

public <T> boolean removeField(FieldDescriptor<T> fieldDescriptor,
                               T fieldValue)

Removes a given field descriptor from this parameter descriptor if it is currently mapped to the specified value.

Type Parameters:

T - the type of the field value

Parameters:

fieldDescriptor - the field descriptor to be removed

fieldValue - the value expected to be mapped with the specified field descriptor

Returns:

true if the specified field descriptor and its mapped value were removed, false otherwise

Throws:

IllegalStateException - if this parameter descriptor is currently immutable

removeUntypedField

public boolean removeUntypedField(FieldDescriptor<?> fieldDescriptor,
                                  Object fieldValue)

Removes a given field descriptor from this parameter descriptor if it is currently mapped to the specified value.

Parameters:

fieldDescriptor - the field descriptor to be removed

fieldValue - the value expected to be mapped with the specified field descriptor

Returns:

true if the specified field descriptor and its mapped value were removed, false otherwise

Throws:

IllegalStateException - if this parameter descriptor is currently immutable

removeUntypedFields

public void removeUntypedFields(FieldDescriptor<?>... fieldDescriptors)

Removes multiple field descriptors and the associated values from this parameter descriptor.

Parameters:

fieldDescriptors - the field descriptors to be removed

Throws:

IllegalStateException - if this parameter descriptor is currently immutable

removeUntypedFields

public void removeUntypedFields(Collection<FieldDescriptor<?>> fieldDescriptors)

Removes multiple field descriptors and the associated values from this parameter descriptor.

Parameters:

fieldDescriptors - the field descriptors to be removed

Throws:

IllegalStateException - if this parameter descriptor is currently immutable

clear

public void clear()

Removes all the fields currently associated with this parameter descriptor.

isEmpty

public boolean isEmpty()

Checks whether this parameter descriptor is currently associated with anything or not.

Returns:

true if this parameter descriptor is not associated with anything, false otherwise

getFieldValue

public <T> T getFieldValue(FieldDescriptor<T> fieldDescriptor)

Gets the value currently mapped to a given field descriptor.

Type Parameters:

T - the type of the field value

Parameters:

fieldDescriptor - the field descriptor

Returns:

the value mapped to the specified field descriptor, or null if the field descriptor is not associated with this parameter descriptor

Throws:

NullArgumentException - if the provided field descriptor is null

extractSubset

public ParameterDescriptor extractSubset(FieldDescriptor<?>... fieldDescriptors)

Returns a new ParameterDescriptor instance which is only associated with the selected subset of field descriptors (the ones which are not currently associated with this parameter descriptor are simply ignored; the field values remain unchanged).

Parameters:

fieldDescriptors - the selected field descriptors

Returns:

the new ParameterDescriptor instance build

extractSubset

public ParameterDescriptor extractSubset(Collection<FieldDescriptor<?>> fieldDescriptors)

Returns a new ParameterDescriptor instance which is only associated with the selected subset of field descriptors (the ones which are not currently associated with this parameter descriptor are simply ignored; the field values remain unchanged).

Parameters:

fieldDescriptors - the selected field descriptors

Returns:

the new ParameterDescriptor instance build

mergeWith

public ParameterDescriptor mergeWith(ParameterDescriptor descriptor)

Merges this parameter descriptor with another one.

The field descriptors of both this instance and the one provided are kept. When a field descriptor is associated with both instances, the provided parameter descriptor takes precedence and replaces the currently mapped value.

Parameters:

descriptor - the other parameter descriptor

Returns:

the ParameterDescriptor instance resulting from the merging process

intersectionWith

public ParameterDescriptor intersectionWith(ParameterDescriptor descriptor)

Extracts the field descriptors associated with both this parameter descriptor and the one provided, and which are mapped to the same value.

Parameters:

descriptor - the other parameter descriptor

Returns:

the ParameterDescriptor instance resulting from the intersection

getName

public String getName()

Gets the name of this parameter descriptor, which is comprised of the associated field values separated by an underscore (printed in reverse order by default).

Returns:

the name of this parameter descriptor

getName

public String getName(boolean reverseOrder)

Gets the name of this parameter descriptor, which is comprised of the associated field values separated by an underscore.

Parameters:

reverseOrder - whether or not the field values should be printed in reverse order

Returns:

the name of this parameter descriptor

getName

public String getName(String separator)

Gets the name of this parameter descriptor, which is comprised of the associated field values separated by the specified string (printed in reverse order by default).

Parameters:

separator - the string used as separator between two field values

Returns:

the name of this parameter descriptor

getName

public String getName(String separator,
                      boolean reverseOrder)

Gets the name of this parameter descriptor, which is comprised of the associated field values separated by the specified string.

Parameters:

separator - the string used as separator between two field values

reverseOrder - whether or not the field values should be printed in reverse order

Returns:

the name of this parameter descriptor

toString

public String toString()

Gets a string representation of this parameter descriptor which includes the name of this class, the name of associated the field descriptors and their mapped values (printed in reverse order by default).

Overrides:

toString in class Object

Returns:

a string representation of this parameter descriptor

toString

public String toString(boolean reverseOrder)

Gets a string representation of this parameter descriptor which includes the name of this class, the name of associated the field descriptors and their mapped values.

Parameters:

reverseOrder - whether or not the field descriptors and their mapped values should be printed in reverse order

Returns:

a string representation of this parameter descriptor

toString

public String toString(String keySeparator,
                       String entrySeparator,
                       boolean printClassName,
                       boolean printFieldName,
                       boolean printFieldValue,
                       boolean reverseOrder)

Gets a string representation of this parameter descriptor.

Parameters:

keySeparator - the string used as separator between a key and its mapped value

entrySeparator - the string used as separator between two entries

printClassName - whether or not the name of this class should be printed

printFieldName - whether or not the name associated with the field descriptors should be printed

printFieldValue - whether or not the values mapped to the field descriptors should be printed

reverseOrder - whether or not the field descriptors and their mapped values should be printed in reverse order

Returns:

a string representation of this parameter descriptor

copy

public ParameterDescriptor copy()

Performs a shallow copy of the parameter descriptor (the references to the field descriptors and the mapped values are preserved).

Returns:

a shallow copy of this parameter descriptor

equals

public boolean equals(Object object)

Indicates whether some other object is "equal to" this one.

This method only compares the associated field descriptors and the values mapped to them when checking if two ParameterDescriptor instances are equal or not. The order in which the field descriptors are stored and their mutability are not taken into account.

Overrides:

equals in class Object

Parameters:

object - the reference object with which to compare

Returns:

true if this object is the same as the provided object, false otherwise

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(ParameterDescriptor parameterDescriptor,
                      FieldDescriptor<?> fieldDescriptor)

Checks if this parameter descriptor is equal to another one with respect to a given field descriptor.

This method considers that two ParameterDescriptor instances are equal if the specified field descriptor is mapped to the same value in both instances, or if it is not associated with either of the instances.

Parameters:

parameterDescriptor - the parameter descriptor to compare this instance with

fieldDescriptor - the field descriptor to check

Returns:

true if the specified field descriptor is mapped to the same value in both parameter descriptors, false otherwise

equals

public boolean equals(ParameterDescriptor parameterDescriptor,
                      FieldDescriptor<?>... fieldDescriptors)

Checks if this parameter descriptor is equal to another one with respect to multiple field descriptors.

This method considers that two ParameterDescriptor instances are equal if the specified field descriptors are mapped to the same values in both instances, or if they are not associated with either of the instances.

Parameters:

parameterDescriptor - the parameter descriptor to compare this instance with

fieldDescriptors - the field descriptors to check

Returns:

true if the specified field descriptors are mapped to the same values in both parameter descriptors, false otherwise

equals

public boolean equals(ParameterDescriptor parameterDescriptor,
                      Collection<FieldDescriptor<?>> fieldDescriptors)

Checks if this parameter descriptor is equal to another one with respect to multiple field descriptors.

This method considers that two ParameterDescriptor instances are equal if the specified field descriptors are mapped to the same values in both instances, or if they are not associated with either of the instances.

Parameters:

parameterDescriptor - the parameter descriptor to compare this instance with

fieldDescriptors - the field descriptors to check

Returns:

true if the specified field descriptors are mapped to the same values in both parameter descriptors, false otherwise

areEqual

public static boolean areEqual(ParameterDescriptor parameterDescriptor1,
                               ParameterDescriptor parameterDescriptor2,
                               FieldDescriptor<?> fieldDescriptor)

Checks if two parameter descriptors are equal with respect to a given field descriptor.

This method considers that two ParameterDescriptor instances are equal if the specified field descriptor is mapped to the same value in both instances, or if it is not associated with either of the instances.

Parameters:

parameterDescriptor1 - the first parameter descriptor

parameterDescriptor2 - the second parameter descriptor

fieldDescriptor - the field descriptor to check

Returns:

true if the specified field descriptor is mapped to the same value in both parameter descriptors, false otherwise

areEqual

public static boolean areEqual(ParameterDescriptor parameterDescriptor1,
                               ParameterDescriptor parameterDescriptor2,
                               FieldDescriptor<?>... fieldDescriptors)

Checks if two parameter descriptors are equal with respect to multiple field descriptors.

This method considers that two ParameterDescriptor instances are equal if the specified field descriptors are mapped to the same values in both instances, or if they are not associated with either of the instances.

Parameters:

parameterDescriptor1 - the first parameter descriptor

parameterDescriptor2 - the second parameter descriptor

fieldDescriptors - the field descriptors to check

Returns:

true if the specified field descriptors are mapped to the same values in both parameter descriptors, false otherwise

Throws:

NullArgumentException - if the provided field descriptor array is null

areEqual

public static boolean areEqual(ParameterDescriptor parameterDescriptor1,
                               ParameterDescriptor parameterDescriptor2,
                               Collection<FieldDescriptor<?>> fieldDescriptors)

Checks if two parameter descriptors are equal with respect to multiple field descriptors.

This method considers that two ParameterDescriptor instances are equal if the specified field descriptors are mapped to the same values in both instances, or if they are not associated with either of the instances.

Parameters:

parameterDescriptor1 - the first parameter descriptor

parameterDescriptor2 - the second parameter descriptor

fieldDescriptors - the field descriptors to check

Returns:

true if the specified field descriptors are mapped to the same values in both parameter descriptors, false otherwise

Throws:

NullArgumentException - if the provided field descriptor collection is null