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

A

AbstractCatalogManager - Class in org.jboss.jdocbook.xslt.catalog

Basic support for our notion of CatalogManagers.

AbstractCatalogManager(List<String>) - Constructor for class org.jboss.jdocbook.xslt.catalog.AbstractCatalogManager

AbstractDocBookMojo - Class in org.jboss.maven.plugins.jdocbook

Basic support for the various DocBook mojos in this packaging plugin.

AbstractDocBookMojo() - Constructor for class org.jboss.maven.plugins.jdocbook.AbstractDocBookMojo

AbstractDocBookMojo.ArtifactProcessor - Interface in org.jboss.maven.plugins.jdocbook

AbstractDocBookMojo.I18nSource - Interface in org.jboss.maven.plugins.jdocbook

AbstractDocBookMojo.MasterTranslationDescriptor - Class in org.jboss.maven.plugins.jdocbook

AbstractDocBookMojo.MasterTranslationDescriptor(Locale) - Constructor for class org.jboss.maven.plugins.jdocbook.AbstractDocBookMojo.MasterTranslationDescriptor

AbstractDocBookMojo.PublishingSource - Interface in org.jboss.maven.plugins.jdocbook

AbstractDocBookMojo.TranslationDescriptor - Class in org.jboss.maven.plugins.jdocbook

AbstractDocBookMojo.TranslationDescriptor(Locale) - Constructor for class org.jboss.maven.plugins.jdocbook.AbstractDocBookMojo.TranslationDescriptor

accept(File) - Method in class org.jboss.jdocbook.util.VCSDirectoryExclusionFilter

ACCEPT_ALL - Static variable in class org.jboss.jdocbook.util.FileUtils

A filter which simply accepts any file about which it is asked.

addResolver(URIResolver) - Method in class org.jboss.jdocbook.xslt.resolve.ResolverChain

Adds a resolver to the chain.

applyProfiling(File) - Method in interface org.jboss.jdocbook.profile.Profiler

Given a source file, create its profiled equivalent.

archiverManager - Variable in class org.jboss.maven.plugins.jdocbook.AbstractDocBookMojo

INTERNAL : used to get reference to environemtn Archiver/UnArchiver.

attach - Variable in class org.jboss.maven.plugins.jdocbook.AbstractDocBookMojo

Whether or not to perform the attching of the format outputs as classified attachments.

B

BASE_HREF - Static variable in class org.jboss.jdocbook.xslt.resolve.VersionResolver

BasicRenderer - Class in org.jboss.jdocbook.render.impl

The basic implementation of the Renderer contract.

BasicRenderer(Options) - Constructor for class org.jboss.jdocbook.render.impl.BasicRenderer

Construct a renderer instance using the given options.

BasicUrnResolver - Class in org.jboss.jdocbook.xslt.resolve

Basic support for URIResolvers which map a URN unto a single replacement Source.

BasicUrnResolver(String, Source) - Constructor for class org.jboss.jdocbook.xslt.resolve.BasicUrnResolver

Constructs a URIResolver which maps occurences of the given urn onto the given source

buildProfiler() - Method in class org.jboss.jdocbook.profile.ProfilerFactory

Builds a profiler.

buildRenderer(String) - Method in class org.jboss.jdocbook.render.impl.RendererFactory

Build an appropriate renderer for the given formatName

buildResult(File) - Method in class org.jboss.jdocbook.render.impl.BasicRenderer

buildResult(File) - Method in class org.jboss.jdocbook.render.impl.PDFRenderer

buildSAXTransformerFactory() - Method in class org.jboss.jdocbook.util.TransformerType

buildSAXTransformerFactory() - Method in class org.jboss.jdocbook.util.TransformerType.SaxonTransformerType

buildSAXTransformerFactory() - Method in class org.jboss.jdocbook.util.TransformerType.XalanTransformerType

buildStandardTransformer(URL) - Method in class org.jboss.jdocbook.xslt.TransformerBuilder

buildStandardTransformer(String) - Method in class org.jboss.jdocbook.xslt.TransformerBuilder

buildStandardUriResolver() - Method in class org.jboss.jdocbook.xslt.TransformerBuilder

buildTransformer(File, FormatPlan, File) - Method in class org.jboss.jdocbook.render.impl.BasicRenderer

buildTransformer(FormatPlan, URL) - Method in class org.jboss.jdocbook.xslt.TransformerBuilder

buildTransformer(URL, URIResolver) - Method in class org.jboss.jdocbook.xslt.TransformerBuilder

buildTranslation(File, File, File, Options) - Method in class org.jboss.jdocbook.i18n.gettext.TranslationBuilderImpl

buildTranslation(File, File, File, Options) - Method in interface org.jboss.jdocbook.i18n.TranslationBuilder

buildUriResolver(FormatPlan) - Method in class org.jboss.jdocbook.xslt.TransformerBuilder

buildUriResolver(String, String) - Method in class org.jboss.jdocbook.xslt.TransformerBuilder

C

ClasspathResolver - Class in org.jboss.jdocbook.xslt.resolve

Resolves classpath references from the given classloader using classpath:/ as the protocol handler

ClasspathResolver(ClassLoader) - Constructor for class org.jboss.jdocbook.xslt.resolve.ClasspathResolver

ClasspathResolver() - Constructor for class org.jboss.jdocbook.xslt.resolve.ClasspathResolver

CleanPoMojo - Class in org.jboss.maven.plugins.jdocbook

CleanPoMojo implementation

CleanPoMojo() - Constructor for class org.jboss.maven.plugins.jdocbook.CleanPoMojo

CleanPotMojo - Class in org.jboss.maven.plugins.jdocbook

