Index (webPDF ant-task 1.0.0 API)

A C D E F G I L N O P R S T U V W X

A

add(UnknownElement) - Method in class net.webpdf.ant.GroupTask: This method shall define special handling for unknown sub elements.
add(Variable) - Method in class net.webpdf.ant.GroupTask: Adds a variable to the group context.
add(ResourceCollection) - Method in class net.webpdf.ant.task.files.IterativeTaskFileMap: Will add each resource defined in the given collection.
add(Variable) - Method in class net.webpdf.ant.task.variable.VariableMap: Add the given variable to this variable container.
add(ResourceCollection) - Method in class net.webpdf.ant.WebPDFTask: This shall add the given items as sources of this task.
add(FileNameMapper) - Method in class net.webpdf.ant.WebPDFTask: This shall configure the mapper used by this task, to determine the name of the generated target file.
add(GroupTask) - Method in class net.webpdf.ant.WebPDFTask: This method shall add a bundled task to this task.
add(UserCredentials) - Method in class net.webpdf.ant.WebPDFTask: Provides basic user credentials (username and password) for the authentication at the webPDF server.
add(NTCredentials) - Method in class net.webpdf.ant.WebPDFTask: Provides credentials for windows platforms, containing username and password and optionally the name of the user's workstation and domain name.
add(Variable) - Method in class net.webpdf.ant.WebPDFTask: Adds a variable to the group context.
addTask(Task) - Method in class net.webpdf.ant.GroupTask: Method to add sub elements to this task.
addTask(Task) - Method in class net.webpdf.ant.WebPDFTask: Method to add sub elements to this tag.
AntAccess - Annotation Type in net.webpdf.ant.task: Marks ANT interface methods (create, add, getter, setter)
AntLogger - Class in net.webpdf.ant.task.logging: This class will format messages in a useful way, that can be logged by a tasks logging methods.
AntLogger(Task) - Constructor for class net.webpdf.ant.task.logging.AntLogger: An instance of this class will format messages in a useful way, that can be logged by a tasks logging methods.

C

cleanTemp() - Method in class net.webpdf.ant.task.files.TempDir: All temporary files, having been created by this instance and not having been deleted yet, will be deleted by calling this method.
CredentialsFactory - Class in net.webpdf.ant.task.credentials: This class creates usable Credentials, that authenticate a user during a webPDF webservice call.

D

dropCurrentTarget() - Method in class net.webpdf.ant.task.files.IterativeTaskFile: Invalidates the current temporary target and will preserve the current source file for the next operation.

E

error(String, LogTag) - Method in class net.webpdf.ant.task.logging.AntLogger: Simplified logging method, that will output the given information on log level error.
error(String, Throwable, LogTag) - Method in class net.webpdf.ant.task.logging.AntLogger: Simplified logging method, that will output the given information on log level error.
error(Throwable, LogTag) - Method in class net.webpdf.ant.task.logging.AntLogger: Simplified logging method, that will output the given information on log level error.
execute() - Method in class net.webpdf.ant.GroupTask: Central method to execute a task and all it's sub tasks.
execute() - Method in class net.webpdf.ant.OperationTask: Central method to execute the operation.
execute() - Method in class net.webpdf.ant.task.Task: Called by the project to let the task do its work.
execute() - Method in interface net.webpdf.ant.task.TaskIntf: Called by the project to let the task do its work.
execute() - Method in class net.webpdf.ant.task.variable.Variable: Attempts to publish the currently stored value for the given variable name.
execute() - Method in class net.webpdf.ant.WebPDFTask: Central method to execute a task and all it's sub tasks.

F

finalizeAndReset(File, File) - Method in class net.webpdf.ant.task.files.IterativeTaskFile: This shall both reset this instance to it's original state and shall copy the last produced result to either the given targetFile (using the exact name and path), or to the given targetDirectory (using the initially set targetName).

G

