jvanzyl 2002/11/24 12:48:11
Modified: src/java/org/apache/maven/app PluginManager.java
Log:
o correcting checkstyle violoations.
Revision Changes Path
1.56 +57 -21
jakarta-turbine-maven/src/java/org/apache/maven/app/PluginManager.java
Index: PluginManager.java
===================================================================
RCS file:
/home/cvs/jakarta-turbine-maven/src/java/org/apache/maven/app/PluginManager.java,v
retrieving revision 1.55
retrieving revision 1.56
diff -u -r1.55 -r1.56
--- PluginManager.java 24 Nov 2002 19:00:37 -0000 1.55
+++ PluginManager.java 24 Nov 2002 20:48:11 -0000 1.56
@@ -108,31 +108,31 @@
public class PluginManager
{
/** Plug-in main script name. */
- public final static String PLUGIN_SCRIPT_NAME = "plugin.jelly";
+ public static final String PLUGIN_SCRIPT_NAME = "plugin.jelly";
/** Plug-in default properties name. */
- public final static String PLUGIN_PROPERTIES_NAME = "plugin.properties";
+ public static final String PLUGIN_PROPERTIES_NAME = "plugin.properties";
/** Plug-in descriptor. */
- public final static String PLUGIN_DESCRIPTOR = "plugin.xml";
+ public static final String PLUGIN_DESCRIPTOR = "plugin.xml";
/** Plug-in directory property tag */
- public final static String PLUGIN_DIR = "maven.plugin.dir";
+ public static final String PLUGIN_DIR = "maven.plugin.dir";
/** Plug-in cache */
- public final static String PLUGINS_CACHE = "plugins.cache";
+ public static final String PLUGINS_CACHE = "plugins.cache";
/** Goal cache */
- public final static String GOALS_CACHE = "goals.cache";
+ public static final String GOALS_CACHE = "goals.cache";
/** Callbacks cache */
- public final static String CALLBACKS_CACHE = "callbacks.cache";
+ public static final String CALLBACKS_CACHE = "callbacks.cache";
/** Taglibs cache */
- public final static String TAGLIBS_CACHE = "taglibs.cache";
+ public static final String TAGLIBS_CACHE = "taglibs.cache";
/** Logger */
- private final static Log log = LogFactory.getLog( PluginManager.class );
+ private static final Log log = LogFactory.getLog( PluginManager.class );
/** ${maven.home}/bin/plugins directory. */
private File pluginsDir;
@@ -320,8 +320,11 @@
/**
* Save cache information to disk.
+ *
+ * @throws Exception If an error occurs while saving the cache.
*/
- void saveCache() throws Exception
+ void saveCache()
+ throws Exception
{
this.pluginsCache.store( new FileOutputStream( new File( getPluginsDir(),
PLUGINS_CACHE ) ),
@@ -415,7 +418,7 @@
origPreCallbacks.addAll( eachGoal.getPreGoalCallbacks() );
origPostCallbacks.addAll( eachGoal.getPostGoalCallbacks() );
- if ( eachGoal.getAction() == null ) ;
+ if ( eachGoal.getAction() == null )
{
i.remove();
}
@@ -556,7 +559,7 @@
{
Goal eachGoal = (Goal) i.next();
- if ( eachGoal.getAction() == null ) ;
+ if ( eachGoal.getAction() == null )
{
i.remove();
}
@@ -624,7 +627,14 @@
}
}
- public void prepForTagLibrary( String uri ) throws Exception
+ /**
+ * Prepare the tag libary for use.
+ *
+ * @param uri URI of the tag library to prepare.
+ * @throws Exception If an error occurs while preparing the tag library for use.
+ */
+ public void prepForTagLibrary( String uri )
+ throws Exception
{
String pluginName = this.taglibsCache.getProperty( uri );
@@ -645,7 +655,8 @@
* @throws Exception If an error occurs while attempting to
* prepare for the goal.
*/
- public void prepForGoal( String name ) throws Exception
+ public void prepForGoal( String name )
+ throws Exception
{
LinkedList goals = new LinkedList();
Set seen = new HashSet();
@@ -689,7 +700,8 @@
* @throws Exception If an error occurs while attempting to preprare
* callback dependencies.
*/
- void prepForCallbacks( String goalName ) throws Exception
+ void prepForCallbacks( String goalName )
+ throws Exception
{
if ( this.callbacksCache.containsKey( goalName + ".pre" ) )
{
@@ -705,12 +717,13 @@
/**
* Load plugins specified in a whitespace delimited string.
*
- * @param name The whitespace delimited string of plugin names.
+ * @param names The whitespace delimited string of plugin names.
*
* @throws Exception If an error occurs while attempting to load
* the plugins.
*/
- void loadPlugins( String names ) throws Exception
+ void loadPlugins( String names )
+ throws Exception
{
StringTokenizer tokens = new StringTokenizer( names );
@@ -800,6 +813,9 @@
/**
* Retrieve the plugin processed marker.
+ *
+ * @param pluginName Name of the plugin for which to return the processed
marker.
+ * @return File The file which indicates the plugin has been processed.
*/
private File getPluginProcessedMarker( String pluginName )
{
@@ -808,6 +824,9 @@
/**
* Plugin processed state.
+ *
+ * @param pluginName Name of the plugin for which to check for processing.
+ * @return boolean Processed state of plugin.
*/
private boolean isPluginProcessed( String pluginName )
{
@@ -985,7 +1004,7 @@
/**
* Determine if a plugin has been loaded.
*
- * @param naem The plugin name.
+ * @param name The plugin name.
*
* @return <code>true</code> if the plugin has been loaded,
* otherwise <code>false</code>.
@@ -1069,7 +1088,10 @@
}
/**
- * Description of the Method
+ * Integrate plugin properties with the maven jelly context.
+ *
+ * @param props Properties to integrate into the context.
+ * @task Use the methods in MavenUtils instead.
*/
private void integrateProps( Map props )
{
@@ -1119,6 +1141,8 @@
/**
* Set Maven home.
+ *
+ * @param mavenHome The location of maven home in the file system.
*/
public void setMavenHome( File mavenHome )
{
@@ -1128,7 +1152,7 @@
/**
* Retrieve Maven home.
*
- * @return The ant project.
+ * @return File The location of maven home in the file system.
*/
public File getMavenHome()
{
@@ -1137,6 +1161,8 @@
/**
* Set Ant project.
+ *
+ * @param antProject The ant project.
*/
public void setAntProject( GrantProject antProject )
{
@@ -1155,6 +1181,8 @@
/**
* Set Jelly context.
+ *
+ * @param jellyContext
*/
public void setJellyContext( MavenJellyContext jellyContext )
{
@@ -1173,6 +1201,8 @@
/**
* Sets the XMLOutput attribute of the PluginManager object
+ *
+ * @param output
*/
public void setXMLOutput( XMLOutput output )
{
@@ -1191,6 +1221,8 @@
/**
* Sets the pluginsDir attribute of the PluginManager object
+ *
+ * @param pluginsDir The maven plugin directory.
*/
public void setPluginsDir( File pluginsDir )
{
@@ -1209,6 +1241,8 @@
/**
* Set the project verifier.
+ *
+ * @param projectVerifier The maven project verifier.
*/
public void setProjectVerifier( ProjectVerifier projectVerifier )
{
@@ -1217,6 +1251,8 @@
/**
* Get the project verifier.
+ *
+ * @return ProjectVerifier The maven project verfier.
*/
public ProjectVerifier getProjectVerifier()
{
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