Cleanup the POT files.

CleanPotMojo() - Constructor for class org.jboss.maven.plugins.jdocbook.CleanPotMojo

close() - Method in class org.jboss.jdocbook.util.NoOpWriter

compare(Object, Object) - Method in class org.jboss.jdocbook.util.LocaleUtils.LocaleComparator

CompositeMavenProjectProperties - Class in org.jboss.maven.shared.properties

Presents an consolidated, aggregated view of project properties.

CompositeMavenProjectProperties(MavenProject) - Constructor for class org.jboss.maven.shared.properties.CompositeMavenProjectProperties

configureTransformer(Transformer, FormatPlan) - Method in class org.jboss.jdocbook.xslt.TransformerBuilder

configureTransformer(Transformer, URIResolver, Properties) - Static method in class org.jboss.jdocbook.xslt.TransformerBuilder

Constants - Class in org.jboss.jdocbook.util

Various string constants.

Constants() - Constructor for class org.jboss.jdocbook.util.Constants

createSAXSource(File, EntityResolver, boolean) - Static method in class org.jboss.jdocbook.util.FileUtils

Create a SAXSource from a given file.

cssResource - Variable in class org.jboss.maven.plugins.jdocbook.AbstractDocBookMojo

A Resource describing project-local css.

CurrentVersionResolver - Class in org.jboss.jdocbook.xslt.resolve

Map hrefs starting with http://docbook.sourceforge.net/release/xsl/current/ to classpath resource lookups.

CurrentVersionResolver() - Constructor for class org.jboss.jdocbook.xslt.resolve.CurrentVersionResolver

Constructs a new CurrentVersionResolver instance.

D

DEFAULT_DEFAULT_INCLUDES - Static variable in class org.jboss.maven.shared.resource.ResourceDelegate

determinePoFileName(File) - Static method in class org.jboss.jdocbook.util.I18nUtils

Given a source file (or a POT file), determine its correspnding GNU gettext PO file name.

determinePotFileName(File) - Static method in class org.jboss.jdocbook.util.I18nUtils

Given a source file, determine its correspnding GNU gettext POT file name.

determineRelativity(File, File) - Static method in class org.jboss.jdocbook.util.FileUtils

Determine the 'relativity' of a file in relation to the given basedir.

determineTargetFileName(File) - Method in interface org.jboss.jdocbook.render.format.TargetNamingStrategy

Give a source file, determine the appropriate target file name.

DocBookProfilingStrategy - Class in org.jboss.jdocbook.util

Enumeration of the different strategies defined by the DocBook reference manual for applying profiling.

DocBookProfilingStrategy(String) - Constructor for class org.jboss.jdocbook.util.DocBookProfilingStrategy

doExecute() - Method in class org.jboss.maven.plugins.jdocbook.AbstractDocBookMojo

doExecute() - Method in class org.jboss.maven.plugins.jdocbook.CleanPoMojo

doExecute() - Method in class org.jboss.maven.plugins.jdocbook.CleanPotMojo

doExecute() - Method in class org.jboss.maven.plugins.jdocbook.TranslationMojo

doExecute() - Method in class org.jboss.maven.plugins.jdocbook.UpdatePoMojo

doExecute() - Method in class org.jboss.maven.plugins.jdocbook.UpdatePotMojo

doingChunking - Variable in class org.jboss.jdocbook.render.format.UserFormatConfiguration

DTD_LOADING_FEATURE - Static variable in class org.jboss.jdocbook.util.Constants

The name of the XML DTD loading feature.

DTD_VALIDATION_FEATURE - Static variable in class org.jboss.jdocbook.util.Constants

The name of the XML DTD validation feature.

E

ECLIPSE - Static variable in class org.jboss.jdocbook.render.format.StandardDocBookFormatDescriptors

entrySet() - Method in class org.jboss.maven.shared.properties.CompositeMavenProjectProperties

error(String) - Method in interface org.jboss.jdocbook.Log

error(String, Object...) - Method in interface org.jboss.jdocbook.Log

error(String, Throwable) - Method in interface org.jboss.jdocbook.Log

error(String, Throwable, Object...) - Method in interface org.jboss.jdocbook.Log

execute() - Method in class org.jboss.maven.plugins.jdocbook.AbstractDocBookMojo

execute(String) - Static method in class org.jboss.maven.shared.process.Executor

Shorthand for Executor.execute(String, java.io.OutputStream, java.io.OutputStream) using System.out and System.err for the process's stdout and errout, respectively.

execute(String, OutputStream) - Static method in class org.jboss.maven.shared.process.Executor

Shorthand for Executor.execute(String, java.io.OutputStream, java.io.OutputStream) using System.err for the process's errout and the given out for its stdout.

execute(String, OutputStream, OutputStream) - Static method in class org.jboss.maven.shared.process.Executor

Perform the given cmd as a System call, piping the input of the resulting process to our System.in, its stdout to the given out stream and its errout to the given err stream.

ExecutionException - Exception in org.jboss.maven.shared.process

Used to indicate problems performing an execution (sys call).

ExecutionException(String) - Constructor for exception org.jboss.maven.shared.process.ExecutionException

ExecutionException(String, Throwable) - Constructor for exception org.jboss.maven.shared.process.ExecutionException

Executor - Class in org.jboss.maven.shared.process

Responsible for performing system call executions and coordinating error checking, process I/O, etc.

Executor() - Constructor for class org.jboss.maven.shared.process.Executor

ExplicitCatalogManager - Class in org.jboss.jdocbook.xslt.catalog

Utilizes explicit, user-supplied catalog names to build a CatalogManager.

