org.eclipse.xtext.resource

Enum ILocationInFileProviderExtension.RegionDescription

java.lang.Object

java.lang.Enum<ILocationInFileProviderExtension.RegionDescription>

org.eclipse.xtext.resource.ILocationInFileProviderExtension.RegionDescription

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ILocationInFileProviderExtension.RegionDescription>

Enclosing interface:

ILocationInFileProviderExtension

public static enum ILocationInFileProviderExtension.RegionDescription
extends java.lang.Enum<ILocationInFileProviderExtension.RegionDescription>

Describes the kind of region that is queried.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FULL The full region spans the outermost visible nodes of an instance.
INCLUDING_COMMENTS Allows to obtain the range including the associated comments.
INCLUDING_WHITESPACE Returns the complete range including leading and trailing whitespace.
SIGNIFICANT The significant region of an EObject is basically the part of the text that identifies the instance in a human readable manner.

Method Summary

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

SIGNIFICANT

public static final ILocationInFileProviderExtension.RegionDescription SIGNIFICANT

The significant region of an EObject is basically the part of the text that identifies the instance in a human readable manner.

FULL

public static final ILocationInFileProviderExtension.RegionDescription FULL

The full region spans the outermost visible nodes of an instance. Comments and whitespaces are trimmed.

INCLUDING_COMMENTS

public static final ILocationInFileProviderExtension.RegionDescription INCLUDING_COMMENTS

Allows to obtain the range including the associated comments.

INCLUDING_WHITESPACE

public static final ILocationInFileProviderExtension.RegionDescription INCLUDING_WHITESPACE

Returns the complete range including leading and trailing whitespace.

Method Detail

values

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

Returns:

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

valueOf

public static ILocationInFileProviderExtension.RegionDescription 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