mirror of https://github.com/apache/maven.git
o Restored some more backward-compat
git-svn-id: https://svn.apache.org/repos/asf/maven/components/trunk@806585 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Benjamin Bentmann
parent
9d87933ca3
commit
1b57686445
|
|
@ -185,6 +185,7 @@ END SNIPPET: ant-bootstrap -->
|
|||
<modello file="maven-core/src/main/mdo/toolchains.mdo" />
|
||||
<modello file="maven-compat/src/main/mdo/metadata.mdo" />
|
||||
<modello file="maven-compat/src/main/mdo/profiles.mdo" />
|
||||
<modello file="maven-compat/src/main/mdo/paramdoc.mdo" />
|
||||
</target>
|
||||
|
||||
<target name="compile-boot" depends="generate-sources" description="compiles the bootstrap sources">
|
||||
|
|
|
|||
|
|
@ -78,6 +78,7 @@
|
|||
<models>
|
||||
<model>src/main/mdo/metadata.mdo</model>
|
||||
<model>src/main/mdo/profiles.mdo</model>
|
||||
<model>src/main/mdo/paramdoc.mdo</model>
|
||||
</models>
|
||||
</configuration>
|
||||
</plugin>
|
||||
|
|
|
|||
|
|
@ -0,0 +1,37 @@
|
|||
package org.apache.maven.usability.plugin;
|
||||
|
||||
/*
|
||||
* Licensed to the Apache Software Foundation (ASF) under one
|
||||
* or more contributor license agreements. See the NOTICE file
|
||||
* distributed with this work for additional information
|
||||
* regarding copyright ownership. The ASF licenses this file
|
||||
* to you under the Apache License, Version 2.0 (the
|
||||
* "License"); you may not use this file except in compliance
|
||||
* with the License. You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing,
|
||||
* software distributed under the License is distributed on an
|
||||
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
||||
* KIND, either express or implied. See the License for the
|
||||
* specific language governing permissions and limitations
|
||||
* under the License.
|
||||
*/
|
||||
|
||||
public class ExpressionDocumentationException
|
||||
extends Exception
|
||||
{
|
||||
static final long serialVersionUID = 1;
|
||||
|
||||
public ExpressionDocumentationException( String message, Throwable cause )
|
||||
{
|
||||
super( message, cause );
|
||||
}
|
||||
|
||||
public ExpressionDocumentationException( String message )
|
||||
{
|
||||
super( message );
|
||||
}
|
||||
|
||||
}
|
||||
|
|
@ -0,0 +1,173 @@
|
|||
package org.apache.maven.usability.plugin;
|
||||
|
||||
/*
|
||||
* Licensed to the Apache Software Foundation (ASF) under one
|
||||
* or more contributor license agreements. See the NOTICE file
|
||||
* distributed with this work for additional information
|
||||
* regarding copyright ownership. The ASF licenses this file
|
||||
* to you under the Apache License, Version 2.0 (the
|
||||
* "License"); you may not use this file except in compliance
|
||||
* with the License. You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing,
|
||||
* software distributed under the License is distributed on an
|
||||
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
||||
* KIND, either express or implied. See the License for the
|
||||
* specific language governing permissions and limitations
|
||||
* under the License.
|
||||
*/
|
||||
|
||||
import org.apache.maven.usability.plugin.io.xpp3.ParamdocXpp3Reader;
|
||||
import org.codehaus.plexus.util.IOUtil;
|
||||
import org.codehaus.plexus.util.ReaderFactory;
|
||||
import org.codehaus.plexus.util.xml.pull.XmlPullParserException;
|
||||
|
||||
import java.io.BufferedReader;
|
||||
import java.io.File;
|
||||
import java.io.IOException;
|
||||
import java.io.InputStream;
|
||||
import java.io.Reader;
|
||||
import java.net.MalformedURLException;
|
||||
import java.net.URL;
|
||||
import java.net.URLClassLoader;
|
||||
import java.util.HashMap;
|
||||
import java.util.Iterator;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
|
||||
public class ExpressionDocumenter
|
||||
{
|
||||
|
||||
private static final String[] EXPRESSION_ROOTS = { "project", "settings", "session", "plugin", "rootless" };
|
||||
|
||||
private static final String EXPRESSION_DOCO_ROOTPATH = "META-INF/maven/plugin-expressions/";
|
||||
|
||||
private static Map expressionDocumentation;
|
||||
|
||||
public static Map load()
|
||||
throws ExpressionDocumentationException
|
||||
{
|
||||
if ( expressionDocumentation == null )
|
||||
{
|
||||
expressionDocumentation = new HashMap();
|
||||
|
||||
ClassLoader docLoader = initializeDocLoader();
|
||||
|
||||
for ( int i = 0; i < EXPRESSION_ROOTS.length; i++ )
|
||||
{
|
||||
InputStream docStream = null;
|
||||
try
|
||||
{
|
||||
docStream = docLoader
|
||||
.getResourceAsStream( EXPRESSION_DOCO_ROOTPATH + EXPRESSION_ROOTS[i] + ".paramdoc.xml" );
|
||||
|
||||
if ( docStream != null )
|
||||
{
|
||||
Map doco = parseExpressionDocumentation( docStream );
|
||||
|
||||
expressionDocumentation.putAll( doco );
|
||||
}
|
||||
}
|
||||
catch ( IOException e )
|
||||
{
|
||||
throw new ExpressionDocumentationException( "Failed to read documentation for expression root: " + EXPRESSION_ROOTS[i], e );
|
||||
}
|
||||
catch ( XmlPullParserException e )
|
||||
{
|
||||
throw new ExpressionDocumentationException( "Failed to parse documentation for expression root: " + EXPRESSION_ROOTS[i], e );
|
||||
}
|
||||
finally
|
||||
{
|
||||
IOUtil.close( docStream );
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return expressionDocumentation;
|
||||
}
|
||||
|
||||
/**
|
||||
* <expressions>
|
||||
* <expression>
|
||||
* <syntax>project.distributionManagementArtifactRepository</syntax>
|
||||
* <origin><![CDATA[
|
||||
* <distributionManagement>
|
||||
* <repository>
|
||||
* <id>some-repo</id>
|
||||
* <url>scp://host/path</url>
|
||||
* </repository>
|
||||
* <snapshotRepository>
|
||||
* <id>some-snap-repo</id>
|
||||
* <url>scp://host/snapshot-path</url>
|
||||
* </snapshotRepository>
|
||||
* </distributionManagement>
|
||||
* ]]></origin>
|
||||
* <usage><![CDATA[
|
||||
* The repositories onto which artifacts should be deployed.
|
||||
* One is for releases, the other for snapshots.
|
||||
* ]]></usage>
|
||||
* </expression>
|
||||
* <expressions>
|
||||
* @throws IOException
|
||||
* @throws XmlPullParserException
|
||||
*/
|
||||
private static Map parseExpressionDocumentation( InputStream docStream )
|
||||
throws IOException, XmlPullParserException
|
||||
{
|
||||
Reader reader = new BufferedReader( ReaderFactory.newXmlReader( docStream ) );
|
||||
|
||||
ParamdocXpp3Reader paramdocReader = new ParamdocXpp3Reader();
|
||||
|
||||
ExpressionDocumentation documentation = paramdocReader.read( reader, true );
|
||||
|
||||
List expressions = documentation.getExpressions();
|
||||
|
||||
Map bySyntax = new HashMap();
|
||||
|
||||
if ( expressions != null && !expressions.isEmpty() )
|
||||
{
|
||||
for ( Iterator it = expressions.iterator(); it.hasNext(); )
|
||||
{
|
||||
Expression expr = (Expression) it.next();
|
||||
|
||||
bySyntax.put( expr.getSyntax(), expr );
|
||||
}
|
||||
}
|
||||
|
||||
return bySyntax;
|
||||
}
|
||||
|
||||
private static ClassLoader initializeDocLoader()
|
||||
throws ExpressionDocumentationException
|
||||
{
|
||||
String myResourcePath = ExpressionDocumenter.class.getName().replace( '.', '/' ) + ".class";
|
||||
|
||||
URL myResource = ExpressionDocumenter.class.getClassLoader().getResource( myResourcePath );
|
||||
|
||||
String myClasspathEntry = myResource.getPath();
|
||||
|
||||
myClasspathEntry = myClasspathEntry.substring( 0, myClasspathEntry.length() - ( myResourcePath.length() + 2 ) );
|
||||
|
||||
if ( myClasspathEntry.startsWith( "file:" ) )
|
||||
{
|
||||
myClasspathEntry = myClasspathEntry.substring( "file:".length() );
|
||||
}
|
||||
|
||||
URL docResource;
|
||||
try
|
||||
{
|
||||
docResource = new File( myClasspathEntry ).toURL();
|
||||
}
|
||||
catch ( MalformedURLException e )
|
||||
{
|
||||
throw new ExpressionDocumentationException(
|
||||
"Cannot construct expression documentation classpath resource base.",
|
||||
e );
|
||||
}
|
||||
|
||||
return new URLClassLoader( new URL[] { docResource } );
|
||||
}
|
||||
|
||||
}
|
||||
|
|
@ -0,0 +1,154 @@
|
|||
<?xml version="1.0"?>
|
||||
|
||||
<!--
|
||||
Licensed to the Apache Software Foundation (ASF) under one
|
||||
or more contributor license agreements. See the NOTICE file
|
||||
distributed with this work for additional information
|
||||
regarding copyright ownership. The ASF licenses this file
|
||||
to you under the Apache License, Version 2.0 (the
|
||||
"License"); you may not use this file except in compliance
|
||||
with the License. You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing,
|
||||
software distributed under the License is distributed on an
|
||||
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
||||
KIND, either express or implied. See the License for the
|
||||
specific language governing permissions and limitations
|
||||
under the License.
|
||||
-->
|
||||
|
||||
<model xmlns="http://modello.codehaus.org/MODELLO/1.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||
xsi:schemaLocation="http://modello.codehaus.org/MODELLO/1.0.0 http://modello.codehaus.org/xsd/modello-1.0.0.xsd"
|
||||
xml.namespace="http://maven.apache.org/PARAMDOC/${version}"
|
||||
xml.schemaLocation="http://maven.apache.org/xsd/paramdoc-${version}.xsd">
|
||||
<id>paramdoc</id>
|
||||
<name>Paramdoc</name>
|
||||
<description><![CDATA[Documentation on parameter expressions supported by Maven for use in plugins.]]></description>
|
||||
<defaults>
|
||||
<default>
|
||||
<key>package</key>
|
||||
<value>org.apache.maven.usability.plugin</value>
|
||||
</default>
|
||||
</defaults>
|
||||
<classes>
|
||||
<class rootElement="true" xml.tagName="paramdoc">
|
||||
<version>1.0.0</version>
|
||||
<name>ExpressionDocumentation</name>
|
||||
<description>The root of a parameter plugin expression document.</description>
|
||||
<fields>
|
||||
<field>
|
||||
<version>1.0.0</version>
|
||||
<name>expressions</name>
|
||||
<description>The list of plugin parameter expressions described by this
|
||||
document.</description>
|
||||
<association>
|
||||
<type>Expression</type>
|
||||
<multiplicity>*</multiplicity>
|
||||
</association>
|
||||
</field>
|
||||
</fields>
|
||||
<codeSegments>
|
||||
<codeSegment>
|
||||
<version>1.0.0</version>
|
||||
<code><![CDATA[ private java.util.Map expressionsBySyntax;
|
||||
|
||||
public java.util.Map getExpressionsBySyntax()
|
||||
{
|
||||
if ( expressionsBySyntax == null )
|
||||
{
|
||||
expressionsBySyntax = new java.util.HashMap();
|
||||
|
||||
java.util.List expressions = getExpressions();
|
||||
|
||||
if ( expressions != null && !expressions.isEmpty() )
|
||||
{
|
||||
for ( java.util.Iterator it = expressions.iterator(); it.hasNext(); )
|
||||
{
|
||||
Expression expr = (Expression) it.next();
|
||||
|
||||
expressionsBySyntax.put( expr.getSyntax(), expr );
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return expressionsBySyntax;
|
||||
}
|
||||
|
||||
public void flushExpressionsBySyntax()
|
||||
{
|
||||
expressionsBySyntax = null;
|
||||
}
|
||||
]]></code>
|
||||
</codeSegment>
|
||||
</codeSegments>
|
||||
</class>
|
||||
<class>
|
||||
<version>1.0.0</version>
|
||||
<name>Expression</name>
|
||||
<description>A plugin parameter expression supported by Maven</description>
|
||||
<fields>
|
||||
<field>
|
||||
<version>1.0.0</version>
|
||||
<name>syntax</name>
|
||||
<description>The syntax of the expression</description>
|
||||
<type>String</type>
|
||||
<required>true</required>
|
||||
</field>
|
||||
<field>
|
||||
<version>1.0.0</version>
|
||||
<name>description</name>
|
||||
<description>The description of what this expression references, and what it's generally used for.</description>
|
||||
<type>String</type>
|
||||
<required>true</required>
|
||||
</field>
|
||||
<field>
|
||||
<version>1.0.0</version>
|
||||
<name>configuration</name>
|
||||
<description>The place and syntax used to change the value of this expression.</description>
|
||||
<type>String</type>
|
||||
</field>
|
||||
<field>
|
||||
<version>1.0.0</version>
|
||||
<name>cliOptions</name>
|
||||
<description>The command-line switches used to change the value of this expression.</description>
|
||||
<type>Properties</type>
|
||||
<association xml.mapStyle="explode">
|
||||
<type>String</type>
|
||||
<multiplicity>*</multiplicity>
|
||||
</association>
|
||||
</field>
|
||||
<field>
|
||||
<version>1.0.0</version>
|
||||
<name>apiMethods</name>
|
||||
<description>The programmatic methods used to change the value of this expression.</description>
|
||||
<type>Properties</type>
|
||||
<association xml.mapStyle="explode">
|
||||
<type>String</type>
|
||||
<multiplicity>*</multiplicity>
|
||||
</association>
|
||||
</field>
|
||||
<field>
|
||||
<version>1.0.0</version>
|
||||
<name>deprecation</name>
|
||||
<description>A preferred alternative to this expression, in the case where it's deprecated.</description>
|
||||
<type>String</type>
|
||||
</field>
|
||||
<field>
|
||||
<version>1.0.0</version>
|
||||
<name>ban</name>
|
||||
<description>A preferred alternative to this expression, in the case where it's banned from use.</description>
|
||||
<type>String</type>
|
||||
</field>
|
||||
<field>
|
||||
<version>1.0.0</version>
|
||||
<name>editable</name>
|
||||
<description>Whether the value of this expression can be changed.</description>
|
||||
<type>boolean</type>
|
||||
<defaultValue>true</defaultValue>
|
||||
</field>
|
||||
</fields>
|
||||
</class>
|
||||
</classes>
|
||||
</model>
|
||||
Loading…
Reference in New Issue