Class Taglet

java.lang.Object
org.apache.maven.plugins.javadoc.options.Taglet
All Implemented Interfaces:
Serializable
public class Taglet extends Object implements Serializable
A Taglet parameter.
Version:
$Revision$ $Date$
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private TagletArtifact
    tagletArtifact
    Specifies the taglet artifact to be included in the tagletpath option for finding taglet class files (.class).
    private String
    tagletClass
    tagletClass is the fully-qualified name for the taglet class.
    private String
    tagletpath
    Specifies the search paths for finding taglet class files (.class).

  • Constructor Summary

    Constructors
    Constructor
    Description
    Taglet()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object other)
    Method equals.
    TagletArtifact
    getTagletArtifact()
    Get specifies the taglet artifact to be included in the tagletpath option for finding taglet class files (.class).
    String
    getTagletClass()
    Get tagletClass is the fully-qualified name for the taglet class.
    String
    getTagletpath()
    Get specifies the search paths for finding taglet class files (.class).
    int
    hashCode()
    Method hashCode.
    void
    setTagletArtifact(TagletArtifact tagletArtifact)
    Set specifies the taglet artifact to be included in the tagletpath option for finding taglet class files (.class).
    void
    setTagletClass(String tagletClass)
    Set tagletClass is the fully-qualified name for the taglet class.
    void
    setTagletpath(String tagletpath)
    Set specifies the search paths for finding taglet class files (.class).
    String
    toString()
    Method toString.

    Methods inherited from class Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Field Details

    • tagletClass

      private String tagletClass
      tagletClass is the fully-qualified name for the taglet class.

    • tagletpath

      private String tagletpath
      Specifies the search paths for finding taglet class files (.class).

    • tagletArtifact

      private TagletArtifact tagletArtifact
      Specifies the taglet artifact to be included in the tagletpath option for finding taglet class files (.class).

  • Constructor Details

    • Taglet

      public Taglet()

  • Method Details

    • equals

      public boolean equals(Object other)
      Method equals.
      Overrides:
      equals in class Object
      Parameters:
      other - a other object.
      Returns:
      boolean

    • getTagletArtifact

      public TagletArtifact getTagletArtifact()
      Get specifies the taglet artifact to be included in the tagletpath option for finding taglet class files (.class).
      Returns:
      TagletArtifact

    • getTagletClass

      public String getTagletClass()
      Get tagletClass is the fully-qualified name for the taglet class.
      Returns:
      String

    • getTagletpath

      public String getTagletpath()
      Get specifies the search paths for finding taglet class files (.class).
      Returns:
      String

    • hashCode

      public int hashCode()
      Method hashCode.
      Overrides:
      hashCode in class Object
      Returns:
      int

    • setTagletArtifact

      public void setTagletArtifact(TagletArtifact tagletArtifact)
      Set specifies the taglet artifact to be included in the tagletpath option for finding taglet class files (.class).
      Parameters:
      tagletArtifact - a tagletArtifact object.

    • setTagletClass

      public void setTagletClass(String tagletClass)
      Set tagletClass is the fully-qualified name for the taglet class.
      Parameters:
      tagletClass - a tagletClass object.

    • setTagletpath

      public void setTagletpath(String tagletpath)
      Set specifies the search paths for finding taglet class files (.class).
      Parameters:
      tagletpath - a tagletpath object.

    • toString

      public String toString()
      Method toString.
      Overrides:
      toString in class Object
      Returns:
      String