org.eclipse.xtext.junit4.ui

Class ContentAssistProcessorTestBuilder

java.lang.Object

org.eclipse.xtext.junit4.ui.ContentAssistProcessorTestBuilder

All Implemented Interfaces:

Cloneable

public class ContentAssistProcessorTestBuilder
extends Object
implements Cloneable

Represents a builder for IContentAssistProcessor tests.

Author:

Michael Clay - Initial contribution and API, Sven Efftinge, Sebastian Zarnekow

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ContentAssistProcessorTestBuilder.Factory
class	ContentAssistProcessorTestBuilder.ProposalTester

Constructor Summary

Constructors

Constructor and Description
ContentAssistProcessorTestBuilder(com.google.inject.Injector injector, ResourceLoadHelper helper)
ContentAssistProcessorTestBuilder(ISetup setupClazz, AbstractXtextTests tests)

Method Summary

Methods

Modifier and Type	Method and Description
ContentAssistProcessorTestBuilder	append(String model)
protected ContentAssistProcessorTestBuilder	appendAndApplyProposal(org.eclipse.jface.text.contentassist.ICompletionProposal proposal, org.eclipse.jface.text.source.ISourceViewer sourceViewer, String model, int position)
ContentAssistProcessorTestBuilder	appendAndApplyProposal(String model)
ContentAssistProcessorTestBuilder	appendAndApplyProposal(String model, int position)
ContentAssistProcessorTestBuilder	appendAndApplyProposal(String model, int position, String proposalString)
ContentAssistProcessorTestBuilder	appendAndApplyProposal(String model, String proposal)
ContentAssistProcessorTestBuilder	appendNl(String model)
ContentAssistProcessorTestBuilder	appendSuffix(String suffix)
ContentAssistProcessorTestBuilder	applyProposal()
protected ContentAssistProcessorTestBuilder	applyProposal(org.eclipse.jface.text.contentassist.ICompletionProposal proposal)
protected ContentAssistProcessorTestBuilder	applyProposal(org.eclipse.jface.text.contentassist.ICompletionProposal proposal, IXtextDocument document)
ContentAssistProcessorTestBuilder	applyProposal(int position)
ContentAssistProcessorTestBuilder	applyProposal(int position, String proposalString)
ContentAssistProcessorTestBuilder	applyProposal(String proposal)
ContentAssistProcessorTestBuilder	assertCount(int completionProposalCount)
ContentAssistProcessorTestBuilder	assertCountAtCursorPosition(int completionProposalCount, int cursorPosition)
ContentAssistProcessorTestBuilder	assertCursorIsAfter(String text)
ContentAssistProcessorTestBuilder	assertCursorIsBefore(String text)
ContentAssistProcessorTestBuilder	assertMatchString(String matchString)
void	assertNoProposalAtCursor(String unexpectedText) Asserts the absence of a proposal with the given replacement string at the cursor position <|> in the currently configured model.
ContentAssistProcessorTestBuilder.ProposalTester	assertProposal(String expectedText) Asserts the presence of at least single the proposal with the given replacement string at the cursor position cursorPosition in the currently configured model.
ContentAssistProcessorTestBuilder.ProposalTester	assertProposalAtCursor(String expectedText) Asserts the presence of at least single the proposal with the given replacement string at the cursor position <|> in the currently configured model.
ContentAssistProcessorTestBuilder.ProposalTester	assertProposalDisplayedAtCursor(String displayString) Asserts the presence of at least single the proposal with the given display string at the cursor position <|> in the currently configured model.
ContentAssistProcessorTestBuilder	assertText(String... expectedText)
ContentAssistProcessorTestBuilder	assertTextAtCursorPosition(int cursorPosition, String... expectations)
ContentAssistProcessorTestBuilder	assertTextAtCursorPosition(String cursorPosition, int offset, String... expectedText)
ContentAssistProcessorTestBuilder	assertTextAtCursorPosition(String cursorPosition, String... expectedText)
protected ContentAssistProcessorTestBuilder	clone(String model, int offset)
protected ContentAssistProcessorTestBuilder	cloneWithSuffix(String postFix)
org.eclipse.jface.text.contentassist.ICompletionProposal[]	computeCompletionProposals()
org.eclipse.jface.text.contentassist.ICompletionProposal[]	computeCompletionProposals(int cursorPosition)
protected org.eclipse.jface.text.contentassist.ICompletionProposal[]	computeCompletionProposals(IXtextDocument xtextDocument, int cursorPosition)
protected org.eclipse.jface.text.contentassist.ICompletionProposal[]	computeCompletionProposals(IXtextDocument xtextDocument, int cursorPosition, org.eclipse.swt.widgets.Shell shell)
protected org.eclipse.jface.text.contentassist.ICompletionProposal[]	computeCompletionProposals(IXtextDocument xtextDocument, int cursorPosition, XtextSourceViewerConfiguration configuration, org.eclipse.jface.text.source.ISourceViewer sourceViewer)
org.eclipse.jface.text.contentassist.ICompletionProposal[]	computeCompletionProposals(String cursorPosition)
org.eclipse.jface.text.contentassist.ICompletionProposal[]	computeCompletionProposals(String currentModelToParse, int cursorPosition)
ContentAssistProcessorTestBuilder	cursorBack(int times)
ContentAssistProcessorTestBuilder	expectContent(String expectation)
protected org.eclipse.jface.text.contentassist.ICompletionProposal	findProposal(String proposalString, org.eclipse.jface.text.contentassist.ICompletionProposal[] proposals)
<T> T	get(Class<T> clazz)
protected int	getCursorPosition()
protected IXtextDocument	getDocument(String currentModelToParse)
IXtextDocument	getDocument(XtextResource xtextResource, String model)
protected String	getFullTextToBeParsed()
protected String	getModel()
org.eclipse.jface.text.contentassist.ICompletionProposal[]	getProposalsAtCursorIndicator() Computes all proposals at the cursor position <|> in the currently configured model.
protected String	getProposedText(org.eclipse.jface.text.contentassist.ICompletionProposal completionProposal)
protected org.eclipse.jface.text.source.ISourceViewer	getSourceViewer(org.eclipse.swt.widgets.Shell shell, IXtextDocument xtextDocument, XtextSourceViewerConfiguration configuration)
org.eclipse.jface.text.ITextViewer	getSourceViewer(String currentModelToParse, IXtextDocument xtextDocument)
ContentAssistProcessorTestBuilder	insert(String model) Inserts the given text at the current cursor position.
ContentAssistProcessorTestBuilder	insert(String model, int cursorPosition)
ContentAssistProcessorTestBuilder	reset()
List<String>	toDisplayString(org.eclipse.jface.text.contentassist.ICompletionProposal[] proposals)
String	toString()
protected String	toString(org.eclipse.jface.text.contentassist.ICompletionProposal proposal)
List<String>	toString(org.eclipse.jface.text.contentassist.ICompletionProposal[] proposals)
ContentAssistProcessorTestBuilder	withDirtyState()