ExplicitCatalogManager(List<String>) - Constructor for class org.jboss.jdocbook.xslt.catalog.ExplicitCatalogManager

ExplicitCatalogManager(String[]) - Constructor for class org.jboss.jdocbook.xslt.catalog.ExplicitCatalogManager

ExplicitUrnResolver - Class in org.jboss.jdocbook.xslt.resolve

Resolves an explicit urn:docbook:stylesheet URN against the standard DocBook stylesheets.

ExplicitUrnResolver(String, String) - Constructor for class org.jboss.jdocbook.xslt.resolve.ExplicitUrnResolver

F

Factory - Class in org.jboss.jdocbook.i18n

Factory for various i18n components.

FileUtils - Class in org.jboss.jdocbook.util

Various file and directory related utilities.

FileUtils() - Constructor for class org.jboss.jdocbook.util.FileUtils

finalName - Variable in class org.jboss.jdocbook.render.format.UserFormatConfiguration

findLeastRecentTimestamp(File, FileFilter) - Static method in class org.jboss.jdocbook.util.FileUtils

(recursively) find the least recent timestamp in said directory.

findLeastRecentTimestamp(long, File, FileFilter) - Static method in class org.jboss.jdocbook.util.FileUtils

findMostRecentTimestamp(File, FileFilter) - Static method in class org.jboss.jdocbook.util.FileUtils

(recursively) find the most recent timestamp in said directory.

flush() - Method in class org.jboss.jdocbook.util.NoOpWriter

fontsDirectory - Variable in class org.jboss.maven.plugins.jdocbook.AbstractDocBookMojo

The directory containing local fonts

Format - Class in org.jboss.maven.plugins.jdocbook

Maven non-sense.

Format() - Constructor for class org.jboss.maven.plugins.jdocbook.Format

formatName - Variable in class org.jboss.jdocbook.render.format.UserFormatConfiguration

FormatPlan - Class in org.jboss.jdocbook.render.format

Merging of DocBook standard information and user specifics.

FormatPlan(UserFormatConfiguration, StandardDocBookFormatDescriptor) - Constructor for class org.jboss.jdocbook.render.format.FormatPlan

FormatPlan(UserFormatConfiguration, StandardDocBookFormatDescriptor, TargetNamingStrategy) - Constructor for class org.jboss.jdocbook.render.format.FormatPlan

FormatPlan(String, String, String, boolean, boolean, boolean, DocBookProfilingStrategy, TargetNamingStrategy) - Constructor for class org.jboss.jdocbook.render.format.FormatPlan

formats - Variable in class org.jboss.maven.plugins.jdocbook.AbstractDocBookMojo

The formats in which to perform rendering.

G

GenerationMojo - Class in org.jboss.maven.plugins.jdocbook

This mojo's responsibility within the plugin/packaging is actually performing the DocBook transformations.

GenerationMojo() - Constructor for class org.jboss.maven.plugins.jdocbook.GenerationMojo

get(Object) - Method in class org.jboss.maven.shared.properties.CompositeMavenProjectProperties

getAttachableBundle(File) - Method in class org.jboss.jdocbook.render.impl.BasicRenderer

getAttachableBundle(File) - Method in interface org.jboss.jdocbook.render.Renderer

getCatalogResolver() - Method in class org.jboss.jdocbook.Options

getCatalogs() - Method in class org.jboss.jdocbook.Options

getCorrespondingDocBookStylesheetResource() - Method in class org.jboss.jdocbook.render.format.FormatPlan

getDescriptor(String) - Static method in class org.jboss.jdocbook.render.format.StandardDocBookFormatDescriptors

getDocbookVersion() - Method in class org.jboss.jdocbook.Options

getDoingChunking() - Method in class org.jboss.jdocbook.render.format.UserFormatConfiguration

getFinalName() - Method in class org.jboss.jdocbook.render.format.UserFormatConfiguration

getFormatName() - Method in class org.jboss.jdocbook.render.format.UserFormatConfiguration

getI18nSources() - Method in class org.jboss.maven.plugins.jdocbook.AbstractDocBookMojo

getImageCopyingRequired() - Method in class org.jboss.jdocbook.render.format.UserFormatConfiguration

getImagePathSettingRequired() - Method in class org.jboss.jdocbook.render.format.UserFormatConfiguration

getInterpolatedPropertyValue(String, Properties) - Static method in class org.jboss.maven.shared.properties.PropertiesHelper

Retrieves a property value, replacing values like ${token} using the Properties to look them up.

getLocale() - Method in interface org.jboss.maven.plugins.jdocbook.AbstractDocBookMojo.I18nSource

getLocale() - Method in class org.jboss.maven.plugins.jdocbook.AbstractDocBookMojo.MasterTranslationDescriptor

getLocale() - Method in interface org.jboss.maven.plugins.jdocbook.AbstractDocBookMojo.PublishingSource

getLocale() - Method in class org.jboss.maven.plugins.jdocbook.AbstractDocBookMojo.TranslationDescriptor

getLocaleSeparator() - Method in class org.jboss.jdocbook.Options

getLog() - Method in class org.jboss.jdocbook.Options

getMasterTranslationDescriptor() - Method in class org.jboss.maven.plugins.jdocbook.AbstractDocBookMojo

getName() - Method in class org.jboss.jdocbook.render.format.FormatPlan

getName() - Method in interface org.jboss.jdocbook.render.format.StandardDocBookFormatDescriptor

The name of this format.

getName() - Method in class org.jboss.jdocbook.util.DocBookProfilingStrategy

getName() - Method in class org.jboss.jdocbook.util.TransformerType

getPoSynchronizer() - Static method in class org.jboss.jdocbook.i18n.Factory

