package org.apache.maven.tools.plugin.javadoc;
/*
* 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 java.util.Map;
import org.apache.maven.tools.plugin.extractor.java.JavaMojoAnnotation;
import com.sun.tools.doclets.Taglet;
/**
* The <tt>@goal</tt> tag is used to reference the goal name of the Mojo and has annotation parameter.
* <br/>
* The following is a sample declaration:
* <pre>
* /**
*  * Dummy Mojo.
*  *
*  * @goal <goalName>
*  * ...
*  */
* public class MyMojo extends AbstractMojo{}
* </pre>
* To use it, calling the <code>Javadoc</code> tool with the following:
* <pre>
* javadoc ... -taglet 'org.apache.maven.tools.plugin.javadoc.MojoGoalTypeTaglet'
* </pre>
* <b>Note</b>: This taglet is similar to call the <code>Javadoc</code> tool with the following:
* <pre>
* javadoc ... -tag 'goal:t:Is defined by the goal name:'
* </pre>
*
* @see <a href="package-summary.html#package_description">package-summary.html</a>
*
* @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
* @version $Id: MojoGoalTypeTaglet.java 1133707 2011-06-09 08:28:59Z stephenc $
*/
public class MojoGoalTypeTaglet
extends AbstractMojoTypeTaglet
{
/** The Javadoc annotation */
private static final String NAME = JavaMojoAnnotation.GOAL;
/** The Javadoc text which will be added to the generated page. */
protected static final String HEADER = "Is defined by the goal name";
/**
* @return By default, return the string defined in {@linkplain #HEADER}.
* @see org.apache.maven.tools.plugin.javadoc.AbstractMojoTaglet#getHeader()
* @see #HEADER
*/
public String getHeader()
{
return HEADER;
}
/**
* @return <code>"*"</code> since <code>@goal</code> has a value.
* @see org.apache.maven.tools.plugin.javadoc.AbstractMojoTaglet#getAllowedValue()
*/
public String getAllowedValue()
{
return "*";
}
/**
* @return <code>null</code> since <code>@goal</code> has no parameter.
* @see org.apache.maven.tools.plugin.javadoc.AbstractMojoTaglet#getAllowedParameterNames()
*/
public String[] getAllowedParameterNames()
{
return null;
}
/**
* @return By default, return the name of this taglet.
* @see com.sun.tools.doclets.Taglet#getName()
* @see MojoGoalTypeTaglet#NAME
*/
public String getName()
{
return NAME;
}
/**
* Register this Taglet.
*
* @param tagletMap the map to register this tag to.
*/
public static void register( Map<String, Taglet> tagletMap )
{
MojoGoalTypeTaglet tag = new MojoGoalTypeTaglet();
Taglet t = tagletMap.get( tag.getName() );
if ( t != null )
{
tagletMap.remove( tag.getName() );
}
tagletMap.put( tag.getName(), tag );
}
}