Class Tag
- java.lang.Object
-
- org.apache.maven.plugins.javadoc.options.Tag
-
- All Implemented Interfaces:
java.io.Serializable
public class Tag extends java.lang.Object implements java.io.Serializable
A Tag parameter.- Version:
- $Revision$ $Date$
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description Tag()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object other)
Method equals.java.lang.String
getHead()
Get head of the tag.java.lang.String
getName()
Get name of the tag.java.lang.String
getPlacement()
Get the placement.int
hashCode()
Method hashCode.void
setHead(java.lang.String head)
Set head of the tag.void
setName(java.lang.String name)
Set name of the tag.void
setPlacement(java.lang.String placement)
Set a Placement.java.lang.String
toString()
Method toString.
-
-
-
Method Detail
-
equals
public boolean equals(java.lang.Object other)
Method equals.- Overrides:
equals
in classjava.lang.Object
- Parameters:
other
-- Returns:
- boolean
-
getHead
public java.lang.String getHead()
Get head of the tag.- Returns:
- String
-
getName
public java.lang.String getName()
Get name of the tag.- Returns:
- String
-
hashCode
public int hashCode()
Method hashCode.- Overrides:
hashCode
in classjava.lang.Object
- Returns:
- int
-
setHead
public void setHead(java.lang.String head)
Set head of the tag.- Parameters:
head
-
-
setName
public void setName(java.lang.String name)
Set name of the tag.- Parameters:
name
-
-
toString
public java.lang.String toString()
Method toString.- Overrides:
toString
in classjava.lang.Object
- Returns:
- String
-
getPlacement
public java.lang.String getPlacement()
Get the placement.
-
setPlacement
public void setPlacement(java.lang.String placement) throws java.lang.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:
java.lang.IllegalArgumentException
- if not a valid combinaison of the letters
-
-