001// =================== DO NOT EDIT THIS FILE ==================== 002// Generated by Modello 1.9.1, 003// any modifications will be overwritten. 004// ============================================================== 005 006package org.apache.maven.doxia.document; 007 008/** 009 * Describes the overall document model. 010 * 011 * @version $Revision$ $Date$ 012 */ 013@SuppressWarnings( "all" ) 014public class DocumentModel 015 implements java.io.Serializable 016{ 017 018 //--------------------------/ 019 //- Class/Member Variables -/ 020 //--------------------------/ 021 022 /** 023 * 024 * The name of the generated document, without 025 * extension. 026 * 027 */ 028 private String outputName; 029 030 /** 031 * 032 * The Meta information properties. 033 * 034 */ 035 private DocumentMeta meta; 036 037 /** 038 * 039 * The TOC (Table of Contents) information 040 * properties. 041 * 042 */ 043 private DocumentTOC toc; 044 045 /** 046 * 047 * The meta data to construct a cover page for the 048 * document. 049 * 050 */ 051 private DocumentCover cover; 052 053 /** 054 * Field modelEncoding. 055 */ 056 private String modelEncoding = "UTF-8"; 057 058 059 //-----------/ 060 //- Methods -/ 061 //-----------/ 062 063 /** 064 * Method equals. 065 * 066 * @param other 067 * @return boolean 068 */ 069 public boolean equals( Object other ) 070 { 071 if ( this == other ) 072 { 073 return true; 074 } 075 076 if ( !( other instanceof DocumentModel ) ) 077 { 078 return false; 079 } 080 081 DocumentModel that = (DocumentModel) other; 082 boolean result = true; 083 084 result = result && ( getOutputName() == null ? that.getOutputName() == null : getOutputName().equals( that.getOutputName() ) ); 085 result = result && ( getMeta() == null ? that.getMeta() == null : getMeta().equals( that.getMeta() ) ); 086 result = result && ( getToc() == null ? that.getToc() == null : getToc().equals( that.getToc() ) ); 087 result = result && ( getCover() == null ? that.getCover() == null : getCover().equals( that.getCover() ) ); 088 089 return result; 090 } //-- boolean equals( Object ) 091 092 /** 093 * Get the meta data to construct a cover page for the 094 * document. 095 * 096 * @return DocumentCover 097 */ 098 public DocumentCover getCover() 099 { 100 return this.cover; 101 } //-- DocumentCover getCover() 102 103 /** 104 * Get the Meta information properties. 105 * 106 * @return DocumentMeta 107 */ 108 public DocumentMeta getMeta() 109 { 110 return this.meta; 111 } //-- DocumentMeta getMeta() 112 113 /** 114 * Get the modelEncoding field. 115 * 116 * @return String 117 */ 118 public String getModelEncoding() 119 { 120 return this.modelEncoding; 121 } //-- String getModelEncoding() 122 123 /** 124 * Get the name of the generated document, without extension. 125 * 126 * @return String 127 */ 128 public String getOutputName() 129 { 130 return this.outputName; 131 } //-- String getOutputName() 132 133 /** 134 * Get the TOC (Table of Contents) information properties. 135 * 136 * @return DocumentTOC 137 */ 138 public DocumentTOC getToc() 139 { 140 return this.toc; 141 } //-- DocumentTOC getToc() 142 143 /** 144 * Method hashCode. 145 * 146 * @return int 147 */ 148 public int hashCode() 149 { 150 int result = 17; 151 152 result = 37 * result + ( outputName != null ? outputName.hashCode() : 0 ); 153 result = 37 * result + ( meta != null ? meta.hashCode() : 0 ); 154 result = 37 * result + ( toc != null ? toc.hashCode() : 0 ); 155 result = 37 * result + ( cover != null ? cover.hashCode() : 0 ); 156 157 return result; 158 } //-- int hashCode() 159 160 /** 161 * Set the meta data to construct a cover page for the 162 * document. 163 * 164 * @param cover 165 */ 166 public void setCover( DocumentCover cover ) 167 { 168 this.cover = cover; 169 } //-- void setCover( DocumentCover ) 170 171 /** 172 * Set the Meta information properties. 173 * 174 * @param meta 175 */ 176 public void setMeta( DocumentMeta meta ) 177 { 178 this.meta = meta; 179 } //-- void setMeta( DocumentMeta ) 180 181 /** 182 * Set the modelEncoding field. 183 * 184 * @param modelEncoding 185 */ 186 public void setModelEncoding( String modelEncoding ) 187 { 188 this.modelEncoding = modelEncoding; 189 } //-- void setModelEncoding( String ) 190 191 /** 192 * Set the name of the generated document, without extension. 193 * 194 * @param outputName 195 */ 196 public void setOutputName( String outputName ) 197 { 198 this.outputName = outputName; 199 } //-- void setOutputName( String ) 200 201 /** 202 * Set the TOC (Table of Contents) information properties. 203 * 204 * @param toc 205 */ 206 public void setToc( DocumentTOC toc ) 207 { 208 this.toc = toc; 209 } //-- void setToc( DocumentTOC ) 210 211 /** 212 * Method toString. 213 * 214 * @return String 215 */ 216 public java.lang.String toString() 217 { 218 StringBuilder buf = new StringBuilder( 128 ); 219 220 buf.append( "outputName = '" ); 221 buf.append( getOutputName() ); 222 buf.append( "'" ); 223 buf.append( "\n" ); 224 buf.append( "meta = '" ); 225 buf.append( getMeta() ); 226 buf.append( "'" ); 227 buf.append( "\n" ); 228 buf.append( "toc = '" ); 229 buf.append( getToc() ); 230 buf.append( "'" ); 231 buf.append( "\n" ); 232 buf.append( "cover = '" ); 233 buf.append( getCover() ); 234 buf.append( "'" ); 235 236 return buf.toString(); 237 } //-- java.lang.String toString() 238 239}