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 Group parameter.
28   * 
29   * @version $Revision$ $Date$
30   */
31  @SuppressWarnings( "all" )
32  public class Group
33      implements java.io.Serializable
34  {
35  
36        //--------------------------/
37       //- Class/Member Variables -/
38      //--------------------------/
39  
40      /**
41       * Title can be any text, and can include white space. This
42       * text is placed in the table heading for the group.
43       */
44      private String title;
45  
46      /**
47       * Packages can be any package name, or can be the start of any
48       * package name followed by an asterisk (*). The asterisk is a
49       * wildcard meaning "match any characters". This is the only
50       * wildcard allowed. Multiple patterns can be included in a
51       * group by separating them with colons (:).
52       */
53      private String packages;
54  
55  
56        //-----------/
57       //- Methods -/
58      //-----------/
59  
60      /**
61       * Method equals.
62       * 
63       * @param other a other object.
64       * @return boolean
65       */
66      public boolean equals( Object other )
67      {
68          if ( this == other )
69          {
70              return true;
71          }
72  
73          if ( !( other instanceof Group ) )
74          {
75              return false;
76          }
77  
78          Group that = (Group) other;
79          boolean result = true;
80  
81          result = result && ( getTitle() == null ? that.getTitle() == null : getTitle().equals( that.getTitle() ) );
82          result = result && ( getPackages() == null ? that.getPackages() == null : getPackages().equals( that.getPackages() ) );
83  
84          return result;
85      } //-- boolean equals( Object )
86  
87      /**
88       * Get packages can be any package name, or can be the start of
89       * any package name followed by an asterisk (*). The asterisk
90       * is a wildcard meaning "match any characters". This is the
91       * only wildcard allowed. Multiple patterns can be included in
92       * a group by separating them with colons (:).
93       * 
94       * @return String
95       */
96      public String getPackages()
97      {
98          return this.packages;
99      } //-- String getPackages()
100 
101     /**
102      * Get title can be any text, and can include white space. This
103      * text is placed in the table heading for the group.
104      * 
105      * @return String
106      */
107     public String getTitle()
108     {
109         return this.title;
110     } //-- String getTitle()
111 
112     /**
113      * Method hashCode.
114      * 
115      * @return int
116      */
117     public int hashCode()
118     {
119         int result = 17;
120 
121         result = 37 * result + ( title != null ? title.hashCode() : 0 );
122         result = 37 * result + ( packages != null ? packages.hashCode() : 0 );
123 
124         return result;
125     } //-- int hashCode()
126 
127     /**
128      * Set packages can be any package name, or can be the start of
129      * any package name followed by an asterisk (*). The asterisk
130      * is a wildcard meaning "match any characters". This is the
131      * only wildcard allowed. Multiple patterns can be included in
132      * a group by separating them with colons (:).
133      * 
134      * @param packages a packages object.
135      */
136     public void setPackages( String packages )
137     {
138         this.packages = packages;
139     } //-- void setPackages( String )
140 
141     /**
142      * Set title can be any text, and can include white space. This
143      * text is placed in the table heading for the group.
144      * 
145      * @param title a title object.
146      */
147     public void setTitle( String title )
148     {
149         this.title = title;
150     } //-- void setTitle( 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( "title = '" );
162         buf.append( getTitle() );
163         buf.append( "'" );
164         buf.append( "\n" ); 
165         buf.append( "packages = '" );
166         buf.append( getPackages() );
167         buf.append( "'" );
168 
169         return buf.toString();
170     } //-- java.lang.String toString()
171 
172 }