com.android.tools.lint.client.api
Interface IDomParser

@Beta
public interface IDomParser

A wrapper for an XML parser. This allows tools integrating lint to map directly to builtin services, such as already-parsed data structures in XML editors.

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.

Method Summary

Location.Handle	createLocationHandle(XmlContext context, org.w3c.dom.Node node) Creates a light-weight handle to a location for the given node.
void	dispose(XmlContext context, org.w3c.dom.Document document) Dispose any data structures held for the given context.
Location	getLocation(XmlContext context, org.w3c.dom.Node node) Returns a Location for the given DOM node
Location	getLocation(XmlContext context, org.w3c.dom.Node node, int start, int end) Returns a Location for the given DOM node.
int	getNodeEndOffset(XmlContext context, org.w3c.dom.Node node) Returns the end offset of the given node, or -1 if not known
int	getNodeStartOffset(XmlContext context, org.w3c.dom.Node node) Returns the start offset of the given node, or -1 if not known
org.w3c.dom.Document	parseXml(XmlContext context) Parse the file pointed to by the given context and return as a Document

Method Detail

parseXml

@Nullable
org.w3c.dom.Document parseXml(@NonNull
                                       XmlContext context)

Parse the file pointed to by the given context and return as a Document

Parameters:

context - the context pointing to the file to be parsed, typically via Context.getContents() but the file handle ( Context.file can also be used to map to an existing editor buffer in the surrounding tool, etc)

Returns:

the parsed DOM document, or null if parsing fails

getLocation

@NonNull
Location getLocation(@NonNull
                             XmlContext context,
                             @NonNull
                             org.w3c.dom.Node node)

Returns a Location for the given DOM node

Parameters:

context - information about the file being parsed

node - the node to create a location for

Returns:

a location for the given node

getLocation

@NonNull
Location getLocation(@NonNull
                             XmlContext context,
                             @NonNull
                             org.w3c.dom.Node node,
                             int start,
                             int end)

Returns a Location for the given DOM node. Like getLocation(XmlContext, Node), but allows a position range that is a subset of the node range.

Parameters:

context - information about the file being parsed

node - the node to create a location for

start - the starting position within the node, inclusive

end - the ending position within the node, exclusive

Returns:

a location for the given node

createLocationHandle

@NonNull
Location.Handle createLocationHandle(@NonNull
                                             XmlContext context,
                                             @NonNull
                                             org.w3c.dom.Node node)

Creates a light-weight handle to a location for the given node. It can be turned into a full fledged location by Location.Handle.resolve().

Parameters:

context - the context providing the node

node - the node (element or attribute) to create a location handle for

Returns:

a location handle

dispose

void dispose(@NonNull
             XmlContext context,
             @NonNull
             org.w3c.dom.Document document)

Dispose any data structures held for the given context.

Parameters:

context - information about the file previously parsed

document - the document that was parsed and is now being disposed

getNodeStartOffset

int getNodeStartOffset(@NonNull
                       XmlContext context,
                       @NonNull
                       org.w3c.dom.Node node)

Returns the start offset of the given node, or -1 if not known

Parameters:

context - the context providing the node

node - the node (element or attribute) to create a location handle for

Returns:

the start offset, or -1 if not known

getNodeEndOffset

int getNodeEndOffset(@NonNull
                     XmlContext context,
                     @NonNull
                     org.w3c.dom.Node node)

Returns the end offset of the given node, or -1 if not known

Parameters:

context - the context providing the node

node - the node (element or attribute) to create a location handle for

Returns:

the end offset, or -1 if not known