Package org.apache.maven.plugins.javadoc.options

Class Tag

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

  • Constructor Details

    • Tag

      public Tag()

  • Method Details

    • equals

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

    • getHead

      public String getHead()
      Get head of the tag.
      Returns:
      String

    • getName

      public String getName()
      Get name of the tag.
      Returns:
      String

    • getPlacement

      public String getPlacement()
      Get placement of the tag.
      Returns:
      String

    • hashCode

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

    • setHead

      public void setHead(String head)
      Set head of the tag.
      Parameters:
      head - a head object.

    • setName

      public void setName(String name)
      Set name of the tag.
      Parameters:
      name - a name object.

    • toString

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

    • setPlacement

      public void setPlacement(String placement) throws IllegalArgumentException
      Set a Placement. Should be a combinaison of the letters:
      • X (disable tag)
      • a (all)
      • o (overview)
      • p (packages)
      • t (types, that is classes and interfaces)
      • c (constructors)
      • m (methods)
      • f (fields)
      Parameters:
      placement -
      Throws:
      IllegalArgumentException - if not a valid combinaison of the letters