getPotSynchronizer() - Static method in class org.jboss.jdocbook.i18n.Factory

getProfiledStylesheetResource() - Method in interface org.jboss.jdocbook.render.format.StandardDocBookFormatDescriptor

The standard DocBook stylesheet for this format for 'profiling' (as a classpath-relative resource name).

getProfiling() - Method in class org.jboss.jdocbook.render.format.FormatPlan

getProfilingTypeName() - Method in class org.jboss.jdocbook.render.format.UserFormatConfiguration

getPublishingSources() - Method in class org.jboss.maven.plugins.jdocbook.AbstractDocBookMojo

getRequestedFormat() - Method in class org.jboss.maven.plugins.jdocbook.AbstractDocBookMojo

getRequestedLocale() - Method in class org.jboss.maven.plugins.jdocbook.AbstractDocBookMojo

getSAXTransformerFactory() - Method in class org.jboss.jdocbook.util.TransformerType

getStandardFileExtension() - Method in interface org.jboss.jdocbook.render.format.StandardDocBookFormatDescriptor

The standard file extension used for this format.

getStylesheetResource() - Method in class org.jboss.jdocbook.render.format.FormatPlan

getStylesheetResource() - Method in interface org.jboss.jdocbook.render.format.StandardDocBookFormatDescriptor

The standard DocBook stylesheet for this format (as a classpath-relative resource name).

getStylesheetResource() - Method in class org.jboss.jdocbook.render.format.UserFormatConfiguration

getTargetFileExtension() - Method in class org.jboss.jdocbook.render.format.UserFormatConfiguration

getTargetNamingStrategy() - Method in class org.jboss.jdocbook.render.format.FormatPlan

getTransformerBuilder() - Method in class org.jboss.jdocbook.Options

getTransformerParameters() - Method in class org.jboss.jdocbook.Options

getTranslationBuilder() - Static method in class org.jboss.jdocbook.i18n.Factory

getXmlTransformerType() - Method in class org.jboss.jdocbook.Options

H

HTML - Static variable in class org.jboss.jdocbook.render.format.StandardDocBookFormatDescriptors

HTML_SINGLE - Static variable in class org.jboss.jdocbook.render.format.StandardDocBookFormatDescriptors

HTMLHELP - Static variable in class org.jboss.jdocbook.render.format.StandardDocBookFormatDescriptors

I

I18nUtils - Class in org.jboss.jdocbook.util

Collection of utilities for dealing with i18n support, as defined by GNU gettext.

I18nUtils() - Constructor for class org.jboss.jdocbook.util.I18nUtils

imageCopyingRequired - Variable in class org.jboss.jdocbook.render.format.UserFormatConfiguration

imagePathSettingRequired - Variable in class org.jboss.jdocbook.render.format.UserFormatConfiguration

imageResource - Variable in class org.jboss.maven.plugins.jdocbook.AbstractDocBookMojo

A Resource describing project-local images.

ImplicitCatalogManager - Class in org.jboss.jdocbook.xslt.catalog

CatalogManager which resolves its catalogs internally via classpath resource lookups.

ImplicitCatalogManager() - Constructor for class org.jboss.jdocbook.xslt.catalog.ImplicitCatalogManager

info(String) - Method in interface org.jboss.jdocbook.Log

info(String, Object...) - Method in interface org.jboss.jdocbook.Log

info(String, Throwable) - Method in interface org.jboss.jdocbook.Log

info(String, Throwable, Object...) - Method in interface org.jboss.jdocbook.Log

isDoingChunking() - Method in class org.jboss.jdocbook.render.format.FormatPlan

isDoingChunking() - Method in interface org.jboss.jdocbook.render.format.StandardDocBookFormatDescriptor

Is this format doing chunking?

isImageCopyingRequired() - Method in class org.jboss.jdocbook.render.format.FormatPlan

isImageCopyingRequired() - Method in interface org.jboss.jdocbook.render.format.StandardDocBookFormatDescriptor

Does this format require copying the images over to the target directory?

isImagePathSettingRequired() - Method in class org.jboss.jdocbook.render.format.FormatPlan

isImagePathSettingRequired() - Method in interface org.jboss.jdocbook.render.format.StandardDocBookFormatDescriptor

Does this format require setting the 'img.src.path' DocBook XSLT parameter?

isPotFile(File) - Static method in class org.jboss.jdocbook.util.I18nUtils

Is the given file a GNU gettext POT file?

The determination here is made solely upon the file extension currently.

isUseRelativeImageUris() - Method in class org.jboss.jdocbook.Options

isVCSDirectory(File) - Static method in class org.jboss.jdocbook.util.VCSDirectoryExclusionFilter

isXincludeSupported() - Method in class org.jboss.jdocbook.Options

J

JAVAHELP - Static variable in class org.jboss.jdocbook.render.format.StandardDocBookFormatDescriptors

JDocBookProcessException - Exception in org.jboss.jdocbook

Indicates problem performing JDocBook-related processing.

JDocBookProcessException(String) - Constructor for exception org.jboss.jdocbook.JDocBookProcessException

JDocBookProcessException(String, Throwable) - Constructor for exception org.jboss.jdocbook.JDocBookProcessException

L

loadPropertyFile(File) - Static method in class org.jboss.maven.shared.properties.PropertiesHelper

Reads a property file, resolving all internal variables.

LOCALE_COMPARATOR_INST - Static variable in class org.jboss.jdocbook.util.LocaleUtils

LocaleUtils - Class in org.jboss.jdocbook.util

Collection of utlities for dealing with locales.

LocaleUtils() - Constructor for class org.jboss.jdocbook.util.LocaleUtils

