Source code

001package org.andromda.maven.plugin.bootstrap.install;
002
003import java.util.ArrayList;
004import java.util.Iterator;
005import java.util.List;
006
007import org.apache.maven.plugin.AbstractMojo;
008import org.apache.maven.plugin.MojoExecutionException;
009
010/**
011 * Display help information on andromda-bootstrap-install-plugin.<br/> Call <pre>  mvn andromda-bootstrap-install:help -Ddetail=true -Dgoal=&lt;goal-name&gt;</pre> to display parameter details.
012 *
013 * @version generated on Thu Sep 18 15:57:02 EDT 2014
014 * @author org.apache.maven.tools.plugin.generator.PluginHelpGenerator (version 2.9)
015 * @goal help
016 * @requiresProject false
017 * @threadSafe
018 */
019public class HelpMojo
020    extends AbstractMojo
021{
022    /**
023     * If <code>true</code>, display all settable properties for each goal.
024     * 
025     * @parameter expression="${detail}" default-value="false"
026     */
027    private boolean detail;
028
029    /**
030     * The name of the goal for which to show help. If unspecified, all goals will be displayed.
031     * 
032     * @parameter expression="${goal}"
033     */
034    private java.lang.String goal;
035
036    /**
037     * The maximum length of a display line, should be positive.
038     * 
039     * @parameter expression="${lineLength}" default-value="80"
040     */
041    private int lineLength;
042
043    /**
044     * The number of spaces per indentation level, should be positive.
045     * 
046     * @parameter expression="${indentSize}" default-value="2"
047     */
048    private int indentSize;
049
050
051    /** {@inheritDoc} */
052    public void execute()
053        throws MojoExecutionException
054    {
055        if ( lineLength <= 0 )
056        {
057            getLog().warn( "The parameter 'lineLength' should be positive, using '80' as default." );
058            lineLength = 80;
059        }
060        if ( indentSize <= 0 )
061        {
062            getLog().warn( "The parameter 'indentSize' should be positive, using '2' as default." );
063            indentSize = 2;
064        }
065
066        StringBuffer sb = new StringBuffer();
067
068        append( sb, "org.andromda.maven.plugins:andromda-bootstrap-install-plugin:3.5-SNAPSHOT", 0 );
069        append( sb, "", 0 );
070
071        append( sb, "AndroMDA Bootstrap Install Plugin", 0 );
072        append( sb, "A plugin used for \'installing\' bootstrap artifacts.", 1 );
073        append( sb, "", 0 );
074
075        if ( goal == null || goal.length() <= 0 )
076        {
077            append( sb, "This plugin has 2 goals:", 0 );
078            append( sb, "", 0 );
079        }
080
081        if ( goal == null || goal.length() <= 0 || "help".equals( goal ) )
082        {
083            append( sb, "andromda-bootstrap-install:help", 0 );
084            append( sb, "Display help information on andromda-bootstrap-install-plugin.\nCall\n\u00a0\u00a0mvn\u00a0andromda-bootstrap-install:help\u00a0-Ddetail=true\u00a0-Dgoal=<goal-name>\nto display parameter details.", 1 );
085            append( sb, "", 0 );
086            if ( detail )
087            {
088                append( sb, "Available parameters:", 1 );
089                append( sb, "", 0 );
090
091                append( sb, "detail (Default: false)", 2 );
092                append( sb, "If true, display all settable properties for each goal.", 3 );
093                append( sb, "Expression: ${detail}", 3 );
094                append( sb, "", 0 );
095
096                append( sb, "goal", 2 );
097                append( sb, "The name of the goal for which to show help. If unspecified, all goals will be displayed.", 3 );
098                append( sb, "Expression: ${goal}", 3 );
099                append( sb, "", 0 );
100
101                append( sb, "indentSize (Default: 2)", 2 );
102                append( sb, "The number of spaces per indentation level, should be positive.", 3 );
103                append( sb, "Expression: ${indentSize}", 3 );
104                append( sb, "", 0 );
105
106                append( sb, "lineLength (Default: 80)", 2 );
107                append( sb, "The maximum length of a display line, should be positive.", 3 );
108                append( sb, "Expression: ${lineLength}", 3 );
109                append( sb, "", 0 );
110            }
111        }
112
113        if ( goal == null || goal.length() <= 0 || "install".equals( goal ) )
114        {
115            append( sb, "andromda-bootstrap-install:install", 0 );
116            append( sb, "Provides the installation of bootstrap artifacts.", 1 );
117            append( sb, "", 0 );
118            if ( detail )
119            {
120                append( sb, "Available parameters:", 1 );
121                append( sb, "", 0 );
122
123                append( sb, "installBootstraps", 2 );
124                append( sb, "(no description available)", 3 );
125                append( sb, "Expression: ${bootstrap.artifacts}", 3 );
126                append( sb, "", 0 );
127
128                append( sb, "installDirectory", 2 );
129                append( sb, "(no description available)", 3 );
130                append( sb, "Required: Yes", 3 );
131                append( sb, "", 0 );
132            }
133        }
134
135        if ( getLog().isInfoEnabled() )
136        {
137            getLog().info( sb.toString() );
138        }
139    }
140
141    /**
142     * <p>Repeat a String <code>n</code> times to form a new string.</p>
143     *
144     * @param str String to repeat
145     * @param repeat number of times to repeat str
146     * @return String with repeated String
147     * @throws NegativeArraySizeException if <code>repeat < 0</code>
148     * @throws NullPointerException if str is <code>null</code>
149     */
150    private static String repeat( String str, int repeat )
151    {
152        StringBuffer buffer = new StringBuffer( repeat * str.length() );
153
154        for ( int i = 0; i < repeat; i++ )
155        {
156            buffer.append( str );
157        }
158
159        return buffer.toString();
160    }
161
162    /** 
163     * Append a description to the buffer by respecting the indentSize and lineLength parameters.
164     * <b>Note</b>: The last character is always a new line.
165     * 
166     * @param sb The buffer to append the description, not <code>null</code>.
167     * @param description The description, not <code>null</code>.
168     * @param indent The base indentation level of each line, must not be negative.
169     */
170    private void append( StringBuffer sb, String description, int indent )
171    {
172        for ( Iterator it = toLines( description, indent, indentSize, lineLength ).iterator(); it.hasNext(); )
173        {
174            sb.append( it.next().toString() ).append( '\n' );
175        }
176    }
177
178    /** 
179     * Splits the specified text into lines of convenient display length.
180     * 
181     * @param text The text to split into lines, must not be <code>null</code>.
182     * @param indent The base indentation level of each line, must not be negative.
183     * @param indentSize The size of each indentation, must not be negative.
184     * @param lineLength The length of the line, must not be negative.
185     * @return The sequence of display lines, never <code>null</code>.
186     * @throws NegativeArraySizeException if <code>indent < 0</code>
187     */
188    private static List toLines( String text, int indent, int indentSize, int lineLength )
189    {
190        List lines = new ArrayList();
191
192        String ind = repeat( "\t", indent );
193        String[] plainLines = text.split( "(\r\n)|(\r)|(\n)" );
194        for ( int i = 0; i < plainLines.length; i++ )
195        {
196            toLines( lines, ind + plainLines[i], indentSize, lineLength );
197        }
198
199        return lines;
200    }
201
202    /** 
203     * Adds the specified line to the output sequence, performing line wrapping if necessary.
204     * 
205     * @param lines The sequence of display lines, must not be <code>null</code>.
206     * @param line The line to add, must not be <code>null</code>.
207     * @param indentSize The size of each indentation, must not be negative.
208     * @param lineLength The length of the line, must not be negative.
209     */
210    private static void toLines( List lines, String line, int indentSize, int lineLength )
211    {
212        int lineIndent = getIndentLevel( line );
213        StringBuffer buf = new StringBuffer( 256 );
214        String[] tokens = line.split( " +" );
215        for ( int i = 0; i < tokens.length; i++ )
216        {
217            String token = tokens[i];
218            if ( i > 0 )
219            {
220                if ( buf.length() + token.length() >= lineLength )
221                {
222                    lines.add( buf.toString() );
223                    buf.setLength( 0 );
224                    buf.append( repeat( " ", lineIndent * indentSize ) );
225                }
226                else
227                {
228                    buf.append( ' ' );
229                }
230            }
231            for ( int j = 0; j < token.length(); j++ )
232            {
233                char c = token.charAt( j );
234                if ( c == '\t' )
235                {
236                    buf.append( repeat( " ", indentSize - buf.length() % indentSize ) );
237                }
238                else if ( c == '\u00A0' )
239                {
240                    buf.append( ' ' );
241                }
242                else
243                {
244                    buf.append( c );
245                }
246            }
247        }
248        lines.add( buf.toString() );
249    }
250
251    /** 
252     * Gets the indentation level of the specified line.
253     * 
254     * @param line The line whose indentation level should be retrieved, must not be <code>null</code>.
255     * @return The indentation level of the line.
256     */
257    private static int getIndentLevel( String line )
258    {
259        int level = 0;
260        for ( int i = 0; i < line.length() && line.charAt( i ) == '\t'; i++ )
261        {
262            level++;
263        }
264        for ( int i = level + 1; i <= level + 4 && i < line.length(); i++ )
265        {
266            if ( line.charAt( i ) == '\t' )
267            {
268                level++;
269                break;
270            }
271        }
272        return level;
273    }
274}