randoop.reflection

Class RawSignature

java.lang.Object

randoop.reflection.RawSignature

public class RawSignature
extends java.lang.Object

Represents the raw type signature for an java.lang.reflect.AccessibleObject. This signature consists of the classname as a fully-qualified raw type, the method name, and the argument types as fully-qualified raw types. It does not include the method or constructor name.

The raw type signature for a constructor C() is C() instead of the reflection form C.<init>(). Also, the name and the classname of a constructor are the same.

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	classname The name of the declaring class of the method.
private java.lang.String	name The method name; for a constructor, same as the classname, except for inner classes where it differs.
private @Nullable @DotSeparatedIdentifiers java.lang.String	packageName The package name of the class; null for the unnamed package.
private java.lang.Class<?>[]	parameterTypes The method parameter types.

Constructor Summary

Constructors

Constructor and Description
RawSignature(@Nullable @DotSeparatedIdentifiers java.lang.String packageName, java.lang.String classname, java.lang.String name, java.lang.Class<?>[] parameterTypes) Create a RawSignature object with the name and parameterTypes.

Method Summary

Modifier and Type	Method and Description
private void	checkRep() Check the representation invariants of this.
static java.lang.String	classNameToIdentifier(java.lang.String name) Converts a class name to an identifier name.
static java.lang.String	classToIdentifier(java.lang.Class<?> c) Converts a class to an identifier name.
boolean	equals(@Nullable java.lang.Object object)
java.lang.String	getClassname() Return the class name for method in this signature.
java.lang.String	getDeclarationArguments(java.util.List<java.lang.String> parameterNames) Construct a parameter declaration string using the parameter names.
java.lang.String	getName() Return the method name for this signature.
@DotSeparatedIdentifiers java.lang.String	getPackageName() Return package name for method in this signature.
static @Nullable @DotSeparatedIdentifiers java.lang.String	getPackageName(@Nullable java.lang.Package aPackage) Returns the name of the given package, or null if it is the default package.
java.lang.Class<?>[]	getParameterTypes() Return the array of parameter types for this signature.
int	hashCode()
static RawSignature	of(java.lang.reflect.Constructor<?> executable) Create a RawSignature object from the java.lang.reflect.Constructor.
static RawSignature	of(java.lang.reflect.Method executable) Create a RawSignature object from the java.lang.reflect.Method.
java.lang.String	toString()
java.lang.String	toStringDebug()

Methods inherited from class java.lang.Object

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

Field Detail

packageName

private final @Nullable @DotSeparatedIdentifiers java.lang.String packageName

The package name of the class; null for the unnamed package.

classname

private final java.lang.String classname

The name of the declaring class of the method.

name

private final java.lang.String name

The method name; for a constructor, same as the classname, except for inner classes where it differs.

parameterTypes

private final java.lang.Class<?>[] parameterTypes

The method parameter types.

Constructor Detail

RawSignature

public RawSignature(@Nullable @DotSeparatedIdentifiers java.lang.String packageName,
                    java.lang.String classname,
                    java.lang.String name,
                    java.lang.Class<?>[] parameterTypes)

Create a RawSignature object with the name and parameterTypes.

Parameters:

packageName - the package name of the class. The unnamed package is indicated by null.

classname - the name of the class

name - the method name; for a constructor, same as the classname

parameterTypes - the method parameter types, including the receiver type if any

Method Detail

checkRep

private void checkRep(@UnknownInitialization RawSignature this)

Check the representation invariants of this.

of

public static RawSignature of(java.lang.reflect.Method executable)

Create a RawSignature object from the java.lang.reflect.Method.

Parameters:

executable - the method from which to extract the signature

Returns:

the RawSignature object for executable

of

public static RawSignature of(java.lang.reflect.Constructor<?> executable)

Create a RawSignature object from the java.lang.reflect.Constructor.

Parameters:

executable - the constructor from which signature is extracted

Returns:

the RawSignature object for executable

equals

public boolean equals(@Nullable java.lang.Object object)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Returns the string representation of this signature in the format read by SignatureParser.parse(String, AccessibilityPredicate, ReflectionPredicate).

Overrides:

toString in class java.lang.Object

toStringDebug

public java.lang.String toStringDebug()

getPackageName

public @DotSeparatedIdentifiers java.lang.String getPackageName()

Return package name for method in this signature.

Returns:

the package name for this signature, null if default package

getClassname

public java.lang.String getClassname()

Return the class name for method in this signature.

Returns:

the class name for this signature

getName

public java.lang.String getName()

Return the method name for this signature.

Returns:

the method name for this signature

getDeclarationArguments

public java.lang.String getDeclarationArguments(java.util.List<java.lang.String> parameterNames)

Construct a parameter declaration string using the parameter names. This string contains type-parameter name pairs in the format needed for a method declaration and wrapped in parentheses.

Parameters:

parameterNames - the parameter names to use to create declaration, length should be the same as the number of parameter types in this signature

Returns:

the parameter declarations for this signature using the given parameter names

getParameterTypes

public java.lang.Class<?>[] getParameterTypes()

Return the array of parameter types for this signature.

Returns:

the array of parameter types for this signature

getPackageName

public static @Nullable @DotSeparatedIdentifiers java.lang.String getPackageName(@Nullable java.lang.Package aPackage)

Returns the name of the given package, or null if it is the default package.

Note: Java 9 uses the empty string whereas Java 8 uses null. This method uses null.

Parameters:

aPackage - a package

Returns:

the name of the given package, or null if it is the default package

classToIdentifier

public static java.lang.String classToIdentifier(java.lang.Class<?> c)

Converts a class to an identifier name.

Parameters:

c - a class

Returns:

an identifier name produced from the class

classNameToIdentifier

public static java.lang.String classNameToIdentifier(java.lang.String name)

Converts a class name to an identifier name.

Parameters:

name - a class name

Returns:

an identifier name produced from the class name