Source code

001package org.andromda.maven.plugin.andromdanetapp;
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 andromdanetapp-maven-plugin.<br/> Call <pre>  mvn andromdanetapp:help -Ddetail=true -Dgoal=&lt;goal-name&gt;</pre> to display parameter details.
012 *
013 * @version generated on Thu Sep 18 16:25:40 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:andromdanetapp-maven-plugin:3.5-SNAPSHOT", 0 );
069        append( sb, "", 0 );
070
071        append( sb, "AndroMDA .NET Application Generator Maven Plugin", 0 );
072        append( sb, "A plugin for running AndroMDA\'s AndroMDANetApp application generator to generate Maven2 AndroMDA powered applications.", 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 || "generate".equals( goal ) )
082        {
083            append( sb, "andromdanetapp:generate", 0 );
084            append( sb, "The AndroMDAapp mojo (this should be extended by any Mojo that executes AndroMDApp.", 1 );
085            append( sb, "", 0 );
086        }
087
088        if ( goal == null || goal.length() <= 0 || "help".equals( goal ) )
089        {
090            append( sb, "andromdanetapp:help", 0 );
091            append( sb, "Display help information on andromdanetapp-maven-plugin.\nCall\n\u00a0\u00a0mvn\u00a0andromdanetapp:help\u00a0-Ddetail=true\u00a0-Dgoal=<goal-name>\nto display parameter details.", 1 );
092            append( sb, "", 0 );
093            if ( detail )
094            {
095                append( sb, "Available parameters:", 1 );
096                append( sb, "", 0 );
097
098                append( sb, "detail (Default: false)", 2 );
099                append( sb, "If true, display all settable properties for each goal.", 3 );
100                append( sb, "Expression: ${detail}", 3 );
101                append( sb, "", 0 );
102
103                append( sb, "goal", 2 );
104                append( sb, "The name of the goal for which to show help. If unspecified, all goals will be displayed.", 3 );
105                append( sb, "Expression: ${goal}", 3 );
106                append( sb, "", 0 );
107
108                append( sb, "indentSize (Default: 2)", 2 );
109                append( sb, "The number of spaces per indentation level, should be positive.", 3 );
110                append( sb, "Expression: ${indentSize}", 3 );
111                append( sb, "", 0 );
112
113                append( sb, "lineLength (Default: 80)", 2 );
114                append( sb, "The maximum length of a display line, should be positive.", 3 );
115                append( sb, "Expression: ${lineLength}", 3 );
116                append( sb, "", 0 );
117            }
118        }
119
120        if ( getLog().isInfoEnabled() )
121        {
122            getLog().info( sb.toString() );
123        }
124    }
125
126    /**
127     * <p>Repeat a String <code>n</code> times to form a new string.</p>
128     *
129     * @param str String to repeat
130     * @param repeat number of times to repeat str
131     * @return String with repeated String
132     * @throws NegativeArraySizeException if <code>repeat < 0</code>
133     * @throws NullPointerException if str is <code>null</code>
134     */
135    private static String repeat( String str, int repeat )
136    {
137        StringBuffer buffer = new StringBuffer( repeat * str.length() );
138
139        for ( int i = 0; i < repeat; i++ )
140        {
141            buffer.append( str );
142        }
143
144        return buffer.toString();
145    }
146
147    /** 
148     * Append a description to the buffer by respecting the indentSize and lineLength parameters.
149     * <b>Note</b>: The last character is always a new line.
150     * 
151     * @param sb The buffer to append the description, not <code>null</code>.
152     * @param description The description, not <code>null</code>.
153     * @param indent The base indentation level of each line, must not be negative.
154     */
155    private void append( StringBuffer sb, String description, int indent )
156    {
157        for ( Iterator it = toLines( description, indent, indentSize, lineLength ).iterator(); it.hasNext(); )
158        {
159            sb.append( it.next().toString() ).append( '\n' );
160        }
161    }
162
163    /** 
164     * Splits the specified text into lines of convenient display length.
165     * 
166     * @param text The text to split into lines, must not be <code>null</code>.
167     * @param indent The base indentation level of each line, must not be negative.
168     * @param indentSize The size of each indentation, must not be negative.
169     * @param lineLength The length of the line, must not be negative.
170     * @return The sequence of display lines, never <code>null</code>.
171     * @throws NegativeArraySizeException if <code>indent < 0</code>
172     */
173    private static List toLines( String text, int indent, int indentSize, int lineLength )
174    {
175        List lines = new ArrayList();
176
177        String ind = repeat( "\t", indent );
178        String[] plainLines = text.split( "(\r\n)|(\r)|(\n)" );
179        for ( int i = 0; i < plainLines.length; i++ )
180        {
181            toLines( lines, ind + plainLines[i], indentSize, lineLength );
182        }
183
184        return lines;
185    }
186
187    /** 
188     * Adds the specified line to the output sequence, performing line wrapping if necessary.
189     * 
190     * @param lines The sequence of display lines, must not be <code>null</code>.
191     * @param line The line to add, must not be <code>null</code>.
192     * @param indentSize The size of each indentation, must not be negative.
193     * @param lineLength The length of the line, must not be negative.
194     */
195    private static void toLines( List lines, String line, int indentSize, int lineLength )
196    {
197        int lineIndent = getIndentLevel( line );
198        StringBuffer buf = new StringBuffer( 256 );
199        String[] tokens = line.split( " +" );
200        for ( int i = 0; i < tokens.length; i++ )
201        {
202            String token = tokens[i];
203            if ( i > 0 )
204            {
205                if ( buf.length() + token.length() >= lineLength )
206                {
207                    lines.add( buf.toString() );
208                    buf.setLength( 0 );
209                    buf.append( repeat( " ", lineIndent * indentSize ) );
210                }
211                else
212                {
213                    buf.append( ' ' );
214                }
215            }
216            for ( int j = 0; j < token.length(); j++ )
217            {
218                char c = token.charAt( j );
219                if ( c == '\t' )
220                {
221                    buf.append( repeat( " ", indentSize - buf.length() % indentSize ) );
222                }
223                else if ( c == '\u00A0' )
224                {
225                    buf.append( ' ' );
226                }
227                else
228                {
229                    buf.append( c );
230                }
231            }
232        }
233        lines.add( buf.toString() );
234    }
235
236    /** 
237     * Gets the indentation level of the specified line.
238     * 
239     * @param line The line whose indentation level should be retrieved, must not be <code>null</code>.
240     * @return The indentation level of the line.
241     */
242    private static int getIndentLevel( String line )
243    {
244        int level = 0;
245        for ( int i = 0; i < line.length() && line.charAt( i ) == '\t'; i++ )
246        {
247            level++;
248        }
249        for ( int i = level + 1; i <= level + 4 && i < line.length(); i++ )
250        {
251            if ( line.charAt( i ) == '\t' )
252            {
253                level++;
254                break;
255            }
256        }
257        return level;
258    }
259}