com.google.api.tools.framework.aspects

Class LintRule<E extends Element>

java.lang.Object

com.google.api.tools.framework.aspects.LintRule<E>

public abstract class LintRule<E extends Element>
extends java.lang.Object

Base class of lint rules, which log style violations.

Lint rules are managed via ConfigAspectBase where they are registered during construction time and automatically executed during the linting phase.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LintRule(ConfigAspectBase aspect, java.lang.String ruleName, java.lang.Class<E> elemClass) Constructs a lint rule applicable to the specified model element class.

Method Summary

Modifier and Type	Method and Description
java.lang.Class<E>	getElementClass() Gets the element class this rule works on.
Location	getLocationInConfig(com.google.protobuf.Message message, java.lang.String fieldName) Returns the service config file location of the given named field in the (sub)message.
java.lang.String	getName() Gets the name of the rule used in diagnosis.
abstract void	run(E element) Runs the rule.
protected void	warning(java.lang.Object element, java.lang.String message, java.lang.Object... params) Logs a lint warning.

Methods inherited from class java.lang.Object

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

Constructor Detail

LintRule

protected LintRule(ConfigAspectBase aspect,
                   java.lang.String ruleName,
                   java.lang.Class<E> elemClass)

Constructs a lint rule applicable to the specified model element class. All lint warnings emitted by the rule use the passed rule name.

Method Detail

getElementClass

public java.lang.Class<E> getElementClass()

Gets the element class this rule works on.

getName

public java.lang.String getName()

Gets the name of the rule used in diagnosis.

run

public abstract void run(E element)

Runs the rule. All issues should be reported using the warning(Object, String, Object...) method.

warning

protected void warning(java.lang.Object element,
                       java.lang.String message,
                       java.lang.Object... params)

Logs a lint warning.

getLocationInConfig

public Location getLocationInConfig(com.google.protobuf.Message message,
                                    java.lang.String fieldName)

Returns the service config file location of the given named field in the (sub)message. Returns SimpleLocation.TOPLEVEL if the location is not known.