LocaleUtils.LocaleComparator - Class in org.jboss.jdocbook.util

LocaleUtils.LocaleComparator() - Constructor for class org.jboss.jdocbook.util.LocaleUtils.LocaleComparator

locateInclusions(File) - Static method in class org.jboss.jdocbook.util.XIncludeHelper

Given a file which defining an XML document containing XInclude elements, collect all the referenced XInclude files.

locateResource(String) - Static method in class org.jboss.jdocbook.util.ResourceHelper

Locate said resource.

Log - Interface in org.jboss.jdocbook

A general 'log bridge' contract.

M

MAIN_PROFILE_XSL_RESOURCE - Static variable in class org.jboss.jdocbook.util.Constants

The DocBook-supplied XSL for profiling in (what it terms) the two-pass approach.

MAN - Static variable in class org.jboss.jdocbook.render.format.StandardDocBookFormatDescriptors

masterTranslation - Variable in class org.jboss.maven.plugins.jdocbook.AbstractDocBookMojo

The locale of the master translation.

N

NONE - Static variable in class org.jboss.jdocbook.util.DocBookProfilingStrategy

NoOpWriter - Class in org.jboss.jdocbook.util

A writer which does no writing :)

NoOpWriter() - Constructor for class org.jboss.jdocbook.util.NoOpWriter

O

Options - Class in org.jboss.jdocbook

A (detachable) representation of the user configuration.

Options() - Constructor for class org.jboss.jdocbook.Options

Options(char) - Constructor for class org.jboss.jdocbook.Options

Options(boolean, String[], String, Properties, boolean, String, char) - Constructor for class org.jboss.jdocbook.Options

options - Variable in class org.jboss.jdocbook.render.impl.BasicRenderer

options - Variable in class org.jboss.maven.plugins.jdocbook.AbstractDocBookMojo

Configurable options

Options - Class in org.jboss.maven.plugins.jdocbook

Maven non-sense.

Options() - Constructor for class org.jboss.maven.plugins.jdocbook.Options

org.jboss.jdocbook - package org.jboss.jdocbook

org.jboss.jdocbook.i18n - package org.jboss.jdocbook.i18n

org.jboss.jdocbook.i18n.gettext - package org.jboss.jdocbook.i18n.gettext

org.jboss.jdocbook.profile - package org.jboss.jdocbook.profile

org.jboss.jdocbook.render - package org.jboss.jdocbook.render

org.jboss.jdocbook.render.format - package org.jboss.jdocbook.render.format

org.jboss.jdocbook.render.impl - package org.jboss.jdocbook.render.impl

org.jboss.jdocbook.util - package org.jboss.jdocbook.util

org.jboss.jdocbook.xslt - package org.jboss.jdocbook.xslt

org.jboss.jdocbook.xslt.catalog - package org.jboss.jdocbook.xslt.catalog

org.jboss.jdocbook.xslt.resolve - package org.jboss.jdocbook.xslt.resolve

org.jboss.maven.plugins.jdocbook - package org.jboss.maven.plugins.jdocbook

org.jboss.maven.shared.process - package org.jboss.maven.shared.process

org.jboss.maven.shared.properties - package org.jboss.maven.shared.properties

org.jboss.maven.shared.resource - package org.jboss.maven.shared.resource

P

PackageMojo - Class in org.jboss.maven.plugins.jdocbook

This mojo's responsibility within the plugin/packaging is to bundle the individual formats into deployable formats.

PackageMojo() - Constructor for class org.jboss.maven.plugins.jdocbook.PackageMojo

parse(String) - Static method in class org.jboss.jdocbook.util.DocBookProfilingStrategy

parse(String) - Static method in class org.jboss.jdocbook.util.LocaleUtils

parse(String, char) - Static method in class org.jboss.jdocbook.util.LocaleUtils

parse(String) - Static method in class org.jboss.jdocbook.util.TransformerType

parseLocale(String) - Method in class org.jboss.maven.plugins.jdocbook.AbstractDocBookMojo

PDF - Static variable in class org.jboss.jdocbook.render.format.StandardDocBookFormatDescriptors

PDFRenderer - Class in org.jboss.jdocbook.render.impl

Implementation of the Renderer contract specifically for dealing with PDF generation.

PDFRenderer(Options) - Constructor for class org.jboss.jdocbook.render.impl.PDFRenderer

PLUGIN_NAME - Static variable in class org.jboss.maven.plugins.jdocbook.AbstractDocBookMojo

pluginArtifacts - Variable in class org.jboss.maven.plugins.jdocbook.AbstractDocBookMojo

INTERNAL : The artifacts associated to the dependencies defined as part of our configuration within the project to which we are being attached.

PoSynchronizer - Interface in org.jboss.jdocbook.i18n

Contract for synchronizing (creating/updating) PortableObject (PO) file(s) for a given translation corresponding to the POT templates in the given POT-directory.

PoSynchronizerImpl - Class in org.jboss.jdocbook.i18n.gettext

Implementation of the PoSynchronizer contract based on system calls to either the 'msgmerge' or the 'msginit' commands (both part of the GNU gettext package).

PoSynchronizerImpl() - Constructor for class org.jboss.jdocbook.i18n.gettext.PoSynchronizerImpl

potDirectory - Variable in class org.jboss.maven.plugins.jdocbook.AbstractDocBookMojo

The directory for POT translations files.

PotSynchronizer - Interface in org.jboss.jdocbook.i18n

Contract for synchronizing (creating/updating) PortableObjectTemplate (POT) file(s) from a given master source file.

PotSynchronizerImpl - Class in org.jboss.jdocbook.i18n.gettext

Implementation of the PotSynchronizer contract based on system calls to the xml2pot command (part of the KDE poxml package).

