org.eclipse.xtext.xbase.ui.hover
Class XbaseHoverDocumentationProvider

java.lang.Object
  org.eclipse.xtext.xbase.ui.hover.XbaseHoverDocumentationProvider

All Implemented Interfaces:

IEObjectHoverDocumentationProvider

Direct Known Subclasses:

XtendHoverDocumentationProvider

public class XbaseHoverDocumentationProvider
extends java.lang.Object
implements IEObjectHoverDocumentationProvider

Since:

2.3

Author:

Holger Schill - Initial contribution and API

Field Summary

protected IJvmModelAssociations	associations
protected static java.lang.String	BLOCK_TAG_END
protected static java.lang.String	BlOCK_TAG_ENTRY_END
protected static java.lang.String	BlOCK_TAG_ENTRY_START
protected static java.lang.String	BLOCK_TAG_START
protected java.lang.StringBuffer	buffer
protected org.eclipse.emf.ecore.EObject	context
protected IEObjectDocumentationProvider	documentationProvider
protected int	fLiteralContent
protected JvmModelGenerator	jvmModelGenerator
protected static java.lang.String	PARAM_NAME_END
protected static java.lang.String	PARAM_NAME_START
protected IQualifiedNameConverter	qualifiedNameConverter
protected java.lang.String	rawJavaDoc
protected IScopeProvider	scopeProvider
protected org.eclipse.core.resources.IWorkspace	workspace

Constructor Summary

XbaseHoverDocumentationProvider()

Method Summary

protected void	addAnnotations(org.eclipse.emf.ecore.EObject object)
protected void	appendEscaped(java.lang.StringBuffer buf, java.lang.String text)
java.lang.String	computeDocumentation(org.eclipse.emf.ecore.EObject object)
protected java.lang.String	createMethodInTypeLinks(JvmOperation overridden)
protected java.lang.String	createSimpleMemberLink(org.eclipse.emf.ecore.EObject type)
protected java.lang.String	getDerivedElementInformation(org.eclipse.emf.ecore.EObject o)
java.lang.String	getDerivedOrOriginalDeclarationInformation(org.eclipse.emf.ecore.EObject object)
java.lang.String	getDocumentation(org.eclipse.emf.ecore.EObject object)
protected void	getDocumentationWithPrefix(org.eclipse.emf.ecore.EObject object)
protected java.util.List<org.eclipse.emf.ecore.EObject>	getFilteredDerivedElements(org.eclipse.emf.ecore.EObject o, org.eclipse.emf.ecore.EClass type)
protected java.util.List<org.eclipse.emf.ecore.EObject>	getFilteredSourceElements(org.eclipse.emf.ecore.EObject o, org.eclipse.emf.ecore.EClass type)
org.eclipse.jdt.core.dom.Javadoc	getJavaDoc()
protected java.lang.String	getOriginalDeclarationInformation(org.eclipse.emf.ecore.EObject o)
protected void	handleBlockTags(java.util.List<org.eclipse.jdt.core.dom.TagElement> tags)
protected void	handleBlockTags(java.lang.String title, java.util.List<org.eclipse.jdt.core.dom.TagElement> tags)
protected void	handleBlockTagTitle(java.lang.String title)
protected void	handleContentElements(java.util.List<? extends org.eclipse.jdt.core.dom.ASTNode> nodes)
protected void	handleContentElements(java.util.List<? extends org.eclipse.jdt.core.dom.ASTNode> nodes, boolean skipLeadingWhitespace)
protected void	handleDeprecatedTag(org.eclipse.jdt.core.dom.TagElement tag)
protected boolean	handleDocRoot(org.eclipse.jdt.core.dom.TagElement node)
protected void	handleExceptionTags(java.util.List<org.eclipse.jdt.core.dom.TagElement> tags, java.util.Map<java.lang.String,org.eclipse.emf.common.util.URI> exceptionNamesToURI)
protected boolean	handleInheritDoc(org.eclipse.jdt.core.dom.TagElement node)
protected void	handleInlineTagElement(org.eclipse.jdt.core.dom.TagElement node)
protected void	handleLink(java.util.List<?> fragments)
protected void	handleParameters(org.eclipse.emf.ecore.EObject object, java.util.List<org.eclipse.jdt.core.dom.TagElement> parameters, java.util.List<java.lang.String> parameterNames)
protected void	handleParamTag(org.eclipse.jdt.core.dom.TagElement tag)
protected void	handleReturnTag(org.eclipse.jdt.core.dom.TagElement tag)
protected void	handleSeeTag(org.eclipse.jdt.core.dom.TagElement tag)
protected void	handleSuperMethodReferences(org.eclipse.emf.ecore.EObject context)
protected void	handleText(java.lang.String text)
protected void	handleThrowsTag(org.eclipse.jdt.core.dom.TagElement tag)
protected boolean	handleValueTag(org.eclipse.jdt.core.dom.TagElement node)
protected java.util.Map<java.lang.String,org.eclipse.emf.common.util.URI>	initExceptionNamesToURI()
protected java.util.List<java.lang.String>	initParameterNames()
protected java.lang.String	removeDocLineIntros(java.lang.String textWithStars)

Methods inherited from class java.lang.Object

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

Field Detail

BLOCK_TAG_START

protected static final java.lang.String BLOCK_TAG_START

See Also:

Constant Field Values

BLOCK_TAG_END

protected static final java.lang.String BLOCK_TAG_END

See Also:

Constant Field Values

BlOCK_TAG_ENTRY_START

protected static final java.lang.String BlOCK_TAG_ENTRY_START

See Also:

Constant Field Values

BlOCK_TAG_ENTRY_END

protected static final java.lang.String BlOCK_TAG_ENTRY_END

