Package net.sourceforge.pmd.lang

Class AbstractLanguageVersionHandler

java.lang.Object

net.sourceforge.pmd.lang.AbstractLanguageVersionHandler

All Implemented Interfaces:

LanguageVersionHandler

public abstract class AbstractLanguageVersionHandler
extends Object
implements LanguageVersionHandler

This is a generic implementation of the LanguageVersionHandler interface.

See Also:

LanguageVersionHandler

Constructor Summary

Constructors

Constructor	Description
AbstractLanguageVersionHandler()

Method Summary

Modifier and Type	Method	Description
VisitorStarter	getDataFlowFacade()	Get the DataFlowFacade.
DataFlowHandler	getDataFlowHandler()	Get the DataFlowHandler.
ParserOptions	getDefaultParserOptions()	Get the default ParserOptions.
DesignerBindings	getDesignerBindings()	Returns the designer bindings for this language version.
DFAGraphRule	getDFAGraphRule()
VisitorStarter	getDumpFacade(Writer writer, String prefix, boolean recurse)	Deprecated.
LanguageMetricsProvider<?,?>	getLanguageMetricsProvider()	Returns the metrics provider for this language version, or null if it has none.
VisitorStarter	getMultifileFacade()	Gets the visitor that performs multifile data gathering.
VisitorStarter	getQualifiedNameResolutionFacade(ClassLoader classLoader)	Gets the visitor that populates the qualified names of the nodes.
VisitorStarter	getSymbolFacade()	Get the SymbolFacade.
VisitorStarter	getSymbolFacade(ClassLoader classLoader)	Get the SymbolFacade.
VisitorStarter	getTypeResolutionFacade(ClassLoader classLoader)	Get the TypeResolutionFacade.
XPathHandler	getXPathHandler()	Get the XPathHandler.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sourceforge.pmd.lang.LanguageVersionHandler

getParser, getRuleViolationFactory

Constructor Detail

AbstractLanguageVersionHandler

public AbstractLanguageVersionHandler()

Method Detail

getDataFlowHandler

public DataFlowHandler getDataFlowHandler()

Description copied from interface: LanguageVersionHandler

Get the DataFlowHandler.

Specified by:

getDataFlowHandler in interface LanguageVersionHandler

getXPathHandler

public XPathHandler getXPathHandler()

Description copied from interface: LanguageVersionHandler

Get the XPathHandler.

Specified by:

getXPathHandler in interface LanguageVersionHandler

getDefaultParserOptions

public ParserOptions getDefaultParserOptions()

Description copied from interface: LanguageVersionHandler

Get the default ParserOptions.

Specified by:

getDefaultParserOptions in interface LanguageVersionHandler

Returns:

ParserOptions

getDataFlowFacade

public VisitorStarter getDataFlowFacade()

Description copied from interface: LanguageVersionHandler

Get the DataFlowFacade.

Specified by:

getDataFlowFacade in interface LanguageVersionHandler

Returns:

VisitorStarter

getSymbolFacade

public VisitorStarter getSymbolFacade()

Description copied from interface: LanguageVersionHandler

Get the SymbolFacade.

Specified by:

getSymbolFacade in interface LanguageVersionHandler

Returns:

VisitorStarter

getSymbolFacade

public VisitorStarter getSymbolFacade(ClassLoader classLoader)

Description copied from interface: LanguageVersionHandler

Get the SymbolFacade.

Specified by:

getSymbolFacade in interface LanguageVersionHandler

Parameters:

classLoader - A ClassLoader to use for resolving Types.

Returns:

VisitorStarter

getTypeResolutionFacade

public VisitorStarter getTypeResolutionFacade(ClassLoader classLoader)

Description copied from interface: LanguageVersionHandler

Get the TypeResolutionFacade.

Specified by:

getTypeResolutionFacade in interface LanguageVersionHandler

Parameters:

classLoader - A ClassLoader to use for resolving Types.

Returns:

VisitorStarter

getDumpFacade

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

Deprecated.

Description copied from interface: LanguageVersionHandler

Get the DumpFacade.

Specified by:

getDumpFacade in interface LanguageVersionHandler

Parameters:

writer - The writer to dump to.

Returns:

VisitorStarter

getMultifileFacade

public VisitorStarter getMultifileFacade()

Description copied from interface: LanguageVersionHandler

Gets the visitor that performs multifile data gathering.

Specified by:

getMultifileFacade in interface LanguageVersionHandler

Returns:

The visitor starter

getQualifiedNameResolutionFacade

public VisitorStarter getQualifiedNameResolutionFacade(ClassLoader classLoader)

Description copied from interface: LanguageVersionHandler

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

Specified by:

getQualifiedNameResolutionFacade in interface LanguageVersionHandler

Parameters:

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

Returns:

The visitor starter

getDFAGraphRule

public DFAGraphRule getDFAGraphRule()

Specified by:

getDFAGraphRule in interface LanguageVersionHandler

getLanguageMetricsProvider

public LanguageMetricsProvider<?,?> getLanguageMetricsProvider()

Description copied from interface: LanguageVersionHandler

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.

Specified by:

getLanguageMetricsProvider in interface LanguageVersionHandler

getDesignerBindings

public DesignerBindings getDesignerBindings()

Description copied from interface: LanguageVersionHandler

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

Specified by:

getDesignerBindings in interface LanguageVersionHandler