Examples of com.sun.tools.doclets.Taglet

com.sun.tools.doclets.Taglet
The interface for a custom tag used by Doclets. A custom tag must implement this interface. To be loaded and used by doclets at run-time, the taglet must have a static method called register that accepts a {@link java.util.Map} as anargument with the following signature:
```
 public void register(Map map) 
```
This method should add an instance of the custom taglet to the map with the name of the taglet as the key. If overriding a taglet, to avoid a name conflict, the overridden taglet must be deleted from the map before an instance of the new taglet is added to the map.
It is recommended that the taglet throw an exception when it fails to register itself. The exception that it throws is up to the user.
Here are two sample taglets:
- ToDoTaglet.java - Standalone taglet
- UnderlineTaglet.java - Inline taglet
For more information on how to create your own Taglets, please see the Taglet Overview. @since 1.4 @author Jamie Ho

   * @param tagletMap
   *            the map to register this tag to.
   */
  public static void register(Map<String, Taglet> tagletMap) {
    OdfAttributeTaglet tag = new OdfAttributeTaglet();
    Taglet t = tagletMap.get(tag.getName());
    if (t != null) {
      tagletMap.remove(tag.getName());
    }
    tagletMap.put(tag.getName(), tag);
  }

View Full Code Here

  }


  @SuppressWarnings({ "rawtypes", "unchecked" })
  public static void register(Map tagletMap) {
    ReturnWrappedTaglet tag = new ReturnWrappedTaglet();
    Taglet t = (Taglet) tagletMap.get(tag.getName());
    if (t != null) {
      tagletMap.remove(tag.getName());
    }
    tagletMap.put(tag.getName(), tag);
  }

View Full Code Here

  }


  @SuppressWarnings({ "rawtypes", "unchecked" })
  public static void register(Map tagletMap) {
    InputWrappedTaglet tag = new InputWrappedTaglet();
    Taglet t = (Taglet) tagletMap.get(tag.getName());
    if (t != null) {
      tagletMap.remove(tag.getName());
    }
    tagletMap.put(tag.getName(), tag);
  }

View Full Code Here

  }


  @SuppressWarnings({ "rawtypes", "unchecked" })
  public static void register(Map tagletMap) {
    ResponseHeaderTaglet tag = new ResponseHeaderTaglet();
    Taglet t = (Taglet) tagletMap.get(tag.getName());
    if (t != null) {
      tagletMap.remove(tag.getName());
    }
    tagletMap.put(tag.getName(), tag);
  }

View Full Code Here

  }


  @SuppressWarnings({ "rawtypes", "unchecked" })
  public static void register(Map tagletMap) {
    HTTPTaglet tag = new HTTPTaglet();
    Taglet t = (Taglet) tagletMap.get(tag.getName());
    if (t != null) {
      tagletMap.remove(tag.getName());
    }
    tagletMap.put(tag.getName(), tag);
  }

View Full Code Here

  }


  @SuppressWarnings({ "rawtypes", "unchecked" })
  public static void register(Map tagletMap) {
    RequestHeaderTaglet tag = new RequestHeaderTaglet();
    Taglet t = (Taglet) tagletMap.get(tag.getName());
    if (t != null) {
      tagletMap.remove(tag.getName());
    }
    tagletMap.put(tag.getName(), tag);
  }

View Full Code Here

  }


  @SuppressWarnings({ "rawtypes", "unchecked" })
  public static void register(Map tagletMap) {
    IncludeTaglet tag = new IncludeTaglet();
    Taglet t = (Taglet) tagletMap.get(tag.getName());
    if (t != null) {
      tagletMap.remove(tag.getName());
    }
    tagletMap.put(tag.getName(), tag);
  }

View Full Code Here

     * Register the taglet.
     * @param tagletMap The taglet map to register in.
     */
    @SuppressWarnings({"rawtypes", "unchecked", "unused"})
    public static void register(Map tagletMap) {
        Taglet tag = new CompatTaglet();
        tagletMap.put(tag.getName(), tag);
    }

View Full Code Here

     * @param tagletMap the map to register this tag to.
     */
    public static void register( Map tagletMap )
    {
        PlexusConfigurationTaglet tag = new PlexusConfigurationTaglet();
        Taglet t = (Taglet) tagletMap.get( tag.getName() );
        if ( t != null )
        {
            tagletMap.remove( tag.getName() );
        }
        tagletMap.put( tag.getName(), tag );

View Full Code Here

     * @param tagletMap the map to register this tag to.
     */
    public static void register( Map tagletMap )
    {
        PlexusComponentTaglet tag = new PlexusComponentTaglet();
        Taglet t = (Taglet) tagletMap.get( tag.getName() );
        if ( t != null )
        {
            tagletMap.remove( tag.getName() );
        }
        tagletMap.put( tag.getName(), tag );

View Full Code Here

0 1 2 3 4 5 6 7 8

TOP

Related Classes of com.sun.tools.doclets.Taglet

BindingTaglet

buri.ddmsence.util.taglet.DDMSChildInfoTaglet

buri.ddmsence.util.taglet.DDMSRuleTaglet

buri.ddmsence.util.taglet.DDMSVersionTaglet

buri.ddmsence.util.taglet.TableFooterTaglet

buri.ddmsence.util.taglet.TableHeaderTaglet

com.basho.riak.client.javadoc.RiakThreadSafetyTaglet

com.google.doctool.custom.ExampleTaglet

com.google.doctool.custom.IncludeTaglet

com.google.doctool.custom.TipTaglet

All source code are property of their respective owners. Java is a trademark of Sun Microsystems, Inc and owned by ORACLE Inc. Contact coftware#gmail.com.