Package org.eclipse.xtext.documentation.impl

Class MultiLineJavaDocTypeReferenceProvider

java.lang.Object

org.eclipse.xtext.documentation.impl.MultiLineJavaDocTypeReferenceProvider

All Implemented Interfaces:

IJavaDocTypeReferenceProvider

public class MultiLineJavaDocTypeReferenceProvider
extends java.lang.Object
implements IJavaDocTypeReferenceProvider

Since:

2.4

Field Summary

Fields

Modifier and Type	Field	Description
protected java.lang.String	lineDelimiter	Deprecated.
protected IQualifiedNameConverter	qualifiedNameConverter
protected IScopeProvider	scopeProvider

Fields inherited from interface org.eclipse.xtext.documentation.IJavaDocTypeReferenceProvider

LINK_TAG, LINK_TAG_WITH_SUFFIX, SEE_TAG, SEE_TAG_WITH_SUFFIX

Constructor Summary

Constructors

Constructor	Description
MultiLineJavaDocTypeReferenceProvider()

Method Summary

Modifier and Type	Method	Description
EObjectInComment	computeEObjectReferencedInComment(XtextResource resource, int offset)	Returns the referenced element in javadoc comment at a given offset.
java.util.List<org.eclipse.xtext.util.ReplaceRegion>	computeParameterTypeRefRegions(INode node)
protected void	computeRegions(java.util.List<org.eclipse.xtext.util.ReplaceRegion> regions, java.lang.Iterable<ILeafNode> leafNodes, java.lang.String toSearch, java.lang.String... ends)	Computes regions between a given string to search and different ends searched by their precedence
protected void	computeRegions(java.util.List<org.eclipse.xtext.util.ReplaceRegion> regions, java.lang.Iterable<ILeafNode> leafNodes, java.lang.String toSearch, java.lang.String end, java.lang.String optionalEnd, java.lang.String optionalEnd2)	Deprecated. use computeRegions(List, Iterable, String, String...)
java.util.List<org.eclipse.xtext.util.ReplaceRegion>	computeTypeRefRegions(INode node)
protected IEObjectDescription	getElementFromScope(IScope scope, INode node, org.eclipse.xtext.util.ITextRegion region, java.lang.String text)
protected org.eclipse.emf.ecore.EReference	getEReference(org.eclipse.emf.ecore.EObject eObject, INode node, int offset)	Returns the EReference used to calculate the referenced elements in javadoc comments.
protected IScope	getScope(org.eclipse.emf.ecore.EObject semanticObject, org.eclipse.emf.ecore.EReference reference, INode node, int offset)

Methods inherited from class java.lang.Object

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

Field Detail

lineDelimiter

@Deprecated
protected java.lang.String lineDelimiter

Deprecated.

scopeProvider

@Inject
protected IScopeProvider scopeProvider

qualifiedNameConverter

@Inject
protected IQualifiedNameConverter qualifiedNameConverter

Constructor Detail

MultiLineJavaDocTypeReferenceProvider

public MultiLineJavaDocTypeReferenceProvider()

Method Detail

computeTypeRefRegions

public java.util.List<org.eclipse.xtext.util.ReplaceRegion> computeTypeRefRegions(INode node)

Specified by:

computeTypeRefRegions in interface IJavaDocTypeReferenceProvider

computeParameterTypeRefRegions

public java.util.List<org.eclipse.xtext.util.ReplaceRegion> computeParameterTypeRefRegions(INode node)

Specified by:

computeParameterTypeRefRegions in interface IJavaDocTypeReferenceProvider

computeEObjectReferencedInComment

public EObjectInComment computeEObjectReferencedInComment(XtextResource resource,
                                                          int offset)

Returns the referenced element in javadoc comment at a given offset. Returns null in case no element is referenced at the given offset.

Specified by:

computeEObjectReferencedInComment in interface IJavaDocTypeReferenceProvider

computeRegions

@Deprecated
protected void computeRegions(java.util.List<org.eclipse.xtext.util.ReplaceRegion> regions,
                              java.lang.Iterable<ILeafNode> leafNodes,
                              java.lang.String toSearch,
                              java.lang.String end,
                              java.lang.String optionalEnd,
                              java.lang.String optionalEnd2)

Deprecated.

use computeRegions(List, Iterable, String, String...)

Computes regions between a given string to search and different ends searched by their precedence

Parameters:

regions - - List to put new regions in

leafNodes - - nodes to search in

toSearch - - String to search

end - - end with highest precedence

optionalEnd - - end with lower precedence

optionalEnd2 - - end with lowest precedence

computeRegions

protected void computeRegions(java.util.List<org.eclipse.xtext.util.ReplaceRegion> regions,
                              java.lang.Iterable<ILeafNode> leafNodes,
                              java.lang.String toSearch,
                              java.lang.String... ends)

Computes regions between a given string to search and different ends searched by their precedence

Parameters:

regions - - List to put new regions in

leafNodes - - nodes to search in

toSearch - - String to search

ends - - ends in decreasing precedence

Since:

2.6

getEReference

protected org.eclipse.emf.ecore.EReference getEReference(org.eclipse.emf.ecore.EObject eObject,
                                                         INode node,
                                                         int offset)

Returns the EReference used to calculate the referenced elements in javadoc comments. This method is intented to be implemented by clients.

getScope

protected IScope getScope(org.eclipse.emf.ecore.EObject semanticObject,
                          org.eclipse.emf.ecore.EReference reference,
                          INode node,
                          int offset)

getElementFromScope

protected IEObjectDescription getElementFromScope(IScope scope,
                                                  INode node,
                                                  org.eclipse.xtext.util.ITextRegion region,
                                                  java.lang.String text)