com.buschmais.jqassistant.plugin.xml.api.scanner

Class XMLFileFilter

java.lang.Object

com.buschmais.jqassistant.plugin.xml.api.scanner.XMLFileFilter

public final class XMLFileFilter
extends Object

Provides functionality to verify if a file resource represents a specific XML document, e.g. by checking for the presence of a root element.

Method Summary

Modifier and Type	Method and Description
static boolean	rootElementMatches(com.buschmais.jqassistant.plugin.common.api.scanner.filesystem.FileResource fileResource, String path, String expectedRootElement) Matches a file resource for being an XML file with a specific root element.

Methods inherited from class java.lang.Object

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

Method Detail

rootElementMatches

public static boolean rootElementMatches(com.buschmais.jqassistant.plugin.common.api.scanner.filesystem.FileResource fileResource,
                                         String path,
                                         String expectedRootElement)
                                  throws IOException

Matches a file resource for being an XML file with a specific root element.

Parameters:

fileResource - The file resource.

path - The path of the file resource.

expectedRootElement - The expected local name of the root element.

Returns:

true If the file is an XML file and contains the expected root element.

Throws:

IOException - If the file resource cannot be read.