Index

A B C D E F G H I L O P Q R S T
All Classes and Interfaces|All Packages

A

AbstractPGXS - Class in org.postgresql.pljava.pgxs

Class to act as a blueprint for platform-specific build configurations in a pom.xml.

AbstractPGXS() - Constructor for class org.postgresql.pljava.pgxs.AbstractPGXS

asPath(FileObject) - Method in class org.postgresql.pljava.pgxs.RelativizingFileManager

B

buildPaths(List<String>) - Method in class org.postgresql.pljava.pgxs.PGXSUtils

Returns a two-element map with with classpath and modulepath as keys and their joined string paths as the respective values.

C

canGenerateReport() - Method in class org.postgresql.pljava.pgxs.ReportScriptingMojo

Queries the script as to whether this report can be generated.

canGenerateReport(ReportScriptingMojo) - Method in interface org.postgresql.pljava.pgxs.ReportScript

canGenerateReportDefault() - Method in class org.postgresql.pljava.pgxs.ReportScriptingMojo

Default implementation of ReportScript.canGenerateReport(ReportScriptingMojo).

compile(String, List<String>, Path, List<String>, Map<String, String>, List<String>) - Method in class org.postgresql.pljava.pgxs.AbstractPGXS

Performs platform-specific compilation of a set of .c files with the specified compiler, target path, includes, defines, and flags.

D

defaultCharsetDecodeStrict(byte[]) - Method in class org.postgresql.pljava.pgxs.PGXSUtils

Returns the string decoded from input bytes using default platform charset.

E

exceptionWrap(Object) - Method in class org.postgresql.pljava.pgxs.ReportScriptingMojo

Wraps the input object in a MavenReportException.

exceptionWrap(Object, boolean) - Method in class org.postgresql.pljava.pgxs.ScriptingMojo

Wraps the input object in an AbstractMojoExecutionException.

execute() - Method in interface org.postgresql.pljava.pgxs.GoalScript

Executes the driver code for running the script.

execute() - Method in class org.postgresql.pljava.pgxs.ScriptingMojo

Executes the script code inside the script tag in the plugin configuration.

executeReport(Locale) - Method in class org.postgresql.pljava.pgxs.ReportScriptingMojo

executeReport(ReportScriptingMojo, Locale) - Method in interface org.postgresql.pljava.pgxs.ReportScript

F

findClass(String) - Method in class org.postgresql.pljava.pgxs.ScriptEngineLoader

Delegate to the Maven-supplied loader.

findResource(String) - Method in class org.postgresql.pljava.pgxs.ScriptEngineLoader

Delegate to the Maven-supplied loader for finding a resource.

findResources(String) - Method in class org.postgresql.pljava.pgxs.ScriptEngineLoader

Delegate to the Maven-supplied loader for finding a resource.

formatDefines(Map<String, String>) - Method in class org.postgresql.pljava.pgxs.AbstractPGXS

Returns a list with all defines represented correctly.

formatIncludes(List<String>) - Method in class org.postgresql.pljava.pgxs.AbstractPGXS

Returns a list with all items prefixed with correct include flag symbol.

forWindowsCRuntime(ProcessBuilder) - Method in class org.postgresql.pljava.pgxs.PGXSUtils

Adjust the command arguments of a ProcessBuilder so that they will be recovered correctly on Windows by a target C/C++ program using the argument parsing algorithm of the usual C run-time code, when it is known that the command will not be handled first by cmd.

G

getCategoryName() - Method in class org.postgresql.pljava.pgxs.ReportScriptingMojo

Queries the script for the category name of this report, used by Maven to place the report under the correct heading in index.html.

getCategoryName(ReportScriptingMojo) - Method in interface org.postgresql.pljava.pgxs.ReportScript

getCategoryNameDefault() - Method in class org.postgresql.pljava.pgxs.ReportScriptingMojo

Default implementation of ReportScript.getCategoryName(ReportScriptingMojo).

getDescription(Locale) - Method in class org.postgresql.pljava.pgxs.ReportScriptingMojo

Queries the script for the description of this report, to be used by Maven for display in index.html.

getDescription(ReportScriptingMojo, Locale) - Method in interface org.postgresql.pljava.pgxs.ReportScript

getFileForOutput(JavaFileManager.Location, String, String, FileObject) - Method in class org.postgresql.pljava.pgxs.RelativizingFileManager

