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