jcommon.extract.IResourceProcessor Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of init Show documentation

Java library for simple extracting and processing of embedded resources at runtime.

The newest version!


package jcommon.extract;

import org.w3c.dom.Document;
import org.w3c.dom.Node;

import javax.xml.xpath.XPath;
import javax.xml.xpath.XPathException;

/**
 * Classes that implement this interface are responsible for being able to
 * load themselves through the {@link #load(IResourcePackage, javax.xml.xpath.XPath, org.w3c.dom.Node, org.w3c.dom.Document, IVariableProcessor, ResourceProcessorFactory)}
 * method and then perform extraction or processing in the {@link #process(String, IResourcePackage, IResourceFilter, IResourceProgressListener)}
 * method.
 *
 * @author David Hoyt 
 */
public interface IResourceProcessor {
	//
	public static final IResourceProcessor
		NONE = null
	;
	
	public static final IResourceProcessor[]
		EMPTY = new IResourceProcessor[0]
	;
	//

	boolean supportsSize();
	long getSize();
	String getName();

	boolean isLoaded();
	boolean isProcessed();
	boolean load(final IResourcePackage pkg, final XPath xpath, final Node node, final Document document, final IVariableProcessor varproc, final ResourceProcessorFactory processorFactory) throws XPathException;
	boolean process(final String fullResourceName, final IResourcePackage pkg, final IResourceFilter filter, final IResourceProgressListener progress);
}