PotSynchronizerImpl() - Constructor for class org.jboss.jdocbook.i18n.gettext.PotSynchronizerImpl

process(Artifact) - Method in interface org.jboss.maven.plugins.jdocbook.AbstractDocBookMojo.ArtifactProcessor

process(FormatPlan[]) - Method in class org.jboss.maven.plugins.jdocbook.AbstractDocBookMojo

The override method to perform the actual processing of the mojo.

process(FormatPlan[]) - Method in class org.jboss.maven.plugins.jdocbook.GenerationMojo

process(FormatPlan[]) - Method in class org.jboss.maven.plugins.jdocbook.PackageMojo

The override method to perform the actual processing of the mojo.

process(FormatPlan[]) - Method in class org.jboss.maven.plugins.jdocbook.ResourceMojo

process(Resource[]) - Method in class org.jboss.maven.shared.resource.ResourceDelegate

process(Resource) - Method in class org.jboss.maven.shared.resource.ResourceDelegate

processArtifacts(AbstractDocBookMojo.ArtifactProcessor) - Method in class org.jboss.maven.plugins.jdocbook.AbstractDocBookMojo

processDependencySupportArtifact(File, File) - Method in class org.jboss.maven.plugins.jdocbook.ResourceMojo

ProcessOutputManager - Class in org.jboss.maven.shared.process

ProcessOutputManager implementation

ProcessOutputManager(Process, OutputStream, OutputStream) - Constructor for class org.jboss.maven.shared.process.ProcessOutputManager

processPluginArtifacts(AbstractDocBookMojo.ArtifactProcessor) - Method in class org.jboss.maven.plugins.jdocbook.AbstractDocBookMojo

processProjectArtifacts(AbstractDocBookMojo.ArtifactProcessor) - Method in class org.jboss.maven.plugins.jdocbook.AbstractDocBookMojo

Profiler - Interface in org.jboss.jdocbook.profile

Contract for applying DocBook profiling based on the approach they term 'two-pass'.

ProfilerFactory - Class in org.jboss.jdocbook.profile

A factory for Profiler instances.

ProfilerFactory(File, Options) - Constructor for class org.jboss.jdocbook.profile.ProfilerFactory

Constructs a factory capable of producing Profiler instances writing to the given directory.

profilingTypeName - Variable in class org.jboss.jdocbook.render.format.UserFormatConfiguration

project - Variable in class org.jboss.maven.plugins.jdocbook.AbstractDocBookMojo

INTERNAL : The project being built

projectArtifacts - Variable in class org.jboss.maven.plugins.jdocbook.AbstractDocBookMojo

INTERNAL : The artifacts associated with the dependencies defined as part of the project to which we are being attached.

projectHelper - Variable in class org.jboss.maven.plugins.jdocbook.AbstractDocBookMojo

INTERNAL : used during packaging to attach produced artifacts

PropertiesException - Exception in org.jboss.maven.shared.properties

Some problem processing Properties.

PropertiesException(String) - Constructor for exception org.jboss.maven.shared.properties.PropertiesException

PropertiesException(String, Throwable) - Constructor for exception org.jboss.maven.shared.properties.PropertiesException

PropertiesHelper - Class in org.jboss.maven.shared.properties

Utilities for dealing with @{link Properties} objects.

publishDirectory - Variable in class org.jboss.maven.plugins.jdocbook.AbstractDocBookMojo

The directory where the output will be written.

R

RelativeJarUriResolver - Class in org.jboss.jdocbook.xslt.resolve

Responsible for resolving relative references from jar base urls.

RelativeJarUriResolver() - Constructor for class org.jboss.jdocbook.xslt.resolve.RelativeJarUriResolver

relativeMasterTranslationPath - Variable in class org.jboss.maven.plugins.jdocbook.AbstractDocBookMojo

The path (relative to the sourceDirectory) to the directory containing the master sources.

releaseResult(Result) - Method in class org.jboss.jdocbook.render.impl.BasicRenderer

releaseResult(Result) - Method in class org.jboss.jdocbook.render.impl.PDFRenderer

render(File, FormatPlan, File, File) - Method in class org.jboss.jdocbook.render.impl.BasicRenderer

Performs the actual rendering or transforming of the DocBook sources into the respective output format.

render(File, FormatPlan, File, File) - Method in interface org.jboss.jdocbook.render.Renderer

Performs the actual rendering or transforming of the DocBook sources into the respective output format.

render(Locale, char) - Static method in class org.jboss.jdocbook.util.LocaleUtils

Renderer - Interface in org.jboss.jdocbook.render

Renderer contract

RendererFactory - Class in org.jboss.jdocbook.render.impl

A factory for building Renderer instances.

RendererFactory(Options) - Constructor for class org.jboss.jdocbook.render.impl.RendererFactory

RenderingException - Exception in org.jboss.jdocbook.render

Indicates issues performing rendering.

RenderingException(String) - Constructor for exception org.jboss.jdocbook.render.RenderingException

RenderingException(String, Throwable) - Constructor for exception org.jboss.jdocbook.render.RenderingException

requireResource(String) - Static method in class org.jboss.jdocbook.util.ResourceHelper

Locate said resource, throwing an exception if it could not be found.

resolve(String, String) - Method in class org.jboss.jdocbook.xslt.resolve.BasicUrnResolver

resolve(String, String) - Method in class org.jboss.jdocbook.xslt.resolve.ClasspathResolver

resolve(String, String) - Method in class org.jboss.jdocbook.xslt.resolve.RelativeJarUriResolver

resolve(String, String) - Method in class org.jboss.jdocbook.xslt.resolve.ResolverChain

