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.doxia.module.fml.model;
7   
8   /**
9    * 
10   *          The <code>&lt;faqs&gt;</code> element is the root of
11   * the FML descriptor.
12   *          The following table lists all of the possible child
13   * elements.
14   *       
15   * 
16   * @version $Revision$ $Date$
17   */
18  @SuppressWarnings( "all" )
19  public class Faqs
20      implements java.io.Serializable
21  {
22  
23        //--------------------------/
24       //- Class/Member Variables -/
25      //--------------------------/
26  
27      /**
28       * 
29       *             The title name of this FAQ.
30       *           
31       */
32      private String title = "FAQ";
33  
34      /**
35       * 
36       *             Boolean to generate optionally [top] links.
37       *           
38       */
39      private boolean toplink = true;
40  
41      /**
42       * Field parts.
43       */
44      private java.util.List<Part> parts;
45  
46      /**
47       * Field modelEncoding.
48       */
49      private String modelEncoding = "UTF-8";
50  
51  
52        //-----------/
53       //- Methods -/
54      //-----------/
55  
56      /**
57       * Method addPart.
58       * 
59       * @param part a part object.
60       */
61      public void addPart( Part part )
62      {
63          getParts().add( part );
64      } //-- void addPart( Part )
65  
66      /**
67       * Method equals.
68       * 
69       * @param other a other object.
70       * @return boolean
71       */
72      public boolean equals( Object other )
73      {
74          if ( this == other )
75          {
76              return true;
77          }
78  
79          if ( !( other instanceof Faqs ) )
80          {
81              return false;
82          }
83  
84          Faqs that = (Faqs) other;
85          boolean result = true;
86  
87          result = result && ( getTitle() == null ? that.getTitle() == null : getTitle().equals( that.getTitle() ) );
88          result = result && toplink == that.toplink;
89          result = result && ( getParts() == null ? that.getParts() == null : getParts().equals( that.getParts() ) );
90  
91          return result;
92      } //-- boolean equals( Object )
93  
94      /**
95       * Get the modelEncoding field.
96       * 
97       * @return String
98       */
99      public String getModelEncoding()
100     {
101         return this.modelEncoding;
102     } //-- String getModelEncoding()
103 
104     /**
105      * Method getParts.
106      * 
107      * @return List
108      */
109     public java.util.List<Part> getParts()
110     {
111         if ( this.parts == null )
112         {
113             this.parts = new java.util.ArrayList<Part>();
114         }
115 
116         return this.parts;
117     } //-- java.util.List<Part> getParts()
118 
119     /**
120      * Get the title name of this FAQ.
121      * 
122      * @return String
123      */
124     public String getTitle()
125     {
126         return this.title;
127     } //-- String getTitle()
128 
129     /**
130      * Method hashCode.
131      * 
132      * @return int
133      */
134     public int hashCode()
135     {
136         int result = 17;
137 
138         result = 37 * result + ( title != null ? title.hashCode() : 0 );
139         result = 37 * result + ( toplink ? 0 : 1 );
140         result = 37 * result + ( parts != null ? parts.hashCode() : 0 );
141 
142         return result;
143     } //-- int hashCode()
144 
145     /**
146      * Get boolean to generate optionally [top] links.
147      * 
148      * @return boolean
149      */
150     public boolean isToplink()
151     {
152         return this.toplink;
153     } //-- boolean isToplink()
154 
155     /**
156      * Method removePart.
157      * 
158      * @param part a part object.
159      */
160     public void removePart( Part part )
161     {
162         getParts().remove( part );
163     } //-- void removePart( Part )
164 
165     /**
166      * Set the modelEncoding field.
167      * 
168      * @param modelEncoding a modelEncoding object.
169      */
170     public void setModelEncoding( String modelEncoding )
171     {
172         this.modelEncoding = modelEncoding;
173     } //-- void setModelEncoding( String )
174 
175     /**
176      * Set list of FAQ part.
177      * 
178      * @param parts a parts object.
179      */
180     public void setParts( java.util.List<Part> parts )
181     {
182         this.parts = parts;
183     } //-- void setParts( java.util.List )
184 
185     /**
186      * Set the title name of this FAQ.
187      * 
188      * @param title a title object.
189      */
190     public void setTitle( String title )
191     {
192         this.title = title;
193     } //-- void setTitle( String )
194 
195     /**
196      * Set boolean to generate optionally [top] links.
197      * 
198      * @param toplink a toplink object.
199      */
200     public void setToplink( boolean toplink )
201     {
202         this.toplink = toplink;
203     } //-- void setToplink( boolean )
204 
205     /**
206      * Method toString.
207      * 
208      * @return String
209      */
210     public java.lang.String toString()
211     {
212         StringBuilder buf = new StringBuilder( 128 );
213 
214         buf.append( "title = '" );
215         buf.append( getTitle() );
216         buf.append( "'" );
217         buf.append( "\n" ); 
218         buf.append( "toplink = '" );
219         buf.append( isToplink() );
220         buf.append( "'" );
221         buf.append( "\n" ); 
222         buf.append( "parts = '" );
223         buf.append( getParts() );
224         buf.append( "'" );
225 
226         return buf.toString();
227     } //-- java.lang.String toString()
228 
229 }