Methods inherited from class java.lang.Object

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

Constructor Detail

ContentAssistProcessorTestBuilder

public ContentAssistProcessorTestBuilder(ISetup setupClazz,
                                 AbstractXtextTests tests)
                                  throws Exception

Throws:

Exception

ContentAssistProcessorTestBuilder

public ContentAssistProcessorTestBuilder(com.google.inject.Injector injector,
                                 ResourceLoadHelper helper)
                                  throws Exception

Throws:

Exception

Method Detail

reset

public ContentAssistProcessorTestBuilder reset()
                                        throws Exception

Throws:

Exception

append

public ContentAssistProcessorTestBuilder append(String model)
                                         throws Exception

Throws:

Exception

appendSuffix

public ContentAssistProcessorTestBuilder appendSuffix(String suffix)
                                               throws Exception

Throws:

Exception

appendNl

public ContentAssistProcessorTestBuilder appendNl(String model)
                                           throws Exception

Throws:

Exception

insert

public ContentAssistProcessorTestBuilder insert(String model)
                                         throws Exception

Inserts the given text at the current cursor position. The cursor position will be moved to the end of the inserted text.

Throws:

Exception

insert

public ContentAssistProcessorTestBuilder insert(String model,
                                       int cursorPosition)
                                         throws Exception

Throws:

Exception

cursorBack

public ContentAssistProcessorTestBuilder cursorBack(int times)
                                             throws Exception

Throws:

Exception

appendAndApplyProposal

public ContentAssistProcessorTestBuilder appendAndApplyProposal(String model)
                                                         throws Exception

Throws:

Exception

appendAndApplyProposal