Here we iterate over all the chained resolvers and delegate to them until we find one which can handle the resolve request (if any).

resolve(String, String) - Method in class org.jboss.jdocbook.xslt.resolve.VersionResolver

resolveDocumentFile() - Method in class org.jboss.maven.plugins.jdocbook.AbstractDocBookMojo.MasterTranslationDescriptor

resolveDocumentFile() - Method in interface org.jboss.maven.plugins.jdocbook.AbstractDocBookMojo.PublishingSource

resolveDocumentFile() - Method in class org.jboss.maven.plugins.jdocbook.AbstractDocBookMojo.TranslationDescriptor

resolveFullPathName(File) - Static method in class org.jboss.jdocbook.util.FileUtils

Here for consistent handling of full path names.

resolvePoDirectory() - Method in interface org.jboss.maven.plugins.jdocbook.AbstractDocBookMojo.I18nSource

resolvePoDirectory() - Method in class org.jboss.maven.plugins.jdocbook.AbstractDocBookMojo.TranslationDescriptor

resolvePublishingDirectory() - Method in class org.jboss.maven.plugins.jdocbook.AbstractDocBookMojo.MasterTranslationDescriptor

resolvePublishingDirectory() - Method in interface org.jboss.maven.plugins.jdocbook.AbstractDocBookMojo.PublishingSource

resolvePublishingDirectory() - Method in class org.jboss.maven.plugins.jdocbook.AbstractDocBookMojo.TranslationDescriptor

ResolverChain - Class in org.jboss.jdocbook.xslt.resolve

Allows chaining a series of resolvers together.

ResolverChain() - Constructor for class org.jboss.jdocbook.xslt.resolve.ResolverChain

ResolverChain(URIResolver) - Constructor for class org.jboss.jdocbook.xslt.resolve.ResolverChain

resolveTranslatedXmlDirectory() - Method in interface org.jboss.maven.plugins.jdocbook.AbstractDocBookMojo.I18nSource

resolveTranslatedXmlDirectory() - Method in class org.jboss.maven.plugins.jdocbook.AbstractDocBookMojo.TranslationDescriptor

resolveXmlTransformerType() - Method in class org.jboss.jdocbook.Options

ResourceDelegate - Class in org.jboss.maven.shared.resource

A delegate for handling Resource resolution.

ResourceDelegate(MavenProject, File, Log) - Constructor for class org.jboss.maven.shared.resource.ResourceDelegate

Constructs a Delegate instance for handling Resource resolution.

ResourceDelegate(MavenProject, File, String[], String[], Log) - Constructor for class org.jboss.maven.shared.resource.ResourceDelegate

Constructs a Delegate instance for handling Resource resolution.

ResourceException - Exception in org.jboss.maven.shared.resource

Some problem processing resource definitions.

ResourceException(String) - Constructor for exception org.jboss.maven.shared.resource.ResourceException

ResourceException(String, Throwable) - Constructor for exception org.jboss.maven.shared.resource.ResourceException

ResourceHelper - Class in org.jboss.jdocbook.util

Simple helpers for locating and handling classpath and file URL resource lookups.

ResourceHelper() - Constructor for class org.jboss.jdocbook.util.ResourceHelper

ResourceMojo - Class in org.jboss.maven.plugins.jdocbook

This mojo's responsibility within the plugin/packaging is to process resources defined by various inputs, moving them into a staging directory for use during XSLT processing.

ResourceMojo() - Constructor for class org.jboss.maven.plugins.jdocbook.ResourceMojo

run() - Method in class org.jboss.maven.shared.process.StreamBridge

S

SAXON - Static variable in class org.jboss.jdocbook.util.TransformerType

session - Variable in class org.jboss.maven.plugins.jdocbook.AbstractDocBookMojo

INTERNAL : The representation of the maven execution.

setDocbookVersion(String) - Method in class org.jboss.jdocbook.Options

setLog(Log) - Method in class org.jboss.jdocbook.Options

SINGLE_PASS - Static variable in class org.jboss.jdocbook.util.DocBookProfilingStrategy

sourceDirectory - Variable in class org.jboss.maven.plugins.jdocbook.AbstractDocBookMojo

The directory where the sources are located.

sourceDocumentName - Variable in class org.jboss.maven.plugins.jdocbook.AbstractDocBookMojo

The name of the document (relative to sourceDirectory) which is the document to be rendered.

stagingDirectory - Variable in class org.jboss.maven.plugins.jdocbook.AbstractDocBookMojo

The directory where we can perform some staging staging occurs.

StandardDocBookFormatDescriptor - Interface in org.jboss.jdocbook.render.format

Contract for descriptors about standard DocBook formats.

StandardDocBookFormatDescriptors - Class in org.jboss.jdocbook.render.format

Descriptors of the bundled DocBook styles in which we are interested.

stop() - Method in class org.jboss.maven.shared.process.ProcessOutputManager

StreamBridge - Class in org.jboss.maven.shared.process

Bridges an input stream to an output stream.

StreamBridge(InputStream, OutputStream) - Constructor for class org.jboss.maven.shared.process.StreamBridge

StreamBridge(InputStream, OutputStream, int) - Constructor for class org.jboss.maven.shared.process.StreamBridge

stringify(Locale) - Method in class org.jboss.maven.plugins.jdocbook.AbstractDocBookMojo

stylesheetResource - Variable in class org.jboss.jdocbook.render.format.UserFormatConfiguration

synchronizePo(File, File, Locale, Options) - Method in class org.jboss.jdocbook.i18n.gettext.PoSynchronizerImpl

Perform the synchronization on the the PO files.

