org.carewebframework.maven.plugin.help

Class HelpProcessor

java.lang.Object

org.carewebframework.maven.plugin.processor.AbstractProcessor<HelpConverterMojo>

org.carewebframework.maven.plugin.help.HelpProcessor

public class HelpProcessor
extends AbstractProcessor<HelpConverterMojo>

Processor for help content.

Field Summary

Fields inherited from class org.carewebframework.maven.plugin.processor.AbstractProcessor

mojo

Constructor Summary

Constructors

Constructor and Description
HelpProcessor(HelpConverterMojo mojo, String archiveName, SourceLoader loader)

Method Summary

Modifier and Type	Method and Description
String	getHelpSetFile() Returns the path to the main help set file, or null if one was not found during processing.
String	getResourceBase()
String	relocateResource(String resourcePath)
void	transform()
boolean	transform(IResource resource) Excludes resources under the META-INF folder and checks the resource against the help set pattern, saving a path reference if it matches.

Methods inherited from class org.carewebframework.maven.plugin.processor.AbstractProcessor

getMojo, registerTransform, replaceURLs, transform

Methods inherited from class java.lang.Object

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

Constructor Detail

HelpProcessor

public HelpProcessor(HelpConverterMojo mojo,
                     String archiveName,
                     SourceLoader loader)
              throws Exception

Throws:

Exception

Method Detail

relocateResource

public String relocateResource(String resourcePath)

Specified by:

relocateResource in class AbstractProcessor<HelpConverterMojo>

getResourceBase

public String getResourceBase()

Specified by:

getResourceBase in class AbstractProcessor<HelpConverterMojo>

transform

public void transform()
               throws Exception

Specified by:

transform in class AbstractProcessor<HelpConverterMojo>

Throws:

Exception

transform

public boolean transform(IResource resource)
                  throws Exception

Excludes resources under the META-INF folder and checks the resource against the help set pattern, saving a path reference if it matches.

Overrides:

transform in class AbstractProcessor<HelpConverterMojo>

Throws:

Exception

getHelpSetFile

public String getHelpSetFile()

Returns the path to the main help set file, or null if one was not found during processing.

Returns:

The path to the main help set file, or null if none was found.