org.das2.jythoncompletion

Class CompletionContext

java.lang.Object

org.das2.jythoncompletion.CompletionContext

public class CompletionContext
extends java.lang.Object

CompletionContext describes a place in code where completion was triggered, containing the type of completion and the context around it.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATTRIBUTE_NAME
static java.lang.String	CLASS_METHOD_NAME
static java.lang.String	COMMAND_ARGUMENT we are within the body of a command such as "plot" and we want to see what the arguments and named parameters are.
java.lang.String	completable the item on which completion was triggered.
java.lang.String	contextString the context string, such as a command name.
java.lang.String	contextType the context type, such as COMMAND_ARGUMENT or STRING_LITERAL_ARGUMENT.
static java.lang.String	DEFAULT_NAME
static java.lang.String	METHOD_NAME
static java.lang.String	MODULE_NAME
static java.lang.String	PACKAGE_NAME
static java.lang.String	STRING_LITERAL_ARGUMENT a string literal argument for a command like getDataSet.

Constructor Summary

Constructors

Constructor and Description
CompletionContext(java.lang.String contextType, java.lang.String contextString, java.lang.String completable)

Method Summary

Modifier and Type	Method and Description
java.lang.Class	getContextObjectClass() return null or the class for the context.
void	setContextObjectClass(java.lang.Class claz)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

METHOD_NAME

public static final java.lang.String METHOD_NAME

See Also:

Constant Field Values

CLASS_METHOD_NAME

public static final java.lang.String CLASS_METHOD_NAME

See Also:

Constant Field Values

ATTRIBUTE_NAME

public static final java.lang.String ATTRIBUTE_NAME

See Also:

Constant Field Values

PACKAGE_NAME

public static final java.lang.String PACKAGE_NAME

See Also:

Constant Field Values

MODULE_NAME

public static final java.lang.String MODULE_NAME

See Also:

Constant Field Values

DEFAULT_NAME

public static final java.lang.String DEFAULT_NAME

See Also:

Constant Field Values

STRING_LITERAL_ARGUMENT

public static final java.lang.String STRING_LITERAL_ARGUMENT

a string literal argument for a command like getDataSet. We can delegate completion to an engine for this command.

See Also:

Constant Field Values

COMMAND_ARGUMENT

public static final java.lang.String COMMAND_ARGUMENT

we are within the body of a command such as "plot" and we want to see what the arguments and named parameters are.

See Also:

Constant Field Values

contextType

public java.lang.String contextType

the context type, such as COMMAND_ARGUMENT or STRING_LITERAL_ARGUMENT. In ds= getDataSet('/hom<C>'), this is STRING_LITERAL_ARGUMENT

contextString

public java.lang.String contextString

the context string, such as a command name. In ds= getDataSet('/hom<C>'), this is 'getDataSet'

completable

public java.lang.String completable

the item on which completion was triggered. In ds= getDataSet('/hom<C>'), this is '/hom'

Constructor Detail

CompletionContext

public CompletionContext(java.lang.String contextType,
                         java.lang.String contextString,
                         java.lang.String completable)

Parameters:

contextType -

contextString -

completable -

Method Detail

setContextObjectClass

public void setContextObjectClass(java.lang.Class claz)

getContextObjectClass

public java.lang.Class getContextObjectClass()

return null or the class for the context.

Returns:

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object