getAttributes() - Method in class net.webpdf.ant.task.xml.XMLElement: A generic access method providing JAXB with all attributes, that have been set for this node.
getChildren() - Method in class net.webpdf.ant.task.xml.XMLElement: A generic access method providing JAXB with all child nodes, that are contained in this node.
getCredentials() - Method in class net.webpdf.ant.task.TaskConfiguration: Returns credentials, that may be used to authenticate a user at the webPDF server.
getCurrentSource() - Method in class net.webpdf.ant.task.files.IterativeTaskFile: Shall return the file, that is serving as the source file of the currently prepared step.
getCurrentTarget() - Method in class net.webpdf.ant.task.files.IterativeTaskFile: This shall return the current target file - if the current target file has not yet been initialized, a new temporary target file shall be prepared by calling this method.
getFiles() - Method in class net.webpdf.ant.task.Task: Returns the container managing the iterative file progression of this task.
getFiles() - Method in interface net.webpdf.ant.task.TaskIntf: Returns the container managing the iterative file progression of this task.
getLevel() - Method in enum net.webpdf.ant.task.logging.LogLevel: Returns the numeric representation of this LogLevel.
getLogger() - Method in class net.webpdf.ant.task.Task: Returns the logger used by this task.
getLogger() - Method in interface net.webpdf.ant.task.TaskIntf: Returns the logger used by this task.
getMessage() - Method in enum net.webpdf.ant.task.logging.LogLevel: Returns the printable name of this log level.
getName() - Method in enum net.webpdf.ant.task.TaskName: Return the name of the defined task.
getName() - Method in class net.webpdf.ant.task.variable.Variable: Returns the referable name of the variable.
getRole() - Method in class net.webpdf.ant.task.variable.Variable: Returns the role of the variable and provides information about it's usage and purpose via the VariableRole enum.
getServerURL() - Method in class net.webpdf.ant.task.TaskConfiguration: Returns the URL of the webPDF server.
getTag() - Method in enum net.webpdf.ant.task.logging.LogTag: Returns the printable name of the source tag of a logged message.
getTargetDirectory() - Method in class net.webpdf.ant.task.files.IterativeTaskFileMap: Shall return the directory the final result shall be placed in.
getTargetFile() - Method in class net.webpdf.ant.task.files.IterativeTaskFileMap: Returns the file the final result shall be copied to.
getTaskConfiguration() - Method in class net.webpdf.ant.task.Task: Returns the top level task configuration of this sub task.
getTaskConfiguration() - Method in interface net.webpdf.ant.task.TaskIntf: Returns the top level task configuration of this sub task.
getTaskFiles() - Method in class net.webpdf.ant.task.TaskConfiguration: The returned TaskFileCollection shall contain all files the current webPDf task shall be executed for.
getTempDir() - Method in class net.webpdf.ant.task.files.IterativeTaskFileMap
getTempDir() - Method in class net.webpdf.ant.task.files.TempDir: Returns the actual temp directory.
getType() - Method in enum net.webpdf.ant.task.TaskName: Return the type of the defined task.
getValue() - Method in class net.webpdf.ant.task.variable.Variable: Returns the value of the variable.
getValue() - Method in class net.webpdf.ant.task.xml.XMLAttribute: Returns the current value of the attribute.
getVar(VariableRole) - Method in class net.webpdf.ant.task.variable.VariableMap: Returns the variable, that is currently serving the given role.
getVariables() - Method in class net.webpdf.ant.task.Task: Returns the variables used by this task.
getVariables() - Method in interface net.webpdf.ant.task.TaskIntf: Returns the variables used by this task.
GroupTask - Class in net.webpdf.ant: Task mapping the ant tag and all it's options.
GroupTask() - Constructor for class net.webpdf.ant.GroupTask: A Group Task shall be able to contain individual operations, that are bundled to one sequential groups, defining common rules and resources.

I

info(String, LogTag) - Method in class net.webpdf.ant.task.logging.AntLogger: Simplified logging method, that will output the given information on log level info.
info(LogTag) - Method in class net.webpdf.ant.task.logging.AntLogger: Simplified logging method, that will output the given information on log level info.
isFailOnError() - Method in class net.webpdf.ant.task.TaskConfiguration: If this returns true, then a failing task must interrupt the currently executed webPDF task and shall prevent other sub tasks from being executed.
isRoleTaken(VariableRole) - Method in class net.webpdf.ant.task.variable.VariableMap: Returns true if a variable has already been assigned to the given role.
IterativeTaskFile - Class in net.webpdf.ant.task.files: This class manages the files processed by a task, it shall start with the original source file and shall provide a temporary target file for each calling sub task.
IterativeTaskFile(File, String, TempDir) - Constructor for class net.webpdf.ant.task.files.IterativeTaskFile: An instance of this class manages files for encapsulated tasks - passing results of a previous task, as the source for following task.
IterativeTaskFileMap - Class in net.webpdf.ant.task.files: The TaskFileCollection collects all files, that the current webPDF task shall be executed for.
IterativeTaskFileMap() - Constructor for class net.webpdf.ant.task.files.IterativeTaskFileMap: A collection for all source files, that shall be processed by the current webPDF task.
iterator() - Method in class net.webpdf.ant.task.files.IterativeTaskFileMap: An iterator over all source/name mappings of this collection.

L

LogLevel - Enum in net.webpdf.ant.task.logging: Provides Tags and more complex types for the different numeric Project logging levels.
LogTag - Enum in net.webpdf.ant.task.logging: Provides names for the different locations, that may cause the logging of messages.

N

