com.sourcegraph.semanticdb_javac

Enum NoRelativePathMode

java.lang.Object

java.lang.Enum<NoRelativePathMode>

com.sourcegraph.semanticdb_javac.NoRelativePathMode

All Implemented Interfaces:

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

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

Configuration options to determine how semanticdb-javac should handle files that have no good relative paths.

When indexing a file at an absolute path /project/src/main/example/Foo.java, SemanticDB needs to know the "sourceroot" path /project in order to relativize the path of the source file into src/main/example/Foo.java. This configuration option determines what the compiler plugin should do when it's not able to find a good relative path.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ERROR Report an error message and fail the compilation.
INDEX_ANYWAY Come up with a unique relative path for the SemanticDB path with no guarantee that this path corresponds to the original path of the generated source file.
SKIP Silently ignore the file, don't index it.
WARNING Ignore the file, but print a message explaining it's ignored.

Method Summary

Modifier and Type	Method and Description
static java.lang.String	validStringValues()
static java.lang.String	validStringValuesWithoutError()
static NoRelativePathMode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static NoRelativePathMode[]	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

INDEX_ANYWAY

public static final NoRelativePathMode INDEX_ANYWAY

Come up with a unique relative path for the SemanticDB path with no guarantee that this path corresponds to the original path of the generated source file.

SKIP

public static final NoRelativePathMode SKIP

Silently ignore the file, don't index it.

ERROR

public static final NoRelativePathMode ERROR

Report an error message and fail the compilation.

WARNING

public static final NoRelativePathMode WARNING

Ignore the file, but print a message explaining it's ignored.

Method Detail

values

public static NoRelativePathMode[] 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 (NoRelativePathMode c : NoRelativePathMode.values())
    System.out.println(c);

Returns:

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

valueOf

public static NoRelativePathMode 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

validStringValuesWithoutError

public static java.lang.String validStringValuesWithoutError()

validStringValues

public static java.lang.String validStringValues()