Package com.intellij.codeInsight.documentation

Class AbstractExternalFilter

java.lang.Object

com.intellij.codeInsight.documentation.AbstractExternalFilter

Direct Known Subclasses:

JavaDocExternalFilter

public abstract class AbstractExternalFilter
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractExternalFilter.ParseSettings Settings used for parsing of external documentation
protected static class	AbstractExternalFilter.RefConvertor

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	HTML
protected static java.lang.String	HTML_CLOSE
protected static java.util.regex.Pattern	ourAnchorSuffix
protected static java.util.regex.Pattern	ourHtmlFileSuffix

Constructor Summary

Constructors

Constructor and Description
AbstractExternalFilter()

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	correctDocText(java.lang.String url, java.lang.CharSequence data)
java.lang.CharSequence	correctRefs(java.lang.String root, java.lang.CharSequence read)
protected static java.lang.String	doAnnihilate(java.lang.String path)
protected void	doBuildFromStream(java.lang.String url, java.io.Reader input, java.lang.StringBuilder data)
protected void	doBuildFromStream(java.lang.String url, java.io.Reader input, java.lang.StringBuilder data, boolean searchForEncoding, boolean matchStart)
java.lang.String	getExternalDocInfo(java.lang.String url)
java.lang.String	getExternalDocInfoForElement(java.lang.String docURL, PsiElement element)
protected AbstractExternalFilter.ParseSettings	getParseSettings(java.lang.String url)
protected abstract AbstractExternalFilter.RefConvertor[]	getRefConverters()

Methods inherited from class java.lang.Object

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

Field Detail

ourAnchorSuffix

protected static final java.util.regex.Pattern ourAnchorSuffix

ourHtmlFileSuffix

protected static final java.util.regex.Pattern ourHtmlFileSuffix

HTML

protected static final java.lang.String HTML

See Also:

Constant Field Values

HTML_CLOSE

protected static final java.lang.String HTML_CLOSE

See Also:

Constant Field Values

Constructor Detail

AbstractExternalFilter

public AbstractExternalFilter()

Method Detail

doAnnihilate

protected static java.lang.String doAnnihilate(java.lang.String path)

correctRefs

public java.lang.CharSequence correctRefs(java.lang.String root,
                                          java.lang.CharSequence read)

getRefConverters

protected abstract AbstractExternalFilter.RefConvertor[] getRefConverters()

getExternalDocInfo

public java.lang.String getExternalDocInfo(java.lang.String url)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

correctDocText

protected java.lang.String correctDocText(java.lang.String url,
                                          java.lang.CharSequence data)

getExternalDocInfoForElement

public java.lang.String getExternalDocInfoForElement(java.lang.String docURL,
                                                     PsiElement element)
                                              throws java.lang.Exception

Throws:

java.lang.Exception

doBuildFromStream

protected void doBuildFromStream(java.lang.String url,
                                 java.io.Reader input,
                                 java.lang.StringBuilder data)
                          throws java.io.IOException

Throws:

java.io.IOException

doBuildFromStream

protected void doBuildFromStream(java.lang.String url,
                                 java.io.Reader input,
                                 java.lang.StringBuilder data,
                                 boolean searchForEncoding,
                                 boolean matchStart)
                          throws java.io.IOException

Throws:

java.io.IOException

getParseSettings

protected AbstractExternalFilter.ParseSettings getParseSettings(java.lang.String url)