View Javadoc
1   /*
2    Licensed to the Apache Software Foundation (ASF) under one
3    or more contributor license agreements.  See the NOTICE file
4    distributed with this work for additional information
5    regarding copyright ownership.  The ASF licenses this file
6    to you under the Apache License, Version 2.0 (the
7    "License"); you may not use this file except in compliance
8    with the License.  You may obtain a copy of the License at
9    
10       http://www.apache.org/licenses/LICENSE-2.0
11   
12   Unless required by applicable law or agreed to in writing,
13   software distributed under the License is distributed on an
14   "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   KIND, either express or implied.  See the License for the
16   specific language governing permissions and limitations
17   under the License.
18   =================== DO NOT EDIT THIS FILE ====================
19   Generated by Modello 2.5.1,
20   any modifications will be overwritten.
21   ==============================================================
22   */
23  
24  package org.apache.maven.plugins.javadoc.options;
25  
26  /**
27   * A Taglet parameter.
28   * 
29   * @version $Revision$ $Date$
30   */
31  @SuppressWarnings( "all" )
32  public class Taglet
33      implements java.io.Serializable
34  {
35  
36        //--------------------------/
37       //- Class/Member Variables -/
38      //--------------------------/
39  
40      /**
41       * tagletClass is the fully-qualified name for the taglet class.
42       */
43      private String tagletClass;
44  
45      /**
46       * Specifies the search paths for finding taglet class files
47       * (.class).
48       */
49      private String tagletpath;
50  
51      /**
52       * Specifies the taglet artifact to be included in the
53       * tagletpath option for finding taglet class files (.class).
54       */
55      private TagletArtifact tagletArtifact;
56  
57  
58        //-----------/
59       //- Methods -/
60      //-----------/
61  
62      /**
63       * Method equals.
64       * 
65       * @param other a other object.
66       * @return boolean
67       */
68      public boolean equals( Object other )
69      {
70          if ( this == other )
71          {
72              return true;
73          }
74  
75          if ( !( other instanceof Taglet ) )
76          {
77              return false;
78          }
79  
80          Taglet that = (Taglet) other;
81          boolean result = true;
82  
83          result = result && ( getTagletClass() == null ? that.getTagletClass() == null : getTagletClass().equals( that.getTagletClass() ) );
84          result = result && ( getTagletpath() == null ? that.getTagletpath() == null : getTagletpath().equals( that.getTagletpath() ) );
85  
86          return result;
87      } //-- boolean equals( Object )
88  
89      /**
90       * Get specifies the taglet artifact to be included in the
91       * tagletpath option for finding taglet class files (.class).
92       * 
93       * @return TagletArtifact
94       */
95      public TagletArtifact getTagletArtifact()
96      {
97          return this.tagletArtifact;
98      } //-- TagletArtifact getTagletArtifact()
99  
100     /**
101      * Get tagletClass is the fully-qualified name for the taglet
102      * class.
103      * 
104      * @return String
105      */
106     public String getTagletClass()
107     {
108         return this.tagletClass;
109     } //-- String getTagletClass()
110 
111     /**
112      * Get specifies the search paths for finding taglet class
113      * files (.class).
114      * 
115      * @return String
116      */
117     public String getTagletpath()
118     {
119         return this.tagletpath;
120     } //-- String getTagletpath()
121 
122     /**
123      * Method hashCode.
124      * 
125      * @return int
126      */
127     public int hashCode()
128     {
129         int result = 17;
130 
131         result = 37 * result + ( tagletClass != null ? tagletClass.hashCode() : 0 );
132         result = 37 * result + ( tagletpath != null ? tagletpath.hashCode() : 0 );
133 
134         return result;
135     } //-- int hashCode()
136 
137     /**
138      * Set specifies the taglet artifact to be included in the
139      * tagletpath option for finding taglet class files (.class).
140      * 
141      * @param tagletArtifact a tagletArtifact object.
142      */
143     public void setTagletArtifact( TagletArtifact tagletArtifact )
144     {
145         this.tagletArtifact = tagletArtifact;
146     } //-- void setTagletArtifact( TagletArtifact )
147 
148     /**
149      * Set tagletClass is the fully-qualified name for the taglet
150      * class.
151      * 
152      * @param tagletClass a tagletClass object.
153      */
154     public void setTagletClass( String tagletClass )
155     {
156         this.tagletClass = tagletClass;
157     } //-- void setTagletClass( String )
158 
159     /**
160      * Set specifies the search paths for finding taglet class
161      * files (.class).
162      * 
163      * @param tagletpath a tagletpath object.
164      */
165     public void setTagletpath( String tagletpath )
166     {
167         this.tagletpath = tagletpath;
168     } //-- void setTagletpath( String )
169 
170     /**
171      * Method toString.
172      * 
173      * @return String
174      */
175     public java.lang.String toString()
176     {
177         StringBuilder buf = new StringBuilder( 128 );
178 
179         buf.append( "tagletClass = '" );
180         buf.append( getTagletClass() );
181         buf.append( "'" );
182         buf.append( "\n" ); 
183         buf.append( "tagletpath = '" );
184         buf.append( getTagletpath() );
185         buf.append( "'" );
186 
187         return buf.toString();
188     } //-- java.lang.String toString()
189 
190 }