net.webpdf.ant - package net.webpdf.ant
net.webpdf.ant.task - package net.webpdf.ant.task
net.webpdf.ant.task.credentials - package net.webpdf.ant.task.credentials
net.webpdf.ant.task.files - package net.webpdf.ant.task.files
net.webpdf.ant.task.logging - package net.webpdf.ant.task.logging
net.webpdf.ant.task.variable - package net.webpdf.ant.task.variable
net.webpdf.ant.task.xml - package net.webpdf.ant.task.xml
NTCredentials - Class in net.webpdf.ant.task.credentials: This task provides credentials for windows platforms, containing username and password and optionally the name of the user's workstation and domain name.
NTCredentials() - Constructor for class net.webpdf.ant.task.credentials.NTCredentials

O

OperationTask - Class in net.webpdf.ant: Task mapping the ant tag and all it's options.

P

parseUnknownElement(UnknownElement) - Static method in class net.webpdf.ant.task.xml.XMLElement: This static access method allows to parse an unknown ANT element to an executable OperationTask, that is representing a call to a webPDF webservice.
prepareConfiguration(Project) - Method in class net.webpdf.ant.task.xml.XMLElement: Uses JAXB to marshall this node and it's children to XML.
prepareNextOperation() - Method in class net.webpdf.ant.task.files.IterativeTaskFile: This shall decide whether the current temporary source file shall be deleted or not.
preserveCurrentSource() - Method in class net.webpdf.ant.task.files.IterativeTaskFile: When called the current temporary source file will not be deleted, when it is replaced by the current target in next step.
produceCredentials(Task) - Static method in class net.webpdf.ant.task.credentials.CredentialsFactory: This Method shall attempt to produce a usable credential instance from a given credentials task.

R

replaceWithInputVar(Variable) - Method in class net.webpdf.ant.task.files.IterativeTaskFileMap: Overrides the currently set resources with a manually set input variable.
reset() - Method in class net.webpdf.ant.task.files.IterativeTaskFile: This will drop the current context and will reset this instance to the original source document.

S

setCredentialsTask(Task) - Method in class net.webpdf.ant.task.TaskConfiguration: Initializes the credentials, that shall be used for the authentication at the webPDF server.
setCurrentSource(File, boolean) - Method in class net.webpdf.ant.task.files.IterativeTaskFile: Shall set the file, that is serving as the source file of the currently prepared step.
setDomain(String) - Method in class net.webpdf.ant.task.credentials.NTCredentials: Sets the name of the domain of the user, that shall be authenticated.
setFailOnError(boolean) - Method in class net.webpdf.ant.task.TaskConfiguration: If set to true, a failing sub task shall instantly interrupt the execution of the webPDF task and shall prevent other sub tasks from being executed.
setFailOnError(boolean) - Method in class net.webpdf.ant.WebPDFTask: This will set the failOnError flag.
setFiles(IterativeTaskFile) - Method in class net.webpdf.ant.task.Task: Sets the configuration container managing the iterative file progression in between the encapsulated tasks and sub tasks.
setFiles(IterativeTaskFile) - Method in interface net.webpdf.ant.task.TaskIntf: Sets the configuration container managing the iterative file progression in between the encapsulated tasks and sub tasks.
setMapper(FileNameMapper) - Method in class net.webpdf.ant.task.files.IterativeTaskFileMap: Initializes the mapper, that will be used to deduce target file names for source files.
setName(String) - Method in class net.webpdf.ant.task.variable.Variable: Alters the referable name of the variable.
setOwningTask(Task) - Method in class net.webpdf.ant.task.variable.Variable: Change the task owning this variable.
setPassword(String) - Method in class net.webpdf.ant.task.credentials.NTCredentials: Sets the password of the user, that shall be authenticated.
setPassword(String) - Method in class net.webpdf.ant.task.credentials.UserCredentials: Sets the password of the user, that shall be authenticated.
setRole(VariableRole) - Method in class net.webpdf.ant.task.variable.Variable: Alters the role of the variable and provides information about it's usage and purpose via the VariableRole enum.
setServerUrl(String) - Method in class net.webpdf.ant.task.TaskConfiguration: Sets the URL of the webPDF server.
setServerUrl(String) - Method in class net.webpdf.ant.WebPDFTask: This will initialize an URL pointing to the webPDF server.
setTargetDir(File) - Method in class net.webpdf.ant.WebPDFTask: This will set the target directory all operation results shall be published to.
setTargetDirectory(File) - Method in class net.webpdf.ant.task.files.IterativeTaskFileMap: Sets the directory the final result shall be placed in.
setTargetFile(File) - Method in class net.webpdf.ant.task.files.IterativeTaskFileMap: Sets the explicit file the final result shall be copied to.
setTargetFile(File) - Method in class net.webpdf.ant.WebPDFTask: This will set a single file all output shall be written to.
setTaskConfiguration(TaskConfiguration) - Method in class net.webpdf.ant.task.Task: Passes the top level task configuration on to this sub task.
setTaskConfiguration(TaskConfiguration) - Method in interface net.webpdf.ant.task.TaskIntf: Passes the top level task configuration on to this sub task.
setTempDir(File) - Method in class net.webpdf.ant.task.files.IterativeTaskFileMap: Sets the directory temporary files shall be created in.
setTempDir(File) - Method in class net.webpdf.ant.WebPDFTask: This shall define the temporary directory for this task.
setUsername(String) - Method in class net.webpdf.ant.task.credentials.NTCredentials: Sets the name of the user that shall be authenticated.
setUsername(String) - Method in class net.webpdf.ant.task.credentials.UserCredentials: Sets the name of the user, that shall be authenticated.
setValue(String) - Method in class net.webpdf.ant.task.variable.Variable: Alters the value of the variable.
setValue(String) - Method in class net.webpdf.ant.task.xml.XMLAttribute: Alters the current value of the attribute.
setWorkstation(String) - Method in class net.webpdf.ant.task.credentials.NTCredentials: Sets the name of the workstation of the user, that shall be authenticated.

