org.apache.maven.plugin.javadoc.options
Class Tag

java.lang.Object
  extended by org.apache.maven.plugin.javadoc.options.Tag
All Implemented Interfaces:
Serializable

public class Tag
extends Object
implements Serializable

A Tag parameter.

Version:
$Revision: 829396 $ $Date: 2012-08-19 17:35:19 +0000 (Sun, 19 Aug 2012) $
See Also:
Serialized Form

Constructor Summary
Tag()
           
 
Method Summary
 boolean equals(Object other)
          Method equals.
 String getHead()
          Get head of the tag.
 String getName()
          Get name of the tag.
 String getPlacement()
          Get the placement.
 int hashCode()
          Method hashCode.
 void setHead(String head)
          Set head of the tag.
 void setName(String name)
          Set name of the tag.
 void setPlacement(String placement)
          Set a Placement.
 String toString()
          Method toString.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Tag

public Tag()
Method Detail

equals

public boolean equals(Object other)
Method equals.

Overrides:
equals in class Object
Parameters:
other -
Returns:
boolean

getHead

public String getHead()
Get head of the tag.

Returns:
String

getName

public String getName()
Get name 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 -

setName

public void setName(String name)
Set name of the tag.

Parameters:
name -

toString

public String toString()
Method toString.

Overrides:
toString in class Object
Returns:
String

getPlacement

public String getPlacement()
Get the placement.


setPlacement

public void setPlacement(String placement)
                  throws IllegalArgumentException
Set a Placement. Should be a combinaison of the letters:

Parameters:
placement -
Throws:
IllegalArgumentException - if not a valid combinaison of the letters


Copyright © 2004-2010 The Apache Software Foundation. All Rights Reserved.