com.screenscraper.view.languagesupport

Class CompletionWrapper

java.lang.Object

com.screenscraper.view.languagesupport.CompletionWrapper

class CompletionWrapper
extends java.lang.Object

Simple wrapper class used to get data from the parser in order to build the correct completions Author: Mike Date: 8/16/12 Time: 2:44 PM

Constructor Summary

Constructors

Constructor and Description
CompletionWrapper(CompletionTokenType tokenType, java.lang.Class completionClass, java.lang.String enteredText) Builds a wrapper with the given values for use later int the completions
CompletionWrapper(CompletionTokenType tokenType, java.lang.Class completionClass, java.lang.String enteredText, java.util.Map<java.lang.String,java.lang.Class> variablesInScope) Builds a wrapper with the given values for use later int the completions
CompletionWrapper(int caretPosition, CompletionTokenType tokenType, java.lang.Class completionClass, java.lang.String enteredText, java.util.Map<java.lang.String,java.lang.Class> variablesInScope, java.util.Collection<? extends org.fife.ui.autocomplete.VariableCompletion> additionalCompletions) Builds a wrapper with the given values for use later int the completions

Method Summary

Modifier and Type	Method and Description
java.util.Collection<? extends org.fife.ui.autocomplete.Completion>	getAdditionalCompletions() Gets a collection of additional completions to include for the given position.
int	getCaretPosition() Gets the caret position this relates to
java.lang.Class	getCompletionClass() Gets the class of the object (or class) at the given caret position, or null if no class type is relevant
java.lang.String	getEnteredText() Gets the text that is at the current caret position.
CompletionTokenType	getTokenType() Gets the type of the token found at the given caret position
java.util.Map<java.lang.String,java.lang.Class>	getVariablesInScope() Returns a map of the variables that are in scope at the given caret position
boolean	isLogObject() Returns true if this is a completion for the log object, false otherwise
boolean	isSessionObject() Returns true if this is a completion for the session object, false otherwise
<U extends org.fife.ui.autocomplete.Completion> void	setAdditionalCompletions(java.util.Collection<U> additionalCompletions) Sets a collection of additional completions to include for the given position.
void	setCaretPosition(int caretPosition) Sets the caret position this relates to
void	setCompletionClass(java.lang.Class completionClass) Sets the class of the object (or class) at the given caret position, or null if no class type is relevant
void	setEnteredText(java.lang.String enteredText) Sets the text that is at the current caret position.
void	setLogObject(boolean logObject) Sets whether or not this is a completion for the log object
void	setSessionObject(boolean sessionObject) Sets whether or not this is a completion for the session object
void	setTokenType(CompletionTokenType tokenType) Sets the type of the token found at the given caret position
void	setVariablesInScope(java.util.Map<java.lang.String,java.lang.Class> variablesInScope) Sets a map of the variables that are in scope at the given caret position.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

CompletionWrapper

public CompletionWrapper(CompletionTokenType tokenType,
                         @Nullable
                         java.lang.Class completionClass,
                         @Nullable
                         java.lang.String enteredText)

Builds a wrapper with the given values for use later int the completions

Parameters:

tokenType - The type of token that was found at the given position

completionClass - The class of the object or Class name that was found at the given position

enteredText - The currently entered text. This would be the variable/method name as far as it has been typed

CompletionWrapper

public CompletionWrapper(CompletionTokenType tokenType,
                         java.lang.Class completionClass,
                         java.lang.String enteredText,
                         java.util.Map<java.lang.String,java.lang.Class> variablesInScope)

Builds a wrapper with the given values for use later int the completions

Parameters:

tokenType - The type of token that was found at the given position

completionClass - The class of the object or Class name that was found at the given position

enteredText - The currently entered text. This would be the variable/method name as far as it has been typed

variablesInScope - A map from variable name to it's type of all the variables currently in scope

CompletionWrapper

public CompletionWrapper(int caretPosition,
                         CompletionTokenType tokenType,
                         java.lang.Class completionClass,
                         java.lang.String enteredText,
                         java.util.Map<java.lang.String,java.lang.Class> variablesInScope,
                         java.util.Collection<? extends org.fife.ui.autocomplete.VariableCompletion> additionalCompletions)

