com.android.tools.lint.detector.api

Class XmlContext

java.lang.Object

com.android.tools.lint.detector.api.Context

com.android.tools.lint.detector.api.ResourceContext

com.android.tools.lint.detector.api.XmlContext

@Beta
public class XmlContext
extends ResourceContext

A Context used when checking XML files.

NOTE: This is not a public or final API; if you rely on this be prepared to adjust your code for the next tools release.

Field Summary

Fields

Modifier and Type	Field and Description
org.w3c.dom.Document	document The XML document

Fields inherited from class com.android.tools.lint.detector.api.Context

driver, file

Constructor Summary

Constructors

Constructor and Description
XmlContext(LintDriver driver, Project project, Project main, java.io.File file, com.android.resources.ResourceFolderType folderType, XmlParser parser) Construct a new XmlContext

Method Summary

Modifier and Type	Method and Description
Location.Handle	createLocationHandle(org.w3c.dom.Node node)
Location	getLocation(org.w3c.dom.Node node) Returns the location for the given node, which may be an element or an attribute.
Location	getLocation(org.w3c.dom.Node textNode, int begin, int end) Creates a new location within an XML text node
Location	getNameLocation(org.w3c.dom.Node node) Returns the location for name-portion of the given element or attribute.
XmlParser	getParser()
protected java.io.File	getResourceFolder() Returns the resource folder that this resource context corresponds to, if applicable
protected java.lang.String	getSuppressCommentPrefix() Returns the comment marker used in Studio to suppress statements for language, if any
Location	getValueLocation(org.w3c.dom.Attr node) Returns the location for value-portion of the given attribute
boolean	isSuppressedWithComment(org.w3c.dom.Node node, Issue issue)
void	report(Issue issue, Location location, java.lang.String message) Reports an issue.
void	report(Issue issue, org.w3c.dom.Node scope, Location location, java.lang.String message) Reports an issue applicable to a given DOM node.
void	report(Issue issue, org.w3c.dom.Node scope, Location location, java.lang.String message, LintFix quickfixData) Reports an issue applicable to a given DOM node.
void	report(Issue issue, org.w3c.dom.Node scope, Location location, java.lang.String message, java.lang.Object quickfixData) Deprecated. Here for temporary compatibility; the new typed quickfix data parameter should be used instead

Methods inherited from class com.android.tools.lint.detector.api.ResourceContext

getFolderConfiguration, getFolderVersion, getResourceFolderType

Methods inherited from class com.android.tools.lint.detector.api.Context

containsCommentSuppress, getClient, getConfiguration, getContents, getDriver, getMainProject, getPhase, getProject, getProperty, getScope, getSdkInfo, isEnabled, isSuppressedWithComment, log, report, report, requestRepeat, setProperty

Methods inherited from class java.lang.Object

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

Field Detail

document

public org.w3c.dom.Document document

The XML document

Constructor Detail

XmlContext

public XmlContext(@NonNull
                  LintDriver driver,
                  @NonNull
                  Project project,
                  @Nullable
                  Project main,
                  @NonNull
                  java.io.File file,
                  @Nullable
                  com.android.resources.ResourceFolderType folderType,
                  @NonNull
                  XmlParser parser)

Construct a new XmlContext

Parameters:

driver - the driver running through the checks

project - the project containing the file being checked

main - the main project if this project is a library project, or null if this is not a library project. The main project is the root project of all library projects, not necessarily the directly including project.

file - the file being checked

folderType - the ResourceFolderType of this file, if any

Method Detail

getLocation

@NonNull
public Location getLocation(@NonNull
                                     org.w3c.dom.Node node)

Returns the location for the given node, which may be an element or an attribute.

Parameters:

node - the node to look up the location for

Returns:

the location for the node

getNameLocation

@NonNull
public Location getNameLocation(@NonNull
                                         org.w3c.dom.Node node)

Returns the location for name-portion of the given element or attribute.

Parameters:

node - the node to look up the location for

Returns:

the location for the node

getValueLocation

@NonNull
public Location getValueLocation(@NonNull
                                          org.w3c.dom.Attr node)

Returns the location for value-portion of the given attribute

Parameters:

node - the node to look up the location for

Returns:

the location for the node

getLocation

@NonNull
public Location getLocation(@NonNull
                                     org.w3c.dom.Node textNode,
                                     int begin,
                                     int end)

Creates a new location within an XML text node

Parameters:

textNode - the text node

begin - the start offset within the text node (inclusive)

end - the end offset within the text node (exclusive)

Returns:

a new location

getParser

@NonNull
public XmlParser getParser()

report

public void report(@NonNull
                   Issue issue,
                   @Nullable
                   org.w3c.dom.Node scope,
                   @NonNull
                   Location location,
                   @NonNull
                   java.lang.String message)

Reports an issue applicable to a given DOM node. The DOM node is used as the scope to check for suppress lint annotations.

Parameters:

issue - the issue to report

scope - the DOM node scope the error applies to. The lint infrastructure will check whether there are suppress directives on this node (or its enclosing nodes) and if so suppress the warning without involving the client.

location - the location of the issue, or null if not known

message - the message for this warning

report

public void report(@NonNull
                   Issue issue,
                   @Nullable
                   org.w3c.dom.Node scope,
                   @NonNull
                   Location location,
                   @NonNull
                   java.lang.String message,
                   @Nullable
                   LintFix quickfixData)

Reports an issue applicable to a given DOM node. The DOM node is used as the scope to check for suppress lint annotations.

Parameters:

issue - the issue to report

scope - the DOM node scope the error applies to. The lint infrastructure will check whether there are suppress directives on this node (or its enclosing nodes) and if so suppress the warning without involving the client.

location - the location of the issue, or null if not known

message - the message for this warning

quickfixData - optional data to pass to the IDE for use by a quickfix.

report

@Deprecated
public void report(@NonNull
                               Issue issue,
                               @Nullable
                               org.w3c.dom.Node scope,
                               @NonNull
                               Location location,
                               @NonNull
                               java.lang.String message,
                               @Nullable
                               java.lang.Object quickfixData)

Deprecated. Here for temporary compatibility; the new typed quickfix data parameter should be used instead

report

public void report(@NonNull
                   Issue issue,
                   @NonNull
                   Location location,
                   @NonNull
                   java.lang.String message)

Description copied from class: Context

Reports an issue. Convenience wrapper around LintClient.report(com.android.tools.lint.detector.api.Context, com.android.tools.lint.detector.api.Issue, com.android.tools.lint.detector.api.Severity, com.android.tools.lint.detector.api.Location, java.lang.String, com.android.tools.lint.detector.api.TextFormat, com.android.tools.lint.detector.api.LintFix)

Overrides:

report in class Context

Parameters:

issue - the issue to report

location - the location of the issue

message - the message for this warning

getSuppressCommentPrefix

@Nullable
protected java.lang.String getSuppressCommentPrefix()

Description copied from class: Context

Returns the comment marker used in Studio to suppress statements for language, if any

Overrides:

getSuppressCommentPrefix in class Context

isSuppressedWithComment

public boolean isSuppressedWithComment(@NonNull
                                       org.w3c.dom.Node node,
                                       @NonNull
                                       Issue issue)

createLocationHandle

@NonNull
public Location.Handle createLocationHandle(@NonNull
                                                     org.w3c.dom.Node node)

getResourceFolder

@Nullable
protected java.io.File getResourceFolder()

Description copied from class: ResourceContext

Returns the resource folder that this resource context corresponds to, if applicable

Overrides:

getResourceFolder in class ResourceContext

Returns:

the resource folder if this resource context corresponds to a resource file