synchronizePo(File, File, Locale, Options) - Method in interface org.jboss.jdocbook.i18n.PoSynchronizer

Perform the synchronization on the the PO files.

synchronizePot(File, File, Options) - Method in class org.jboss.jdocbook.i18n.gettext.PotSynchronizerImpl

Perform the synchronization on the the POT files pertaining to the given master DocBook source.

synchronizePot(File, File, Options) - Method in interface org.jboss.jdocbook.i18n.PotSynchronizer

Perform the synchronization on the the POT files pertaining to the given master DocBook source.

T

targetFileExtension - Variable in class org.jboss.jdocbook.render.format.UserFormatConfiguration

TargetNamingStrategy - Interface in org.jboss.jdocbook.render.format

Strategy for naming target files based on the source file.

toString() - Method in class org.jboss.jdocbook.xslt.resolve.BasicUrnResolver

toString() - Method in class org.jboss.jdocbook.xslt.resolve.ExplicitUrnResolver

toString() - Method in class org.jboss.jdocbook.xslt.resolve.VersionResolver

trace(String) - Method in interface org.jboss.jdocbook.Log

trace(String, Object...) - Method in interface org.jboss.jdocbook.Log

TransformerBuilder - Class in org.jboss.jdocbook.xslt

A builder of Transformer instances, configurable to return either SAXON or XALAN based transformers.

TransformerBuilder(Options) - Constructor for class org.jboss.jdocbook.xslt.TransformerBuilder

TransformerType - Class in org.jboss.jdocbook.util

Enumeration of supported XSLT transformers.

TransformerType.SaxonTransformerType - Class in org.jboss.jdocbook.util

The SAXON transformer type...

TransformerType.SaxonTransformerType() - Constructor for class org.jboss.jdocbook.util.TransformerType.SaxonTransformerType

TransformerType.XalanTransformerType - Class in org.jboss.jdocbook.util

TransformerType.XalanTransformerType() - Constructor for class org.jboss.jdocbook.util.TransformerType.XalanTransformerType

translationBaseDirectory - Variable in class org.jboss.maven.plugins.jdocbook.AbstractDocBookMojo

The directory which contains the translations.

TranslationBuilder - Interface in org.jboss.jdocbook.i18n

Contract for applying the translators work (PO file) back into XML in preparation for XSLT processing.

TranslationBuilderImpl - Class in org.jboss.jdocbook.i18n.gettext

Implementation of the TranslationBuilder contract based on system calls to the 'po2xml' command (part of the KDE poxml package).

TranslationBuilderImpl() - Constructor for class org.jboss.jdocbook.i18n.gettext.TranslationBuilderImpl

TranslationMojo - Class in org.jboss.maven.plugins.jdocbook

Responsible for translating the DocBook source based on the translator's PO files.

TranslationMojo() - Constructor for class org.jboss.maven.plugins.jdocbook.TranslationMojo

translations - Variable in class org.jboss.maven.plugins.jdocbook.AbstractDocBookMojo

The locales of all non-master translations.

TWO_PASS - Static variable in class org.jboss.jdocbook.util.DocBookProfilingStrategy

U

UpdatePoMojo - Class in org.jboss.maven.plugins.jdocbook

UpdatePoMojo implementationslatable strings from the master translation source into the POT files.

UpdatePoMojo() - Constructor for class org.jboss.maven.plugins.jdocbook.UpdatePoMojo

UpdatePotMojo - Class in org.jboss.maven.plugins.jdocbook

Manages pushing translatable strings from the master translation source into the POT files.

UpdatePotMojo() - Constructor for class org.jboss.maven.plugins.jdocbook.UpdatePotMojo

UserFormatConfiguration - Class in org.jboss.jdocbook.render.format

Models configuration choices of a user in regards to a particular rendering format.

UserFormatConfiguration() - Constructor for class org.jboss.jdocbook.render.format.UserFormatConfiguration

Do not use! Needed by Maven :(

UserFormatConfiguration(String, String, String, String, Boolean, Boolean, Boolean, String) - Constructor for class org.jboss.jdocbook.render.format.UserFormatConfiguration

V

VCSDirectoryExclusionFilter - Class in org.jboss.jdocbook.util

A FileFilter which excludes VCS metadata directories...

VCSDirectoryExclusionFilter() - Constructor for class org.jboss.jdocbook.util.VCSDirectoryExclusionFilter

VersionResolver - Class in org.jboss.jdocbook.xslt.resolve

Maps docbook-version based URIs to local classpath lookups.

VersionResolver(String) - Constructor for class org.jboss.jdocbook.xslt.resolve.VersionResolver

Constructs a VersionResolver instance using the given version.

W

WEBSITE - Static variable in class org.jboss.jdocbook.render.format.StandardDocBookFormatDescriptors

workDirectory - Variable in class org.jboss.maven.plugins.jdocbook.AbstractDocBookMojo

A directory used for general transient work.

write(char[], int, int) - Method in class org.jboss.jdocbook.util.NoOpWriter

X

XALAN - Static variable in class org.jboss.jdocbook.util.TransformerType

XHTML - Static variable in class org.jboss.jdocbook.render.format.StandardDocBookFormatDescriptors

XIncludeHelper - Class in org.jboss.jdocbook.util

A helper for dealing with XIncludes.

XIncludeHelper() - Constructor for class org.jboss.jdocbook.util.XIncludeHelper

XSLTException - Exception in org.jboss.jdocbook.xslt

Indicates problems either building XSLT transformers or performing transformations.

XSLTException(String) - Constructor for exception org.jboss.jdocbook.xslt.XSLTException

XSLTException(String, Throwable) - Constructor for exception org.jboss.jdocbook.xslt.XSLTException

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