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

java.lang.Object
  extended by org.apache.maven.plugin.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: 829389 $ $Date: 2012-08-19 17:23:07 +0000 (Sun, 19 Aug 2012) $
See Also:
Serialized Form

Constructor Summary
Tag()
           
 
Method Summary
 boolean equals(java.lang.Object other)
          Method equals.
 java.lang.String getHead()
          Get head of the tag.
 java.lang.String getModelEncoding()
           
 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 setModelEncoding(java.lang.String modelEncoding)
          Set an encoding used for reading/writing the model.
 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.
 
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(java.lang.Object other)
Method equals.

Overrides:
equals in class java.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 class java.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 class java.lang.Object
Returns:
java.lang.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:

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

setModelEncoding

public void setModelEncoding(java.lang.String modelEncoding)
Set an encoding used for reading/writing the model.

Parameters:
modelEncoding - the encoding used when reading/writing the model.

getModelEncoding

public java.lang.String getModelEncoding()
Returns:
the current encoding used when reading/writing this model.


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