org.schmant.task.jdk.javadoc.pdfdoclet.ext
Class ExtPdfDocletDecorator

java.lang.Object
  extended by org.schmant.support.AbstractArgumentChecker
      extended by org.schmant.task.template.jdk.javadoc.AbstractCustomDocletDecorator<T>
          extended by org.schmant.task.jdk.javadoc.pdfdoclet.AbstractPdfDocletDecorator<ExtPdfDocletDecorator>
              extended by org.schmant.task.jdk.javadoc.pdfdoclet.ext.ExtPdfDocletDecorator
All Implemented Interfaces:
TargetConfigurable<ExtPdfDocletDecorator>, ExtJavadocTaskDecorator, PdfDocletDecorator<ExtPdfDocletDecorator>, TaskDecorator, CustomDocletDecorator<ExtPdfDocletDecorator>, JavadocTaskDecorator, ValidatingDecorator

public class ExtPdfDocletDecorator
extends AbstractPdfDocletDecorator<ExtPdfDocletDecorator>
implements PdfDocletDecorator<ExtPdfDocletDecorator>, ExtJavadocTaskDecorator

This PDF doclet decorator is used for the ExtJavadocTask.

Since:
0.5
Author:
Karl Gustafsson
Task_package:
com.tarsec.javadoc.pdfdoclet

Field Summary
static String DOCLET_CLASS_NAME
           
 
Constructor Summary
ExtPdfDocletDecorator()
           
 
Method Summary
 void addOptions(ArgumentList fal)
          Print additional options to the argument file.
 void validate(Report r, Collection<String> errs)
          Validate the task decorator and add errors to errs.
 
Methods inherited from class org.schmant.task.jdk.javadoc.pdfdoclet.AbstractPdfDocletDecorator
getConfigFile, getTarget, setConfigFile, setTarget
 
Methods inherited from class org.schmant.task.template.jdk.javadoc.AbstractCustomDocletDecorator
addDocletPath, addDocletPaths, getDocletPaths, getThis
 
Methods inherited from class org.schmant.support.AbstractArgumentChecker
check, check, check, check
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.schmant.task.jdk.javadoc.pdfdoclet.PdfDocletDecorator
getConfigFile, setConfigFile
 
Methods inherited from interface org.schmant.task.template.jdk.javadoc.CustomDocletDecorator
addDocletPath, addDocletPaths, getDocletPaths
 
Methods inherited from interface org.schmant.task.confable.TargetConfigurable
setTarget
 

Field Detail

DOCLET_CLASS_NAME

public static final String DOCLET_CLASS_NAME
See Also:
Constant Field Values
Constructor Detail

ExtPdfDocletDecorator

public ExtPdfDocletDecorator()
Method Detail

validate

public void validate(Report r,
                     Collection<String> errs)
Description copied from interface: ValidatingDecorator
Validate the task decorator and add errors to errs.

Specified by:
validate in interface ValidatingDecorator
Parameters:
r - The current Report. Just like for AbstractTask.validate(Report), no validation errors should be logged to this. (They are logged later on.)
errs - A collection of error messages. Add validation error messages to this.

addOptions

public void addOptions(ArgumentList fal)
Description copied from interface: ExtJavadocTaskDecorator
Print additional options to the argument file. Different options are separated by a newline (by adding null to the list).

Specified by:
addOptions in interface ExtJavadocTaskDecorator
Parameters:
fal - The argument list.