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

java.lang.Object
  org.apache.maven.plugin.javadoc.options.Taglet

All Implemented Interfaces:

java.io.Serializable

public class Taglet
extends java.lang.Object
implements java.io.Serializable

A Taglet parameter.

Version:

$Revision: 829389 $ $Date: 2012-08-19 17:23:07 +0000 (Sun, 19 Aug 2012) $

See Also:

Serialized Form

Constructor Summary

Taglet()

Method Summary

boolean	equals(java.lang.Object other) Method equals.
java.lang.String	getModelEncoding()
TagletArtifact	getTagletArtifact() Get specifies the taglet artifact to be included in the tagletpath option for finding taglet class files (.class).
java.lang.String	getTagletClass() Get tagletClass is the fully-qualified name for the taglet class.
java.lang.String	getTagletpath() Get specifies the search paths for finding taglet class files (.class).
int	hashCode() Method hashCode.
void	setModelEncoding(java.lang.String modelEncoding) Set an encoding used for reading/writing the model.
void	setTagletArtifact(TagletArtifact tagletArtifact) Set specifies the taglet artifact to be included in the tagletpath option for finding taglet class files (.class).
void	setTagletClass(java.lang.String tagletClass) Set tagletClass is the fully-qualified name for the taglet class.
void	setTagletpath(java.lang.String tagletpath) Set specifies the search paths for finding taglet class files (.class).
java.lang.String	toString() Method toString.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Taglet

public Taglet()

Method Detail

equals

public boolean equals(java.lang.Object other)

Method equals.

Overrides:

equals in class java.lang.Object

Parameters:

other -

Returns:

boolean

getTagletArtifact

public TagletArtifact getTagletArtifact()

Get specifies the taglet artifact to be included in the tagletpath option for finding taglet class files (.class).

Returns:

TagletArtifact

getTagletClass

public java.lang.String getTagletClass()

Get tagletClass is the fully-qualified name for the taglet class.

Returns:

String

getTagletpath

public java.lang.String getTagletpath()

Get specifies the search paths for finding taglet class files (.class).

Returns:

String

hashCode

public int hashCode()

Method hashCode.

Overrides:

hashCode in class java.lang.Object

Returns:

int

setTagletArtifact

public void setTagletArtifact(TagletArtifact tagletArtifact)

Set specifies the taglet artifact to be included in the tagletpath option for finding taglet class files (.class).

Parameters:

tagletArtifact -

setTagletClass

public void setTagletClass(java.lang.String tagletClass)

Set tagletClass is the fully-qualified name for the taglet class.

Parameters:

tagletClass -

setTagletpath

public void setTagletpath(java.lang.String tagletpath)

Set specifies the search paths for finding taglet class files (.class).

Parameters:

tagletpath -

toString

public java.lang.String toString()

Method toString.

Overrides:

toString in class java.lang.Object

Returns:

java.lang.String

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.