View Javadoc

1   /*
2    =================== DO NOT EDIT THIS FILE ====================
3    Generated by Modello 1.4.1 on 2011-05-02 01:00:32,
4    any modifications will be overwritten.
5    ==============================================================
6    */
7   
8   package org.apache.maven.plugin.javadoc.options;
9   
10  /**
11   * A Taglet parameter.
12   * 
13   * @version $Revision$ $Date$
14   */
15  @SuppressWarnings( "all" )
16  public class Taglet
17      implements java.io.Serializable
18  {
19  
20        //--------------------------/
21       //- Class/Member Variables -/
22      //--------------------------/
23  
24      /**
25       * tagletClass is the fully-qualified name for the taglet class.
26       */
27      private String tagletClass;
28  
29      /**
30       * Specifies the search paths for finding taglet class files
31       * (.class).
32       */
33      private String tagletpath;
34  
35      /**
36       * Specifies the taglet artifact to be included in the
37       * tagletpath option for finding taglet class files (.class).
38       */
39      private TagletArtifact tagletArtifact;
40  
41  
42        //-----------/
43       //- Methods -/
44      //-----------/
45  
46      /**
47       * Method equals.
48       * 
49       * @param other
50       * @return boolean
51       */
52      public boolean equals( Object other )
53      {
54          if ( this == other )
55          {
56              return true;
57          }
58  
59          if ( !( other instanceof Taglet ) )
60          {
61              return false;
62          }
63  
64          Taglet that = (Taglet) other;
65          boolean result = true;
66  
67          result = result && ( getTagletClass() == null ? that.getTagletClass() == null : getTagletClass().equals( that.getTagletClass() ) );
68          result = result && ( getTagletpath() == null ? that.getTagletpath() == null : getTagletpath().equals( that.getTagletpath() ) );
69  
70          return result;
71      } //-- boolean equals( Object )
72  
73      /**
74       * Get specifies the taglet artifact to be included in the
75       * tagletpath option for finding taglet class files (.class).
76       * 
77       * @return TagletArtifact
78       */
79      public TagletArtifact getTagletArtifact()
80      {
81          return this.tagletArtifact;
82      } //-- TagletArtifact getTagletArtifact()
83  
84      /**
85       * Get tagletClass is the fully-qualified name for the taglet
86       * class.
87       * 
88       * @return String
89       */
90      public String getTagletClass()
91      {
92          return this.tagletClass;
93      } //-- String getTagletClass()
94  
95      /**
96       * Get specifies the search paths for finding taglet class
97       * files (.class).
98       * 
99       * @return String
100      */
101     public String getTagletpath()
102     {
103         return this.tagletpath;
104     } //-- String getTagletpath()
105 
106     /**
107      * Method hashCode.
108      * 
109      * @return int
110      */
111     public int hashCode()
112     {
113         int result = 17;
114 
115         result = 37 * result + ( tagletClass != null ? tagletClass.hashCode() : 0 );
116         result = 37 * result + ( tagletpath != null ? tagletpath.hashCode() : 0 );
117 
118         return result;
119     } //-- int hashCode()
120 
121     /**
122      * Set specifies the taglet artifact to be included in the
123      * tagletpath option for finding taglet class files (.class).
124      * 
125      * @param tagletArtifact
126      */
127     public void setTagletArtifact( TagletArtifact tagletArtifact )
128     {
129         this.tagletArtifact = tagletArtifact;
130     } //-- void setTagletArtifact( TagletArtifact )
131 
132     /**
133      * Set tagletClass is the fully-qualified name for the taglet
134      * class.
135      * 
136      * @param tagletClass
137      */
138     public void setTagletClass( String tagletClass )
139     {
140         this.tagletClass = tagletClass;
141     } //-- void setTagletClass( String )
142 
143     /**
144      * Set specifies the search paths for finding taglet class
145      * files (.class).
146      * 
147      * @param tagletpath
148      */
149     public void setTagletpath( String tagletpath )
150     {
151         this.tagletpath = tagletpath;
152     } //-- void setTagletpath( String )
153 
154     /**
155      * Method toString.
156      * 
157      * @return String
158      */
159     public java.lang.String toString()
160     {
161         StringBuilder buf = new StringBuilder( 128 );
162 
163         buf.append( "tagletClass = '" );
164         buf.append( getTagletClass() );
165         buf.append( "'" );
166         buf.append( "\n" ); 
167         buf.append( "tagletpath = '" );
168         buf.append( getTagletpath() );
169         buf.append( "'" );
170 
171         return buf.toString();
172     } //-- java.lang.String toString()
173 
174 }