Class Tag
java.lang.Object
org.apache.maven.plugins.javadoc.options.Tag
- All Implemented Interfaces:
Serializable
A Tag parameter.
- Version:
- $Revision$ $Date$
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionboolean
Method equals.getHead()
Get head of the tag.getName()
Get name of the tag.Get placement of the tag.int
hashCode()
Method hashCode.void
Set head of the tag.void
Set name of the tag.void
setPlacement
(String placement) Set a Placement.toString()
Method toString.
-
Constructor Details
-
Tag
public Tag()
-
-
Method Details
-
equals
Method equals. -
getHead
Get head of the tag.- Returns:
- String
-
getName
Get name of the tag.- Returns:
- String
-
getPlacement
Get placement of the tag.- Returns:
- String
-
hashCode
public int hashCode()Method hashCode. -
setHead
Set head of the tag.- Parameters:
head
- a head object.
-
setName
Set name of the tag.- Parameters:
name
- a name object.
-
toString
Method toString. -
setPlacement
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
-