See Also:

Constant Field Values

PARAM_NAME_START

protected static final java.lang.String PARAM_NAME_START

See Also:

Constant Field Values

PARAM_NAME_END

protected static final java.lang.String PARAM_NAME_END

See Also:

Constant Field Values

rawJavaDoc

protected java.lang.String rawJavaDoc

context

protected org.eclipse.emf.ecore.EObject context

scopeProvider

@Inject
protected IScopeProvider scopeProvider

qualifiedNameConverter

@Inject
protected IQualifiedNameConverter qualifiedNameConverter

workspace

@Inject
protected org.eclipse.core.resources.IWorkspace workspace

associations

@Inject
protected IJvmModelAssociations associations

documentationProvider

@Inject
protected IEObjectDocumentationProvider documentationProvider

jvmModelGenerator

@Inject
protected JvmModelGenerator jvmModelGenerator

buffer

protected java.lang.StringBuffer buffer

fLiteralContent

protected int fLiteralContent

Constructor Detail

XbaseHoverDocumentationProvider

public XbaseHoverDocumentationProvider()

Method Detail

getDocumentation

public java.lang.String getDocumentation(org.eclipse.emf.ecore.EObject object)

Specified by:

getDocumentation in interface IEObjectHoverDocumentationProvider

computeDocumentation

public java.lang.String computeDocumentation(org.eclipse.emf.ecore.EObject object)

getDerivedOrOriginalDeclarationInformation

public java.lang.String getDerivedOrOriginalDeclarationInformation(org.eclipse.emf.ecore.EObject object)

initParameterNames

protected java.util.List<java.lang.String> initParameterNames()

initExceptionNamesToURI

protected java.util.Map<java.lang.String,org.eclipse.emf.common.util.URI> initExceptionNamesToURI()

addAnnotations

protected void addAnnotations(org.eclipse.emf.ecore.EObject object)

getDocumentationWithPrefix

protected void getDocumentationWithPrefix(org.eclipse.emf.ecore.EObject object)

handleSuperMethodReferences

protected void handleSuperMethodReferences(org.eclipse.emf.ecore.EObject context)

createMethodInTypeLinks

protected java.lang.String createMethodInTypeLinks(JvmOperation overridden)

createSimpleMemberLink

protected java.lang.String createSimpleMemberLink(org.eclipse.emf.ecore.EObject type)

handleValueTag

protected boolean handleValueTag(org.eclipse.jdt.core.dom.TagElement node)

handleInheritDoc

protected boolean handleInheritDoc(org.eclipse.jdt.core.dom.TagElement node)

handleDocRoot

protected boolean handleDocRoot(org.eclipse.jdt.core.dom.TagElement node)

handleLink

protected void handleLink(java.util.List<?> fragments)

handleBlockTags

protected void handleBlockTags(java.util.List<org.eclipse.jdt.core.dom.TagElement> tags)

handleBlockTags

protected void handleBlockTags(java.lang.String title,
                               java.util.List<org.eclipse.jdt.core.dom.TagElement> tags)

handleSeeTag

protected void handleSeeTag(org.eclipse.jdt.core.dom.TagElement tag)

handleExceptionTags

protected void handleExceptionTags(java.util.List<org.eclipse.jdt.core.dom.TagElement> tags,
                                   java.util.Map<java.lang.String,org.eclipse.emf.common.util.URI> exceptionNamesToURI)

handleThrowsTag

protected void handleThrowsTag(org.eclipse.jdt.core.dom.TagElement tag)

handleDeprecatedTag

protected void handleDeprecatedTag(org.eclipse.jdt.core.dom.TagElement tag)

handleContentElements

protected void handleContentElements(java.util.List<? extends org.eclipse.jdt.core.dom.ASTNode> nodes)

handleContentElements

protected void handleContentElements(java.util.List<? extends org.eclipse.jdt.core.dom.ASTNode> nodes,
                                     boolean skipLeadingWhitespace)

handleInlineTagElement

protected void handleInlineTagElement(org.eclipse.jdt.core.dom.TagElement node)

handleText

protected void handleText(java.lang.String text)

appendEscaped

protected void appendEscaped(java.lang.StringBuffer buf,
                             java.lang.String text)

removeDocLineIntros

protected java.lang.String removeDocLineIntros(java.lang.String textWithStars)

handleParameters

protected void handleParameters(org.eclipse.emf.ecore.EObject object,
                                java.util.List<org.eclipse.jdt.core.dom.TagElement> parameters,
                                java.util.List<java.lang.String> parameterNames)

handleParamTag

protected void handleParamTag(org.eclipse.jdt.core.dom.TagElement tag)

handleReturnTag

protected void handleReturnTag(org.eclipse.jdt.core.dom.TagElement tag)

handleBlockTagTitle

protected void handleBlockTagTitle(java.lang.String title)

getJavaDoc

public org.eclipse.jdt.core.dom.Javadoc getJavaDoc()

getDerivedElementInformation

protected java.lang.String getDerivedElementInformation(org.eclipse.emf.ecore.EObject o)

getOriginalDeclarationInformation

protected java.lang.String getOriginalDeclarationInformation(org.eclipse.emf.ecore.EObject o)

getFilteredDerivedElements

protected java.util.List<org.eclipse.emf.ecore.EObject> getFilteredDerivedElements(org.eclipse.emf.ecore.EObject o,
                                                                                   org.eclipse.emf.ecore.EClass type)

getFilteredSourceElements

protected java.util.List<org.eclipse.emf.ecore.EObject> getFilteredSourceElements(org.eclipse.emf.ecore.EObject o,
                                                                                  org.eclipse.emf.ecore.EClass type)