Overridden to return the superclass result unchanged unless the requested file is of kind HTML, and in that case to return a file object that will interpose on the OutputStream and apply the rewriting.

getFilesWithExtension(Path, String) - Method in class org.postgresql.pljava.pgxs.PGXSUtils

Returns a list of files with given extension in and below the input directory.

getInputEncoding() - Method in class org.postgresql.pljava.pgxs.ReportScriptingMojo

getJavaFileObjects(File...) - Method in class org.postgresql.pljava.pgxs.RelativizingFileManager

getJavaFileObjects(String...) - Method in class org.postgresql.pljava.pgxs.RelativizingFileManager

getJavaFileObjects(Path...) - Method in class org.postgresql.pljava.pgxs.RelativizingFileManager

getJavaFileObjectsFromFiles(Iterable<? extends File>) - Method in class org.postgresql.pljava.pgxs.RelativizingFileManager

getJavaFileObjectsFromPaths(Iterable<? extends Path>) - Method in class org.postgresql.pljava.pgxs.RelativizingFileManager

getJavaFileObjectsFromPaths(Collection<? extends Path>) - Method in class org.postgresql.pljava.pgxs.RelativizingFileManager

getJavaFileObjectsFromStrings(Iterable<String>) - Method in class org.postgresql.pljava.pgxs.RelativizingFileManager

getLocation(JavaFileManager.Location) - Method in class org.postgresql.pljava.pgxs.RelativizingFileManager

getLocationAsPaths(JavaFileManager.Location) - Method in class org.postgresql.pljava.pgxs.RelativizingFileManager

getName(Locale) - Method in class org.postgresql.pljava.pgxs.ReportScriptingMojo

Queries the script for the name of this report to be used by Maven for display in index.html.

getName(ReportScriptingMojo, Locale) - Method in interface org.postgresql.pljava.pgxs.ReportScript

getOutputEncoding() - Method in class org.postgresql.pljava.pgxs.ReportScriptingMojo

getOutputName() - Method in class org.postgresql.pljava.pgxs.ReportScriptingMojo

Queries the script for the report output path relative to the target site directory.

getOutputName(ReportScriptingMojo) - Method in interface org.postgresql.pljava.pgxs.ReportScript

getPgConfigProperty(String) - Method in class org.postgresql.pljava.pgxs.PGXSUtils

Returns the output, decoded using default platform charset, of the pg_config command executed with the single supplied argument.

getPgConfigPropertyAsList(String) - Method in class org.postgresql.pljava.pgxs.AbstractPGXS

Returns the requested pg_config property as a list of individual flags split at whitespace, except when quoted, and the quotes removed.

getProject() - Method in class org.postgresql.pljava.pgxs.ReportScriptingMojo

getScriptEngine(PlexusConfiguration) - Method in class org.postgresql.pljava.pgxs.PGXSUtils

Returns a ScriptEngine with some useful engine-scoped bindings supplied for the convenience of the script.

GoalScript - Interface in org.postgresql.pljava.pgxs

Enables obtaining an interface from the script using Invocable in order to correctly handle errors.

H

handleFirstOptions(Iterable<String>) - Method in class org.postgresql.pljava.pgxs.RelativizingFileManager

Call handleOption on as many of the first supplied options as the file manager recognizes.

I

isExternalReport() - Method in class org.postgresql.pljava.pgxs.ReportScriptingMojo

Queries the script to return false if this report will produce output through a supplied Sink, or true if it is 'external', producing its output some other way.

isExternalReport(ReportScriptingMojo) - Method in interface org.postgresql.pljava.pgxs.ReportScript

isExternalReportDefault() - Method in class org.postgresql.pljava.pgxs.ReportScriptingMojo

Default implementation for ReportScript.isExternalReport(ReportScriptingMojo).

isProfileActive(String) - Method in class org.postgresql.pljava.pgxs.PGXSUtils

Returns true if the profile with given name exists and is active, false otherwise.

L

Limitations - Search tag in class org.postgresql.pljava.pgxs.RelativizingFileManager

Section

link(String, List<String>, List<String>, Path) - Method in class org.postgresql.pljava.pgxs.AbstractPGXS

Performs platform-specific linking of a set of object files with the specified linker and flags, to produce the shared object at the specified target path.

