Top Description Fields Constructors Methods
com.univocity.parsers.annotations.helpers

public final Class MethodDescriptor

extends Object
Class Inheritance
Imports
java.lang.reflect.*

A very basic descriptor or getter/setter methods

Field Summary

Modifier and TypeField and Description
private final String
private final Class<?>
private final String
private final String
private final Class<?>
private final String

Constructor Summary

AccessConstructor and Description
private
MethodDescriptor(String name, Class<?> parameterType, Class<?> returnType)

private
MethodDescriptor(String prefix, String name, Class<?> parameterType, Class<?> returnType)

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object
the reference object with which to compare.
o
)

Overrides java.lang.Object.equals.

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

Returns:

the method name
getName
()

Returns the method name, without the prefix

public Class<?>

Returns:

the type of parameter accepted by this method if it is a setter, or null if a getter is being represented.
getParameterType
()

Returns the parameter type associated with a method, if available

public String

Returns:

the object nesting path associated with a method.
getPrefix
()

Returns the prefix: a dot separated string denoting a path of nested object names (e.g. customer.contact).

public String

Returns:

the path to the given method.
getPrefixedName
()

Returns full path to a method, (e.g. getName or person.getName

public Class<?>

Returns:

the return type of this method if it is a getter, or null if a setter is being represented.
getReturnType
()

Returns the return type associated with a method, if available

public static MethodDescriptor

Returns:

a "getter" method descriptor
getter
(String
name of the getter method
name
,
Class<?>
the return type of the given getter method
returnType
)

Creates a descriptor for a getter method

pack-priv static MethodDescriptor

Returns:

a "getter" method descriptor
getter
(String
a dot separated string denoting a path of nested object names
prefix
,
Method
a actual class method to be associated with this prefix
method
)

Creates a descriptor for a getter method

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.
public static MethodDescriptor

Returns:

a "setter" method descriptor
setter
(String
name of the setter method
name
,
Class<?>
the parameter type accepted by the given setter method
parameterType
)

Creates a descriptor for a setter method

pack-priv static MethodDescriptor

Returns:

a "setter" method descriptor
setter
(String
a dot separated string denoting a path of nested object names
prefix
,
Method
a actual class method to be associated with this prefix
method
)

Creates a descriptor for a setter method

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

nameback to summary
private final String name
parameterTypeback to summary
private final Class<?> parameterType
prefixback to summary
private final String prefix
prefixedNameback to summary
private final String prefixedName
returnTypeback to summary
private final Class<?> returnType
stringback to summary
private final String string

Constructor Detail

MethodDescriptorback to summary
private MethodDescriptor(String name, Class<?> parameterType, Class<?> returnType)
MethodDescriptorback to summary
private MethodDescriptor(String prefix, String name, Class<?> parameterType, Class<?> returnType)

Method Detail

equalsback to summary
public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

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

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
o:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
generateStringback to summary
private String generateString()
getNameback to summary
public String getName()

Returns the method name, without the prefix

Returns:String

the method name

getParameterTypeback to summary
public Class<?> getParameterType()

Returns the parameter type associated with a method, if available

Returns:Class<?>

the type of parameter accepted by this method if it is a setter, or null if a getter is being represented.

getPrefixback to summary
public String getPrefix()

Returns the prefix: a dot separated string denoting a path of nested object names (e.g. customer.contact).

Returns:String

the object nesting path associated with a method.

getPrefixedNameback to summary
public String getPrefixedName()

Returns full path to a method, (e.g. getName or person.getName

Returns:String

the path to the given method.

getReturnTypeback to summary
public Class<?> getReturnType()

Returns the return type associated with a method, if available

Returns:Class<?>

the return type of this method if it is a getter, or null if a setter is being represented.

getterback to summary
public static MethodDescriptor getter(String name, Class<?> returnType)

Creates a descriptor for a getter method

Parameters
name:String

name of the getter method

returnType:Class<?>

the return type of the given getter method

Returns:MethodDescriptor

a "getter" method descriptor

getterback to summary
pack-priv static MethodDescriptor getter(String prefix, Method method)

Creates a descriptor for a getter method

Parameters
prefix:String

a dot separated string denoting a path of nested object names

method:Method

a actual class method to be associated with this prefix

Returns:MethodDescriptor

a "getter" method descriptor

hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

Annotations
@Override
setterback to summary
public static MethodDescriptor setter(String name, Class<?> parameterType)

Creates a descriptor for a setter method

Parameters
name:String

name of the setter method

parameterType:Class<?>

the parameter type accepted by the given setter method

Returns:MethodDescriptor

a "setter" method descriptor

setterback to summary
pack-priv static MethodDescriptor setter(String prefix, Method method)

Creates a descriptor for a setter method

Parameters
prefix:String

a dot separated string denoting a path of nested object names

method:Method

a actual class method to be associated with this prefix

Returns:MethodDescriptor

a "setter" method descriptor

toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object