py4j.model

Class Py4JMember

java.lang.Object

py4j.model.Py4JMember

All Implemented Interfaces:

Comparable<Py4JMember>

Direct Known Subclasses:

Py4JClass, Py4JField, Py4JMethod

public abstract class Py4JMember
extends Object
implements Comparable<Py4JMember>

Model of a Java member (class, method, or field) used to create a help page.

Author:

Barthelemy Dagenais

Constructor Summary

Constructors

Constructor and Description
Py4JMember(String name, String javadoc)

Method Summary

Modifier and Type	Method and Description
int	compareTo(Py4JMember o)
boolean	equals(Object obj)
String	getJavadoc()
String	getName()
abstract String	getSignature(boolean shortName)
int	hashCode()

Methods inherited from class java.lang.Object

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

Constructor Detail

Py4JMember

public Py4JMember(String name,
                  String javadoc)

Method Detail

compareTo

public int compareTo(Py4JMember o)

Specified by:

compareTo in interface Comparable<Py4JMember>

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getJavadoc

public String getJavadoc()

getName

public String getName()

getSignature

public abstract String getSignature(boolean shortName)