Skip navigation links
A C D E F G I O S T U V W X 

A

AbstractVerifyMojo - Class in org.xwiki.tool.xar
Common code for the Verify and Format Mojos.
AbstractVerifyMojo() - Constructor for class org.xwiki.tool.xar.AbstractVerifyMojo
 
AUTHOR - Static variable in class org.xwiki.tool.xar.AbstractVerifyMojo
Admin author for creator/contentAuthor and author.

C

commonsVersion - Variable in class org.xwiki.tool.xar.AbstractVerifyMojo
The Commons version to be used by this mojo.
contentPages - Variable in class org.xwiki.tool.xar.AbstractVerifyMojo
Explicitly define a list of pages (it's a regex) that should be considered as content pages (rather than technical pages which is the default).

D

defaultLanguage - Variable in class org.xwiki.tool.xar.AbstractVerifyMojo
The language in which non-translated documents are written in.

E

execute() - Method in class org.xwiki.tool.xar.FormatMojo
 
execute() - Method in class org.xwiki.tool.xar.UnXARMojo
 
execute() - Method in class org.xwiki.tool.xar.VerifyMojo
 
execute() - Method in class org.xwiki.tool.xar.XARMojo
 
executeLicenseGoal(String) - Method in class org.xwiki.tool.xar.AbstractVerifyMojo
Executes a goal of the Maven License plugin (used for adding or checking for license headers.

F

force - Variable in class org.xwiki.tool.xar.AbstractVerifyMojo
If true then don't check if the packaging is XAR before running mojos.
formatLicense - Variable in class org.xwiki.tool.xar.AbstractVerifyMojo
If true then check for cliense and add a license header to XML files.
FormatMojo - Class in org.xwiki.tool.xar
Pretty prints and set valid authors and version to XAR XML files.
FormatMojo() - Constructor for class org.xwiki.tool.xar.FormatMojo
 

G

getAction() - Method in class org.xwiki.tool.xar.Transformation
 
getArtifact() - Method in class org.xwiki.tool.xar.Transformation
 
getCharset() - Method in class org.xwiki.tool.xar.Transformation
 
getContent() - Method in class org.xwiki.tool.xar.Transformation
 
getDocument() - Method in class org.xwiki.tool.xar.XAREntry
 
getDocumentNamesFromXML(File) - Static method in class org.xwiki.tool.xar.XARMojo
Gets the list of document names from a 'package.xml'-like document.
getDocumentNamesFromXML(InputStream) - Static method in class org.xwiki.tool.xar.XARMojo
 
getFile() - Method in class org.xwiki.tool.xar.Transformation
 
getType() - Method in class org.xwiki.tool.xar.XAREntry
 
getValue() - Method in class org.xwiki.tool.xar.Transformation
 
getXarEntriesMapFromXML(File) - Static method in class org.xwiki.tool.xar.XARMojo
Gets the list of entry from a 'package.xml'-like document.
getXarEntriesMapFromXML(InputStream) - Static method in class org.xwiki.tool.xar.XARMojo
Gets the list of entry from a 'package.xml'-like document.
getXARXMLFiles() - Method in class org.xwiki.tool.xar.AbstractVerifyMojo
 
getXml() - Method in class org.xwiki.tool.xar.Transformation
 
getXpath() - Method in class org.xwiki.tool.xar.Transformation
 
getXWikiCommonsVersion() - Method in class org.xwiki.tool.xar.AbstractVerifyMojo
 
guessDefaultLanguage(File, Collection<File>) - Method in class org.xwiki.tool.xar.AbstractVerifyMojo
Guess the &lt;defaultLanguage&gt; value to use for the passed file using the following algorithm: If the page name matches one of the regexes defined by the user as a translated page, then check that the default language is AbstractVerifyMojo.defaultLanguage. Otherwise, if the page name matches one of the regexes defined by the user as a content page, then check that the default language is AbstractVerifyMojo.defaultLanguage. Otherwise, if there's no other translation of the file then check that the default language is empty since it's a technical page. Otherwise, if there are other translations ("(prefix).(language).xml" format) then check that the default language should is AbstractVerifyMojo.defaultLanguage

I

initializePatterns() - Method in class org.xwiki.tool.xar.AbstractVerifyMojo
Initialize regex Patterns for performance reasons.
initializePatterns() - Method in class org.xwiki.tool.xar.VerifyMojo
 
isContentPage(String) - Method in class org.xwiki.tool.xar.AbstractVerifyMojo
 
isTranslatablePage(String) - Method in class org.xwiki.tool.xar.AbstractVerifyMojo
 
isVisibleTechnicalPage(String) - Method in class org.xwiki.tool.xar.AbstractVerifyMojo
 

O

org.xwiki.tool.xar - package org.xwiki.tool.xar
 

S

setAction(Transformation.Action) - Method in class org.xwiki.tool.xar.Transformation
 
setArtifact(String) - Method in class org.xwiki.tool.xar.Transformation
 
setCharset(String) - Method in class org.xwiki.tool.xar.Transformation
 
setContent(File) - Method in class org.xwiki.tool.xar.Transformation
 
setDocument(String) - Method in class org.xwiki.tool.xar.XAREntry
 
setFile(String) - Method in class org.xwiki.tool.xar.Transformation
 
setType(String) - Method in class org.xwiki.tool.xar.XAREntry
 
setValue(String) - Method in class org.xwiki.tool.xar.Transformation
 
setVersion(String) - Method in class org.xwiki.tool.xar.XWikiXMLWriter
 
setXml(File) - Method in class org.xwiki.tool.xar.Transformation
 
setXpath(String) - Method in class org.xwiki.tool.xar.Transformation
 
skipDates - Variable in class org.xwiki.tool.xar.AbstractVerifyMojo
Disables the check for the existence of the date fields.
skipDatesDocumentList - Variable in class org.xwiki.tool.xar.AbstractVerifyMojo
Disables the check for the existence of the date fields.

T

Transformation - Class in org.xwiki.tool.xar
Hold Transformation configuration as specified by the user in its pom.xml.
Transformation() - Constructor for class org.xwiki.tool.xar.Transformation
 
Transformation.Action - Enum in org.xwiki.tool.xar
The action to apply.
translatablePages - Variable in class org.xwiki.tool.xar.AbstractVerifyMojo
Explicitly define a list of pages (it's a regex) that can have translations and thus which must have a default language not empty.

U

unpackDependentXars(Artifact) - Method in class org.xwiki.tool.xar.UnXARMojo
Unpack xar dependencies of the provided artifact.
UnXARMojo - Class in org.xwiki.tool.xar
Expand a XAR file.
UnXARMojo() - Constructor for class org.xwiki.tool.xar.UnXARMojo
 

V

valueOf(String) - Static method in enum org.xwiki.tool.xar.Transformation.Action
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.xwiki.tool.xar.Transformation.Action
Returns an array containing the constants of this enum type, in the order they are declared.
VerifyMojo - Class in org.xwiki.tool.xar
Perform various verifications of the XAR files in this project.
VerifyMojo() - Constructor for class org.xwiki.tool.xar.VerifyMojo
 
VERSION - Static variable in class org.xwiki.tool.xar.AbstractVerifyMojo
First version.
visibleTechnicalPages - Variable in class org.xwiki.tool.xar.AbstractVerifyMojo
Explicitly define a list of pages (it's a regex) that are technical pages but that should be visible (not hidden).

W

writeComment(String) - Method in class org.xwiki.tool.xar.XWikiXMLWriter
 
writeDeclaration() - Method in class org.xwiki.tool.xar.XWikiXMLWriter
 
writeNodeText(Node) - Method in class org.xwiki.tool.xar.XWikiXMLWriter
 
writePrintln() - Method in class org.xwiki.tool.xar.XWikiXMLWriter
 

X

XAREntry - Class in org.xwiki.tool.xar
Properties to apply to a XAR entry.
XAREntry() - Constructor for class org.xwiki.tool.xar.XAREntry
 
XARMojo - Class in org.xwiki.tool.xar
Gather all resources in a XAR file (which is actually a ZIP file).
XARMojo() - Constructor for class org.xwiki.tool.xar.XARMojo
 
XWikiXMLWriter - Class in org.xwiki.tool.xar
Custom XML Writer to support XWiki's code style for XAR XML files.
XWikiXMLWriter(OutputStream) - Constructor for class org.xwiki.tool.xar.XWikiXMLWriter
 
XWikiXMLWriter(OutputStream, OutputFormat) - Constructor for class org.xwiki.tool.xar.XWikiXMLWriter
 
A C D E F G I O S T U V W X 
Skip navigation links

Copyright © 2004–2021 XWiki. All rights reserved.