com.sourcegraph.semanticdb_javac

Enum CompilerRange

java.lang.Object

java.lang.Enum<CompilerRange>

com.sourcegraph.semanticdb_javac.CompilerRange

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CompilerRange>

public enum CompilerRange
extends java.lang.Enum<CompilerRange>

Describes how to convert a compiler position into SemanticDB Range.

A Java compiler position has tree parts: "start", "point" and "end".

     public static void main(String[] args) { }
     ^ start
                        ^ point (aka. "preferred position")
                                              ^ end
 

A SemanticDB range has four parts: "startLine", "startCharacter", "endLine", "endCharacter".

Enum Constant Summary

Enum Constants

Enum Constant and Description
FROM_END_WITH_TEXT_SEARCH Use text search to find the start of the symbol name, searching from the end instead of the start.
FROM_POINT_TO_SYMBOL_NAME Map the compiler point position to SemanticDB start and use (point + symbol name length) for the SemanticDB end position.
FROM_POINT_TO_SYMBOL_NAME_PLUS_ONE Map the compiler (point + 1) position to SemanticDB start and use (point + symbol name length + 1) for the SemanticDB end position.
FROM_POINT_WITH_TEXT_SEARCH Use text search to find the start of the symbol name, using the point position as the starting search offset and using (found start + symbol name length) for the SemanticDB end position.
FROM_START_TO_END Map the compiler start/end positions to SemanticDB start/end positions.
FROM_TEXT_SEARCH Use text search to find the start of the symbol name and use (found start + symbol name length) for the SemanticDB end position.

Method Summary

Modifier and Type	Method and Description
boolean	isFromEnd()
boolean	isFromPoint()
boolean	isFromTextSearch()
static CompilerRange	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CompilerRange[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

FROM_START_TO_END

public static final CompilerRange FROM_START_TO_END

Map the compiler start/end positions to SemanticDB start/end positions.

FROM_POINT_TO_SYMBOL_NAME

public static final CompilerRange FROM_POINT_TO_SYMBOL_NAME

Map the compiler point position to SemanticDB start and use (point + symbol name length) for the SemanticDB end position.

FROM_POINT_TO_SYMBOL_NAME_PLUS_ONE

public static final CompilerRange FROM_POINT_TO_SYMBOL_NAME_PLUS_ONE

Map the compiler (point + 1) position to SemanticDB start and use (point + symbol name length + 1) for the SemanticDB end position.

FROM_TEXT_SEARCH

public static final CompilerRange FROM_TEXT_SEARCH

Use text search to find the start of the symbol name and use (found start + symbol name length) for the SemanticDB end position.

FROM_POINT_WITH_TEXT_SEARCH

public static final CompilerRange FROM_POINT_WITH_TEXT_SEARCH

Use text search to find the start of the symbol name, using the point position as the starting search offset and using (found start + symbol name length) for the SemanticDB end position.

FROM_END_WITH_TEXT_SEARCH

public static final CompilerRange FROM_END_WITH_TEXT_SEARCH

Use text search to find the start of the symbol name, searching from the end instead of the start.

Method Detail

values

public static CompilerRange[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CompilerRange c : CompilerRange.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CompilerRange valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

isFromPoint

public boolean isFromPoint()

isFromTextSearch

public boolean isFromTextSearch()

isFromEnd

public boolean isFromEnd()