O

org.postgresql.pljava.pgxs - package org.postgresql.pljava.pgxs

The PL/Java PGXS package provides the necessary maven plugin goals to build the PL/Java Native C code.

P

PGXSUtils - Class in org.postgresql.pljava.pgxs

Utility methods to simplify and hide the bland implementation details for writing JavaScript snippets.

PGXSUtils(MavenProject, Log) - Constructor for class org.postgresql.pljava.pgxs.PGXSUtils

processBuilder(Consumer<List<String>>) - Method in class org.postgresql.pljava.pgxs.PGXSUtils

Returns a ProcessBuilder with suitable defaults and arguments added by the supplied consumer.

Purpose - Search tag in class org.postgresql.pljava.pgxs.RelativizingFileManager

Section

Q

quoteStringForC(String) - Method in class org.postgresql.pljava.pgxs.PGXSUtils

Returns the input wrapped in double quotes and with internal characters escaped where appropriate using the C conventions.

R

RelativizingFileManager - Class in org.postgresql.pljava.pgxs

A ForwardingJavaFileManager that interposes when asked for an output file of type HTML, and rewrites href URLs that contain RELDOTS as a component.

RelativizingFileManager(StandardJavaFileManager, Charset) - Constructor for class org.postgresql.pljava.pgxs.RelativizingFileManager

Construct a RelativizingFileManager, given the underlying file manager from DocumentationTool.getStandardFileManager(javax.tools.DiagnosticListener<? super javax.tools.JavaFileObject>, java.util.Locale, java.nio.charset.Charset), and the output encoding to be used.

reportPostgreSQLVersion(String) - Method in class org.postgresql.pljava.pgxs.PGXSUtils

Reports the detailed PG_VERSION_STR for the PostgreSQL version found to build against.

ReportScript - Interface in org.postgresql.pljava.pgxs

Provides reasonable defaults and other required methods for using JavaScript to during Site lifecycle phase to configure a MavenReport.

ReportScriptingMojo - Class in org.postgresql.pljava.pgxs

Maven plugin goal to use JavaScript (or another JSR 223 script engine) for configuring MavenReport during the LifecyclePhase.SITE.

ReportScriptingMojo() - Constructor for class org.postgresql.pljava.pgxs.ReportScriptingMojo

runCommand(ProcessBuilder) - Method in class org.postgresql.pljava.pgxs.PGXSUtils

Executes a ProcessBuilder and returns the exit code of the process.

S

script - Variable in class org.postgresql.pljava.pgxs.ReportScriptingMojo

The script to be used to produce the report, in the scripting language identified by its mimetype or engine attribute.

ScriptEngineLoader - Class in org.postgresql.pljava.pgxs

A ClassLoader with (effectively) two parents, the inherited one and Java's platform class loader.

ScriptEngineLoader(ClassLoader) - Constructor for class org.postgresql.pljava.pgxs.ScriptEngineLoader

ScriptingMojo - Class in org.postgresql.pljava.pgxs

Maven plugin goal to use JavaScript (or another JSR 223 script engine) during any of build lifecycle phases.

ScriptingMojo() - Constructor for class org.postgresql.pljava.pgxs.ScriptingMojo

setLocation(JavaFileManager.Location, Iterable<? extends File>) - Method in class org.postgresql.pljava.pgxs.RelativizingFileManager

setLocationForModule(JavaFileManager.Location, String, Collection<? extends Path>) - Method in class org.postgresql.pljava.pgxs.RelativizingFileManager

setLocationFromPaths(JavaFileManager.Location, Collection<? extends Path>) - Method in class org.postgresql.pljava.pgxs.RelativizingFileManager

setPathFactory(StandardJavaFileManager.PathFactory) - Method in class org.postgresql.pljava.pgxs.RelativizingFileManager

setProjectProperty(String, String) - Method in class org.postgresql.pljava.pgxs.PGXSUtils

Sets the value of a property for the current project.

shouldPlaceOnModulepath(String) - Method in class org.postgresql.pljava.pgxs.PGXSUtils

Returns true if the element should be placed on the module path.

T

toReplace - Static variable in class org.postgresql.pljava.pgxs.RelativizingFileManager

A B C D E F G H I L O P Q R S T
All Classes and Interfaces|All Packages