Builds a wrapper with the given values for use later int the completions

Parameters:

caretPosition - The caret position that was being examined

tokenType - The type of token that was found at the given position

completionClass - The class of the object or Class name that was found at the given position

enteredText - The currently entered text. This would be the variable/method name as far as it has been typed

variablesInScope - A map from variable name to it's type of all the variables currently in scope

additionalCompletions - Additional completions that should be added (user-defined methods, etc...)

Method Detail

getCaretPosition

public int getCaretPosition()

Gets the caret position this relates to

Returns:

The caret position this relates to

setCaretPosition

public void setCaretPosition(int caretPosition)

Sets the caret position this relates to

Parameters:

caretPosition - The caret position this relates to

getTokenType

public CompletionTokenType getTokenType()

Gets the type of the token found at the given caret position

Returns:

The type of the token found at the given caret position

setTokenType

public void setTokenType(CompletionTokenType tokenType)

Sets the type of the token found at the given caret position

Parameters:

tokenType - The type of the token found at the given caret position

getCompletionClass

public java.lang.Class getCompletionClass()

Gets the class of the object (or class) at the given caret position, or null if no class type is relevant

Returns:

The class of the object (or class) at the given caret position, or null if no class type is relevant

setCompletionClass

public void setCompletionClass(java.lang.Class completionClass)

Sets the class of the object (or class) at the given caret position, or null if no class type is relevant

Parameters:

completionClass - The class of the object (or class) at the given caret position, or null if no class type is relevant

getEnteredText

public java.lang.String getEnteredText()

Gets the text that is at the current caret position. This should be the name of the variable or method, as it has been completed so far

Returns:

The text that is at the current caret position. This should be the name of the variable or method, as it has been completed so far

setEnteredText

public void setEnteredText(java.lang.String enteredText)

Sets the text that is at the current caret position. This should be the name of the variable or method, as it has been completed so far

Parameters:

enteredText - The text that is at the current caret position. This should be the name of the variable or method, as it has been completed so far

getVariablesInScope

public java.util.Map<java.lang.String,java.lang.Class> getVariablesInScope()

Returns a map of the variables that are in scope at the given caret position

Returns:

A map of the variables that are in scope at the given caret position

setVariablesInScope

public void setVariablesInScope(java.util.Map<java.lang.String,java.lang.Class> variablesInScope)

Sets a map of the variables that are in scope at the given caret position. The map is copied

Parameters:

variablesInScope - A map of the variables that are in scope at the given caret position. The map will be copied, so it can be safely modified later

getAdditionalCompletions

public java.util.Collection<? extends org.fife.ui.autocomplete.Completion> getAdditionalCompletions()

Gets a collection of additional completions to include for the given position. These could include things such as the user-defined methods and classes.

Returns:

A collection of additional completions to include for the given position. These could include things such as the user-defined methods and classes.

setAdditionalCompletions

public <U extends org.fife.ui.autocomplete.Completion> void setAdditionalCompletions(java.util.Collection<U> additionalCompletions)

Sets a collection of additional completions to include for the given position. These could include things such as the user-defined methods and classes. The collection will be copied.

Parameters:

additionalCompletions - A collection of additional completions to include for the given position. These could include things such as the user-defined methods and classes. The collection will be copied.

isLogObject

public boolean isLogObject()

Returns true if this is a completion for the log object, false otherwise

Returns:

True if this is a completion for the log object, false otherwise

setLogObject

public void setLogObject(boolean logObject)

Sets whether or not this is a completion for the log object

Parameters:

logObject - True if this is a completion for the log object, false otherwise

isSessionObject

public boolean isSessionObject()

Returns true if this is a completion for the session object, false otherwise

Returns:

True if this is a completion for the session object, false otherwise

setSessionObject

public void setSessionObject(boolean sessionObject)

Sets whether or not this is a completion for the session object

Parameters:

sessionObject - True if this is a completion for the session object, false otherwise

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object