public ContentAssistProcessorTestBuilder appendAndApplyProposal(String model,
                                                       String proposal)
                                                         throws Exception

Throws:

Exception

appendAndApplyProposal

public ContentAssistProcessorTestBuilder appendAndApplyProposal(String model,
                                                       int position)
                                                         throws Exception

Throws:

Exception

appendAndApplyProposal

public ContentAssistProcessorTestBuilder appendAndApplyProposal(String model,
                                                       int position,
                                                       String proposalString)
                                                         throws Exception

Throws:

Exception

appendAndApplyProposal

protected ContentAssistProcessorTestBuilder appendAndApplyProposal(org.eclipse.jface.text.contentassist.ICompletionProposal proposal,
                                                       org.eclipse.jface.text.source.ISourceViewer sourceViewer,
                                                       String model,
                                                       int position)
                                                            throws Exception

Throws:

Exception

applyProposal

public ContentAssistProcessorTestBuilder applyProposal()
                                                throws Exception

Throws:

Exception

applyProposal

public ContentAssistProcessorTestBuilder applyProposal(String proposal)
                                                throws Exception

Throws:

Exception

applyProposal

public ContentAssistProcessorTestBuilder applyProposal(int position)
                                                throws Exception

Throws:

Exception

applyProposal

public ContentAssistProcessorTestBuilder applyProposal(int position,
                                              String proposalString)
                                                throws Exception

Throws:

Exception

findProposal

protected org.eclipse.jface.text.contentassist.ICompletionProposal findProposal(String proposalString,
                                                                    org.eclipse.jface.text.contentassist.ICompletionProposal[] proposals)

applyProposal

protected ContentAssistProcessorTestBuilder applyProposal(org.eclipse.jface.text.contentassist.ICompletionProposal proposal)
                                                   throws Exception

Throws:

Exception

applyProposal

protected ContentAssistProcessorTestBuilder applyProposal(org.eclipse.jface.text.contentassist.ICompletionProposal proposal,
                                              IXtextDocument document)
                                                   throws Exception

Throws:

Exception

expectContent

public ContentAssistProcessorTestBuilder expectContent(String expectation)

assertCount

public ContentAssistProcessorTestBuilder assertCount(int completionProposalCount)
                                              throws Exception

Throws:

Exception

assertText

public ContentAssistProcessorTestBuilder assertText(String... expectedText)
                                             throws Exception

Throws:

Exception

assertProposalAtCursor

public ContentAssistProcessorTestBuilder.ProposalTester assertProposalAtCursor(String expectedText)
                                                                        throws Exception

Asserts the presence of at least single the proposal with the given replacement string at the cursor position <|> in the currently configured model.

Throws:

Exception

assertNoProposalAtCursor

public void assertNoProposalAtCursor(String unexpectedText)
                              throws Exception

Asserts the absence of a proposal with the given replacement string at the cursor position <|> in the currently configured model.

Throws:

Exception

Since:

2.8

getProposalsAtCursorIndicator

public org.eclipse.jface.text.contentassist.ICompletionProposal[] getProposalsAtCursorIndicator()
                                                                                         throws Exception

Computes all proposals at the cursor position <|> in the currently configured model.

Throws:

Exception

assertProposalDisplayedAtCursor

public ContentAssistProcessorTestBuilder.ProposalTester assertProposalDisplayedAtCursor(String displayString)
                                                                                 throws Exception

Asserts the presence of at least single the proposal with the given display string at the cursor position <|> in the currently configured model.

Throws:

Exception

See Also:

assertProposalAtCursor(String)

assertProposal

public ContentAssistProcessorTestBuilder.ProposalTester assertProposal(String expectedText)
                                                                throws Exception

Asserts the presence of at least single the proposal with the given replacement string at the cursor position cursorPosition in the currently configured model.

Throws:

Exception

assertTextAtCursorPosition

public ContentAssistProcessorTestBuilder assertTextAtCursorPosition(String cursorPosition,
                                                           String... expectedText)
                                                             throws Exception

Throws:

Exception

assertTextAtCursorPosition

public ContentAssistProcessorTestBuilder assertTextAtCursorPosition(String cursorPosition,
                                                           int offset,
                                                           String... expectedText)
                                                             throws Exception

Throws:

Exception

assertTextAtCursorPosition

public ContentAssistProcessorTestBuilder assertTextAtCursorPosition(int cursorPosition,
                                                           String... expectations)
                                                             throws Exception