T

Task - Class in net.webpdf.ant.task: This class shall provide all mechanisms for a containing parent task to initialize and execute it's children.
Task(TaskName) - Constructor for class net.webpdf.ant.task.Task: An extending class shall provide a set of basic mechanisms to initialize and execute it's children.
TaskConfiguration - Class in net.webpdf.ant.task: This class bundles all parameters set in the top level webPDF task container.
TaskConfiguration() - Constructor for class net.webpdf.ant.task.TaskConfiguration: Shall create a new task configuration, that shall be referenced by all sub tasks.
TaskIntf - Interface in net.webpdf.ant.task: An implementing class shall provide all mechanisms for a containing parent task to initialize and execute it's children.
TaskName - Enum in net.webpdf.ant.task: Stores names and types for the different defined task classes.
TempDir - Class in net.webpdf.ant.task.files: This points to the temporary directory used by the task and will collect all temporary files created during the webPDF call.
TempDir() - Constructor for class net.webpdf.ant.task.files.TempDir: A directory serving as the temporary directory of the webPDF task.
tryPublish(Variable) - Method in class net.webpdf.ant.task.files.IterativeTaskFile: Attempts to publish the current group result to the Ant context using the given output var name.

U

UserCredentials - Class in net.webpdf.ant.task.credentials: This task provides basic credentials consisting of username and password.
UserCredentials() - Constructor for class net.webpdf.ant.task.credentials.UserCredentials

V

valueOf(String) - Static method in enum net.webpdf.ant.task.logging.LogLevel: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum net.webpdf.ant.task.logging.LogTag: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum net.webpdf.ant.task.TaskName: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum net.webpdf.ant.task.variable.VariableRole: Returns the enum constant of this type with the specified name.
values() - Static method in enum net.webpdf.ant.task.logging.LogLevel: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum net.webpdf.ant.task.logging.LogTag: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum net.webpdf.ant.task.TaskName: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum net.webpdf.ant.task.variable.VariableRole: Returns an array containing the constants of this enum type, in the order they are declared.
Variable - Class in net.webpdf.ant.task.variable: Manages a task storing a variable property.
Variable() - Constructor for class net.webpdf.ant.task.variable.Variable: An instance of this class manages and stores a variable property.
VariableMap - Class in net.webpdf.ant.task.variable: Stores variables for a task and allows to retrieve said variables using their role.
VariableMap(Task) - Constructor for class net.webpdf.ant.task.variable.VariableMap: Creates a fresh variable container for the given task.F
VariableRole - Enum in net.webpdf.ant.task.variable: Provides information about the role and purpose of a variable.

W

warn(String, LogTag) - Method in class net.webpdf.ant.task.logging.AntLogger: Simplified logging method, that will output the given information on log level warn.
warn(String, Throwable, LogTag) - Method in class net.webpdf.ant.task.logging.AntLogger: Simplified logging method, that will output the given information on log level warn.
warn(Throwable, LogTag) - Method in class net.webpdf.ant.task.logging.AntLogger: Simplified logging method, that will output the given information on log level warn.
WebPDFTask - Class in net.webpdf.ant: This task is representing the top level of the webPDF ANT task.
WebPDFTask() - Constructor for class net.webpdf.ant.WebPDFTask: An instance of this class is representing the top level of the webPDF ANT task.

X

XMLAttribute - Class in net.webpdf.ant.task.xml: An instance of this class stores key, original- and current value of an XML-attribute.
XMLElement - Class in net.webpdf.ant.task.xml: Collects the XML content of an operation tag and provides the means to parse it to a XML String.
XMLElement() - Constructor for class net.webpdf.ant.task.xml.XMLElement: An instance representing a generic XML node.

A C D E F G I L N O P R S T U V W X