fr.cnes.sirius.patrius.math.parameter

Class FieldDescriptor<T>

java.lang.Object

fr.cnes.sirius.patrius.math.parameter.FieldDescriptor<T>

Type Parameters:

T - the type of the described field

All Implemented Interfaces:

Serializable

public class FieldDescriptor<T>
extends Object
implements Serializable

Field descriptor.

A field descriptor associates a name with a given class, and provides the means to generate custom string representations of any instance of this class.

Author:

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
FieldDescriptor(String nameIn, Class<T> fieldClassIn) Creates a new field descriptor.
FieldDescriptor(String nameIn, Class<T> fieldClassIn, Function<T,String> printFunctionIn) Creates a new field descriptor which uses the specified function to convert field values to strings.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object object) Indicates whether some other object is "equal to" this one.
Class<T>	getFieldClass() Gets the class of the described fields.
String	getName() Gets the name of the descriptor.
Function<T,String>	getPrintFunction() Gets the function to use when converting field values to strings.
int	hashCode()
String	printField(Object value) Gets a string representation of a given field value.
void	setPrintFunction(Function<T,String> newPrintFunction) Sets the function to use when converting field values to strings.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

FieldDescriptor

public FieldDescriptor(String nameIn,
                       Class<T> fieldClassIn)

Creates a new field descriptor.

Parameters:

nameIn - the name of the descriptor

fieldClassIn - the class of the described fields

Throws:

IllegalArgumentException - if nameIn or fieldClassIn is null

FieldDescriptor

public FieldDescriptor(String nameIn,
                       Class<T> fieldClassIn,
                       Function<T,String> printFunctionIn)

Creates a new field descriptor which uses the specified function to convert field values to strings.

Parameters:

nameIn - the name of the descriptor

fieldClassIn - the class of the described fields

printFunctionIn - the function to use when converting field values to strings

Throws:

NullArgumentException - if nameIn or fieldClassIn is null

Method Detail

getName

public String getName()

Gets the name of the descriptor.

Returns:

the name of the descriptor

getFieldClass

public Class<T> getFieldClass()

Gets the class of the described fields.

Returns:

the class of the described fields

getPrintFunction

public Function<T,String> getPrintFunction()

Gets the function to use when converting field values to strings.

Returns:

the function to use when converting field values to strings

setPrintFunction

public void setPrintFunction(Function<T,String> newPrintFunction)

Sets the function to use when converting field values to strings.

Parameters:

newPrintFunction - the new function to use when converting field values to strings

printField

public String printField(Object value)

Gets a string representation of a given field value.

The string representation of the field value is generated using the printer function specified at construction. The standard toString method is used instead if no function was specified, or if the class of the provided object does not match the class associated with this field descriptor.

Parameters:

value - the field value

Returns:

a string representation of the specified field value

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object object)

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

This method only compares the name of the descriptor and the class of the described fields when checking if two FieldDescriptor instances are equal or not. The function used to convert field values to strings is 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