Throws:

Exception

getProposedText

protected String getProposedText(org.eclipse.jface.text.contentassist.ICompletionProposal completionProposal)

assertMatchString

public ContentAssistProcessorTestBuilder assertMatchString(String matchString)
                                                    throws Exception

Throws:

Exception

assertCursorIsAfter

public ContentAssistProcessorTestBuilder assertCursorIsAfter(String text)

assertCursorIsBefore

public ContentAssistProcessorTestBuilder assertCursorIsBefore(String text)

getModel

protected String getModel()

getFullTextToBeParsed

protected String getFullTextToBeParsed()

toDisplayString

public List<String> toDisplayString(org.eclipse.jface.text.contentassist.ICompletionProposal[] proposals)

toString

public List<String> toString(org.eclipse.jface.text.contentassist.ICompletionProposal[] proposals)

toString

protected String toString(org.eclipse.jface.text.contentassist.ICompletionProposal proposal)

assertCountAtCursorPosition

public ContentAssistProcessorTestBuilder assertCountAtCursorPosition(int completionProposalCount,
                                                            int cursorPosition)
                                                              throws Exception

Throws:

Exception

computeCompletionProposals

public org.eclipse.jface.text.contentassist.ICompletionProposal[] computeCompletionProposals(String currentModelToParse,
                                                                                    int cursorPosition)
                                                                                      throws Exception

Throws:

Exception

computeCompletionProposals

protected org.eclipse.jface.text.contentassist.ICompletionProposal[] computeCompletionProposals(IXtextDocument xtextDocument,
                                                                                    int cursorPosition)
                                                                                         throws org.eclipse.jface.text.BadLocationException

Throws:

org.eclipse.jface.text.BadLocationException

computeCompletionProposals

protected org.eclipse.jface.text.contentassist.ICompletionProposal[] computeCompletionProposals(IXtextDocument xtextDocument,
                                                                                    int cursorPosition,
                                                                                    org.eclipse.swt.widgets.Shell shell)
                                                                                         throws org.eclipse.jface.text.BadLocationException

Throws:

org.eclipse.jface.text.BadLocationException

computeCompletionProposals

protected org.eclipse.jface.text.contentassist.ICompletionProposal[] computeCompletionProposals(IXtextDocument xtextDocument,
                                                                                    int cursorPosition,
                                                                                    XtextSourceViewerConfiguration configuration,
                                                                                    org.eclipse.jface.text.source.ISourceViewer sourceViewer)
                                                                                         throws org.eclipse.jface.text.BadLocationException

Throws:

org.eclipse.jface.text.BadLocationException

withDirtyState

public ContentAssistProcessorTestBuilder withDirtyState()
                                                 throws Exception

Throws:

Exception

getDocument

protected IXtextDocument getDocument(String currentModelToParse)

getSourceViewer

protected org.eclipse.jface.text.source.ISourceViewer getSourceViewer(org.eclipse.swt.widgets.Shell shell,
                                                          IXtextDocument xtextDocument,
                                                          XtextSourceViewerConfiguration configuration)

computeCompletionProposals

public org.eclipse.jface.text.contentassist.ICompletionProposal[] computeCompletionProposals(int cursorPosition)
                                                                                      throws Exception

Throws:

Exception

computeCompletionProposals

public org.eclipse.jface.text.contentassist.ICompletionProposal[] computeCompletionProposals(String cursorPosition)
                                                                                      throws Exception

Throws:

Exception

computeCompletionProposals

public org.eclipse.jface.text.contentassist.ICompletionProposal[] computeCompletionProposals()
                                                                                      throws Exception

Throws:

Exception

toString

public String toString()

Overrides:

toString in class Object

getDocument

public IXtextDocument getDocument(XtextResource xtextResource,
                         String model)

getSourceViewer

public org.eclipse.jface.text.ITextViewer getSourceViewer(String currentModelToParse,
                                                 IXtextDocument xtextDocument)

clone

protected ContentAssistProcessorTestBuilder clone(String model,
                                      int offset)
                                           throws Exception

Throws:

Exception

cloneWithSuffix

protected ContentAssistProcessorTestBuilder cloneWithSuffix(String postFix)
                                                     throws Exception

Throws:

Exception

get

public <T> T get(Class<T> clazz)

getCursorPosition

protected int getCursorPosition()