View Javadoc

1   /*
2    =================== DO NOT EDIT THIS FILE ====================
3    Generated by Modello 1.4.1 on 2012-04-13 21:33:05,
4    any modifications will be overwritten.
5    ==============================================================
6    */
7   
8   package org.apache.maven.doxia.document;
9   
10  /**
11   * Describes the overall document model.
12   * 
13   * @version $Revision$ $Date$
14   */
15  @SuppressWarnings( "all" )
16  public class DocumentModel
17      implements java.io.Serializable
18  {
19  
20        //--------------------------/
21       //- Class/Member Variables -/
22      //--------------------------/
23  
24      /**
25       * 
26       *             The name of the generated document, without
27       * extension.
28       *           
29       */
30      private String outputName;
31  
32      /**
33       * 
34       *             The Meta information properties.
35       *           
36       */
37      private DocumentMeta meta;
38  
39      /**
40       * 
41       *             The TOC (Table of Contents) information
42       * properties.
43       *           
44       */
45      private DocumentTOC toc;
46  
47      /**
48       * 
49       *             The meta data to construct a cover page for the
50       * document.
51       *           
52       */
53      private DocumentCover cover;
54  
55      /**
56       * Field modelEncoding.
57       */
58      private String modelEncoding = "UTF-8";
59  
60  
61        //-----------/
62       //- Methods -/
63      //-----------/
64  
65      /**
66       * Method equals.
67       * 
68       * @param other
69       * @return boolean
70       */
71      public boolean equals( Object other )
72      {
73          if ( this == other )
74          {
75              return true;
76          }
77  
78          if ( !( other instanceof DocumentModel ) )
79          {
80              return false;
81          }
82  
83          DocumentModel that = (DocumentModel) other;
84          boolean result = true;
85  
86          result = result && ( getOutputName() == null ? that.getOutputName() == null : getOutputName().equals( that.getOutputName() ) );
87          result = result && ( getMeta() == null ? that.getMeta() == null : getMeta().equals( that.getMeta() ) );
88          result = result && ( getToc() == null ? that.getToc() == null : getToc().equals( that.getToc() ) );
89          result = result && ( getCover() == null ? that.getCover() == null : getCover().equals( that.getCover() ) );
90  
91          return result;
92      } //-- boolean equals( Object )
93  
94      /**
95       * Get the meta data to construct a cover page for the
96       * document.
97       * 
98       * @return DocumentCover
99       */
100     public DocumentCover getCover()
101     {
102         return this.cover;
103     } //-- DocumentCover getCover()
104 
105     /**
106      * Get the Meta information properties.
107      * 
108      * @return DocumentMeta
109      */
110     public DocumentMeta getMeta()
111     {
112         return this.meta;
113     } //-- DocumentMeta getMeta()
114 
115     /**
116      * Get the modelEncoding field.
117      * 
118      * @return String
119      */
120     public String getModelEncoding()
121     {
122         return this.modelEncoding;
123     } //-- String getModelEncoding()
124 
125     /**
126      * Get the name of the generated document, without extension.
127      * 
128      * @return String
129      */
130     public String getOutputName()
131     {
132         return this.outputName;
133     } //-- String getOutputName()
134 
135     /**
136      * Get the TOC (Table of Contents) information properties.
137      * 
138      * @return DocumentTOC
139      */
140     public DocumentTOC getToc()
141     {
142         return this.toc;
143     } //-- DocumentTOC getToc()
144 
145     /**
146      * Method hashCode.
147      * 
148      * @return int
149      */
150     public int hashCode()
151     {
152         int result = 17;
153 
154         result = 37 * result + ( outputName != null ? outputName.hashCode() : 0 );
155         result = 37 * result + ( meta != null ? meta.hashCode() : 0 );
156         result = 37 * result + ( toc != null ? toc.hashCode() : 0 );
157         result = 37 * result + ( cover != null ? cover.hashCode() : 0 );
158 
159         return result;
160     } //-- int hashCode()
161 
162     /**
163      * Set the meta data to construct a cover page for the
164      * document.
165      * 
166      * @param cover
167      */
168     public void setCover( DocumentCover cover )
169     {
170         this.cover = cover;
171     } //-- void setCover( DocumentCover )
172 
173     /**
174      * Set the Meta information properties.
175      * 
176      * @param meta
177      */
178     public void setMeta( DocumentMeta meta )
179     {
180         this.meta = meta;
181     } //-- void setMeta( DocumentMeta )
182 
183     /**
184      * Set the modelEncoding field.
185      * 
186      * @param modelEncoding
187      */
188     public void setModelEncoding( String modelEncoding )
189     {
190         this.modelEncoding = modelEncoding;
191     } //-- void setModelEncoding( String )
192 
193     /**
194      * Set the name of the generated document, without extension.
195      * 
196      * @param outputName
197      */
198     public void setOutputName( String outputName )
199     {
200         this.outputName = outputName;
201     } //-- void setOutputName( String )
202 
203     /**
204      * Set the TOC (Table of Contents) information properties.
205      * 
206      * @param toc
207      */
208     public void setToc( DocumentTOC toc )
209     {
210         this.toc = toc;
211     } //-- void setToc( DocumentTOC )
212 
213     /**
214      * Method toString.
215      * 
216      * @return String
217      */
218     public java.lang.String toString()
219     {
220         StringBuilder buf = new StringBuilder( 128 );
221 
222         buf.append( "outputName = '" );
223         buf.append( getOutputName() );
224         buf.append( "'" );
225         buf.append( "\n" ); 
226         buf.append( "meta = '" );
227         buf.append( getMeta() );
228         buf.append( "'" );
229         buf.append( "\n" ); 
230         buf.append( "toc = '" );
231         buf.append( getToc() );
232         buf.append( "'" );
233         buf.append( "\n" ); 
234         buf.append( "cover = '" );
235         buf.append( getCover() );
236         buf.append( "'" );
237 
238         return buf.toString();
239     } //-- java.lang.String toString()
240 
241 }