Package net.sourceforge.pmd.lang

Interface LanguageVersionHandler

All Known Implementing Classes:

AbstractLanguageVersionHandler

public interface LanguageVersionHandler

Interface for obtaining the classes necessary for checking source files of a specific language. Note: "façade" getters like getSymbolFacade() will be removed with 7.0.0 and replaced with a more extensible mechanism. They're now deprecated. See also https://github.com/pmd/pmd/pull/1426

Author:

pieter_van_raemdonck - Application Engineers NV/SA - www.ae.be

Method Summary

Modifier and Type	Method	Description
VisitorStarter	getDataFlowFacade()	Deprecated. see note in the class description
DataFlowHandler	getDataFlowHandler()	Deprecated. This is internal API
ParserOptions	getDefaultParserOptions()	Get the default ParserOptions.
DesignerBindings	getDesignerBindings()	Returns the designer bindings for this language version.
DFAGraphRule	getDFAGraphRule()	Deprecated. This is internal API
VisitorStarter	getDumpFacade(Writer writer, String prefix, boolean recurse)	Deprecated. The dump façade is not that useful and will be completely scrapped with PMD 7.0.0
LanguageMetricsProvider<?,?>	getLanguageMetricsProvider()	Returns the metrics provider for this language version, or null if it has none.
VisitorStarter	getMultifileFacade()	Deprecated. see note in the class description
Parser	getParser(ParserOptions parserOptions)	Get the Parser.
VisitorStarter	getQualifiedNameResolutionFacade(ClassLoader classLoader)	Deprecated. see note in the class description
RuleViolationFactory	getRuleViolationFactory()	Get the RuleViolationFactory.
VisitorStarter	getSymbolFacade()	Deprecated. see note in the class description
VisitorStarter	getSymbolFacade(ClassLoader classLoader)	Deprecated. see note in the class description
VisitorStarter	getTypeResolutionFacade(ClassLoader classLoader)	Deprecated. see note in the class description
XPathHandler	getXPathHandler()	Get the XPathHandler.

Method Detail

getDataFlowHandler

@Deprecated
@InternalApi
DataFlowHandler getDataFlowHandler()

Deprecated.

This is internal API

Get the DataFlowHandler.

getXPathHandler

XPathHandler getXPathHandler()

Get the XPathHandler.

getRuleViolationFactory

RuleViolationFactory getRuleViolationFactory()

Get the RuleViolationFactory.

getDefaultParserOptions

ParserOptions getDefaultParserOptions()

Get the default ParserOptions.

Returns:

ParserOptions

getParser

Parser getParser(ParserOptions parserOptions)

Get the Parser.

Returns:

Parser

getDataFlowFacade

@Deprecated
VisitorStarter getDataFlowFacade()

Deprecated.

see note in the class description

Get the DataFlowFacade.

Returns:

VisitorStarter

getSymbolFacade

@Deprecated
VisitorStarter getSymbolFacade()

Deprecated.

see note in the class description

Get the SymbolFacade.

Returns:

VisitorStarter

getSymbolFacade

@Deprecated
VisitorStarter getSymbolFacade(ClassLoader classLoader)

Deprecated.

see note in the class description

Get the SymbolFacade.

Parameters:

classLoader - A ClassLoader to use for resolving Types.

Returns:

VisitorStarter

getTypeResolutionFacade

@Deprecated
VisitorStarter getTypeResolutionFacade(ClassLoader classLoader)

Deprecated.

see note in the class description

Get the TypeResolutionFacade.

Parameters:

classLoader - A ClassLoader to use for resolving Types.

Returns:

VisitorStarter

getDumpFacade

@Deprecated
VisitorStarter getDumpFacade(Writer writer,
                             String prefix,
                             boolean recurse)

Deprecated.

The dump façade is not that useful and will be completely scrapped with PMD 7.0.0

Get the DumpFacade.

Parameters:

writer - The writer to dump to.

Returns:

VisitorStarter

getMultifileFacade

@Deprecated
VisitorStarter getMultifileFacade()

Deprecated.

see note in the class description

Gets the visitor that performs multifile data gathering.

Returns:

The visitor starter

getQualifiedNameResolutionFacade

@Deprecated
VisitorStarter getQualifiedNameResolutionFacade(ClassLoader classLoader)

Deprecated.

see note in the class description

Gets the visitor that populates the qualified names of the nodes.

Parameters:

classLoader - The classloader to use to resolve the types of type qualified names

Returns:

The visitor starter

getDFAGraphRule

@Deprecated
@InternalApi
DFAGraphRule getDFAGraphRule()

Deprecated.

This is internal API

getLanguageMetricsProvider

@Experimental
LanguageMetricsProvider<?,?> getLanguageMetricsProvider()

Returns the metrics provider for this language version, or null if it has none. Note: this is experimental, ie unstable until 7.0.0, after which it will probably be promoted to a stable API. For instance the return type will probably be changed to an Optional.

getDesignerBindings

@Experimental
DesignerBindings getDesignerBindings()

Returns the designer bindings for this language version. Null is not an acceptable result, use DesignerBindings.DefaultDesignerBindings.getInstance() instead.

Since:

6.20.0