Top Description Inners Fields Constructors Methods
org.python.indexer

public Class StyleRun

extends Object
implements Comparable<StyleRun>
Class Inheritance
All Implemented Interfaces
java.lang.Comparable

Represents a simple style run for purposes of source highlighting.

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum

Field Summary

Modifier and TypeField and Description
private int
public String
private int
public StyleRun.Type
public String

Constructor Summary

AccessConstructor and Description
public
StyleRun(StyleRun.Type type, int offset, int length)

public
StyleRun(StyleRun.Type type, int offset, int length, String msg, String url)

Method Summary

Modifier and TypeMethod and Description
public int
compareTo(StyleRun
the object to be compared.
other
)

Implements java.lang.Comparable.compareTo.

Compares this object with the specified object for order.

public int
end()

private boolean
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.

public int
public int
public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
clonefinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

lengthback to summary
private int length
messageback to summary
public String message
offsetback to summary
private int offset
typeback to summary
public StyleRun.Type type
urlback to summary
public String url

Constructor Detail

StyleRunback to summary
public StyleRun(StyleRun.Type type, int offset, int length)
StyleRunback to summary
public StyleRun(StyleRun.Type type, int offset, int length, String msg, String url)

Method Detail

compareToback to summary
public int compareTo(StyleRun other)

Implements java.lang.Comparable.compareTo.

Doc from java.lang.Comparable.compareTo.

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure signum(x.compareTo(y)) == -signum(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception if and only if y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y) > 0 && y.compareTo(z) > 0) implies x.compareTo(z) > 0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that signum(x.compareTo(z)) == signum(y.compareTo(z)), for all z.

Parameters
other:StyleRun

the object to be compared.

Returns:int

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

endback to summary
public int end()
equalFieldsback to summary
private boolean equalFields(Object o1, Object o2)
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

lengthback to summary
public int length()
startback to summary
public int start()
toStringback 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

org.python.indexer back to summary

public final Enum StyleRun.Type

extends Enum<StyleRun.Type>
Class Inheritance

Field Summary

Modifier and TypeField and Description
public static final StyleRun.Type
public static final StyleRun.Type
public static final StyleRun.Type
public static final StyleRun.Type
public static final StyleRun.Type
public static final StyleRun.Type
public static final StyleRun.Type
public static final StyleRun.Type
public static final StyleRun.Type
public static final StyleRun.Type
public static final StyleRun.Type
public static final StyleRun.Type
public static final StyleRun.Type
public static final StyleRun.Type
public static final StyleRun.Type
public static final StyleRun.Type
public static final StyleRun.Type
public static final StyleRun.Type
public static final StyleRun.Type
public static final StyleRun.Type
public static final StyleRun.Type

Constructor Summary

AccessConstructor and Description
private
Type()

Method Summary

Modifier and TypeMethod and Description
public static StyleRun.Type
public static StyleRun.Type[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

ANCHORback to summary
public static final StyleRun.Type ANCHOR
ATTRIBUTEback to summary
public static final StyleRun.Type ATTRIBUTE
BUILTINback to summary
public static final StyleRun.Type BUILTIN
CLASSback to summary
public static final StyleRun.Type CLASS
COMMENTback to summary
public static final StyleRun.Type COMMENT
CONSTANTback to summary
public static final StyleRun.Type CONSTANT
DECORATORback to summary
public static final StyleRun.Type DECORATOR
DELIMITERback to summary
public static final StyleRun.Type DELIMITER
DOC_STRINGback to summary
public static final StyleRun.Type DOC_STRING
ERRORback to summary
public static final StyleRun.Type ERROR
FUNCTIONback to summary
public static final StyleRun.Type FUNCTION
IDENTIFIERback to summary
public static final StyleRun.Type IDENTIFIER
INFOback to summary
public static final StyleRun.Type INFO
KEYWORDback to summary
public static final StyleRun.Type KEYWORD
LOCALback to summary
public static final StyleRun.Type LOCAL
NUMBERback to summary
public static final StyleRun.Type NUMBER
PARAMETERback to summary
public static final StyleRun.Type PARAMETER
STRINGback to summary
public static final StyleRun.Type STRING
TYPE_NAMEback to summary
public static final StyleRun.Type TYPE_NAME
WARNINGback to summary
public static final StyleRun.Type WARNING

Constructor Detail

Typeback to summary
private Type()

Method Detail

valueOfback to summary
public static StyleRun.Type valueOf(String name)
valuesback to summary
public static StyleRun.Type[] values()