Jython 2.7.4 · org.python.indexer.Ref · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private static final int	ATTRIBUTE
private static final int	CALL
private String	file
private int	flags
private String	name
private static final int	NEW
private int	start
private static final int	STRING

Access	Constructor and Description
public	Ref(NNode node)
public	Ref(String absolute path to the file containing the reference path, int the 0-indexed file offset of the reference offset, String the text of the reference text) Constructor that provides a way for clients to add additional references not associated with an AST node (e.g. inside a comment or doc string).

Method Summary

Modifier and Type	Method and Description
public int	end() Returns the ending file offset of the reference.
public boolean	equals(Object the reference object with which to compare. obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public String	getFile() Returns the file containing the reference.
public String	getName() Returns the text of the reference.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public boolean	isAttribute() Returns `true` if this reference was an attribute of some other node.
public boolean	isCall() Returns `true` if this reference is a function or method call.
public boolean	isName() Returns `true` if this reference was unquoted name.
public boolean	isNew()
public boolean	isRef()
public boolean	isString() Returns `true` if this reference was a quoted name.
public int	length() Returns the length of the reference text.
public void	markAsAttribute()
public void	markAsCall() Returns `true` if this reference is a class instantiation.
public void	markAsNew()
public void	markAsString()
public int	start() Returns the starting file offset of the reference.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

ATTRIBUTE	back to summary
private static final int ATTRIBUTE

CALL	back to summary
private static final int CALL

file	back to summary
private String file

flags	back to summary
private int flags

name	back to summary
private String name

NEW	back to summary
private static final int NEW

start	back to summary
private int start

STRING	back to summary
private static final int STRING

Ref	back to summary
public Ref(NNode node)

Ref	back to summary
public Ref(String path, int offset, String text) Constructor that provides a way for clients to add additional references not associated with an AST node (e.g. inside a comment or doc string). Parameters path:String absolute path to the file containing the reference offset:int the 0-indexed file offset of the reference text:String the text of the reference

Method Detail

end	back to summary
public int end() Returns the ending file offset of the reference.

equals back to summary

equals	back to summary
public boolean equals(Object obj) 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 obj: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

public boolean equals(Object obj)

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

obj: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

getFile	back to summary
public String getFile() Returns the file containing the reference.

getName	back to summary
public String getName() Returns the text of the reference.

hashCode back to summary

hashCode	back 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

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

isAttribute	back to summary
public boolean isAttribute() Returns `true` if this reference was an attribute of some other node.

isCall	back to summary
public boolean isCall() Returns `true` if this reference is a function or method call.

isName	back to summary
public boolean isName() Returns `true` if this reference was unquoted name.

isNew	back to summary
public boolean isNew()

isRef	back to summary
public boolean isRef()

isString	back to summary
public boolean isString() Returns `true` if this reference was a quoted name. If so, the `start` and `length` include the positions of the opening and closing quotes, but `isName` returns the text within the quotes.

length	back to summary
public int length() Returns the length of the reference text.

markAsAttribute	back to summary
public void markAsAttribute()

markAsCall	back to summary
public void markAsCall() Returns `true` if this reference is a class instantiation.

markAsNew	back to summary
public void markAsNew()

markAsString	back to summary
public void markAsString()

start	back to summary
public int start() Returns the starting file offset of the reference.

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

public Class Ref

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail