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