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