de.smartics.maven.util.report.link
Class JavaElementRef

java.lang.Object
  de.smartics.maven.util.report.link.JavaElementRef

All Implemented Interfaces:

Serializable

public class JavaElementRef
     
     

      
      extends 
      
      Object
     
     
     
     

      
      implements 
      
      Serializable
     
     

A reference to a Java element. This is string based since the class is not necessarily on the class path of the report.

See Also:

Serialized Form

To Do:

Support nested classes., Support parameter lists., check for serial tampering

Constructor Summary

JavaElementRef(String packageName, String typeName, de.smartics.util.source.MethodInfo elementName)
Default constructor.

Method Summary

de.smartics.util.source.MethodInfo	getElementName() Returns the name of the element.
String	getPackageName() Returns the name of the package.
String	getTypeName() Returns the name of the Java class.
String	toString() Returns the string representation of the object.

Methods inherited from class java.lang.Object

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

Constructor Detail

JavaElementRef

public JavaElementRef(String packageName,
                      String typeName,
                      de.smartics.util.source.MethodInfo elementName)
               throws IllegalArgumentException

Default constructor.

Parameters:

packageName - the name of the package.

typeName - the name of the Java class.

elementName - the name of the element.

Throws:

IllegalArgumentException - if typeName is blank or packageName is empty or consists only of whitespaces.

To Do:

All elements are currently provided to be fully URL encoded.

Method Detail

getPackageName

public String getPackageName()

Returns the name of the package.

Returns:

the name of the package.

getTypeName

public String getTypeName()

Returns the name of the Java class.

Returns:

the name of the Java class.

getElementName

@CheckForNull
public de.smartics.util.source.MethodInfo getElementName()

Returns the name of the element.

Returns:

the name of the element. May be null.

toString

public String toString()

Returns the string representation of the object.

Overrides:

toString in class Object

Returns:

the string representation of the object.