1 // =================== DO NOT EDIT THIS FILE ==================== 2 // Generated by Modello 1.10.0, 3 // any modifications will be overwritten. 4 // ============================================================== 5 6 package org.apache.maven.model; 7 8 /** 9 * Contains the information needed for deploying websites. 10 * 11 * @version $Revision$ $Date$ 12 */ 13 @SuppressWarnings( "all" ) 14 public class Site 15 implements java.io.Serializable, java.lang.Cloneable, org.apache.maven.model.InputLocationTracker 16 { 17 18 //--------------------------/ 19 //- Class/Member Variables -/ 20 //--------------------------/ 21 22 /** 23 * 24 * 25 * A unique identifier for a deployment location. 26 * This is used to match the 27 * site to configuration in the 28 * <code>settings.xml</code> file, for example. 29 * 30 * 31 */ 32 private String id; 33 34 /** 35 * Human readable name of the deployment location. 36 */ 37 private String name; 38 39 /** 40 * 41 * 42 * The url of the location where website is 43 * deployed, in the form <code>protocol://hostname/path</code>. 44 * <br><b>Default value is</b>: parent value [+ 45 * path adjustment] + (artifactId or project.directory 46 * property), or just parent value if 47 * site's 48 * <code>child.site.url.inherit.append.path="false"</code> 49 * 50 * 51 */ 52 private String url; 53 54 /** 55 * 56 * 57 * When childs inherit from distribution management 58 * site url, append path or not? Note: While the type 59 * of this field is <code>String</code> for 60 * technical reasons, the semantic type is actually 61 * <code>Boolean</code> 62 * <br><b>Default value is</b>: <code>true</code> 63 * <br><b>Since</b>: Maven 3.6.1 64 * 65 * . 66 */ 67 private String childSiteUrlInheritAppendPath; 68 69 /** 70 * Field locations. 71 */ 72 private java.util.Map<Object, InputLocation> locations; 73 74 75 //-----------/ 76 //- Methods -/ 77 //-----------/ 78 79 /** 80 * Method clone. 81 * 82 * @return Site 83 */ 84 public Site clone() 85 { 86 try 87 { 88 Site copy = (Site) super.clone(); 89 90 if ( copy.locations != null ) 91 { 92 copy.locations = new java.util.LinkedHashMap( copy.locations ); 93 } 94 95 return copy; 96 } 97 catch ( java.lang.Exception ex ) 98 { 99 throw (java.lang.RuntimeException) new java.lang.UnsupportedOperationException( getClass().getName() 100 + " does not support clone()" ).initCause( ex ); 101 } 102 } //-- Site clone() 103 104 /** 105 * Get when childs inherit from distribution management site 106 * url, append path or not? Note: While the type 107 * of this field is <code>String</code> for 108 * technical reasons, the semantic type is actually 109 * <code>Boolean</code> 110 * <br><b>Default value is</b>: <code>true</code> 111 * <br><b>Since</b>: Maven 3.6.1. 112 * 113 * @return String 114 */ 115 public String getChildSiteUrlInheritAppendPath() 116 { 117 return this.childSiteUrlInheritAppendPath; 118 } //-- String getChildSiteUrlInheritAppendPath() 119 120 /** 121 * Get a unique identifier for a deployment location. This is 122 * used to match the 123 * site to configuration in the 124 * <code>settings.xml</code> file, for example. 125 * 126 * @return String 127 */ 128 public String getId() 129 { 130 return this.id; 131 } //-- String getId() 132 133 /** 134 * 135 * 136 * @param key 137 * @return InputLocation 138 */ 139 public InputLocation getLocation( Object key ) 140 { 141 return ( locations != null ) ? locations.get( key ) : null; 142 } //-- InputLocation getLocation( Object ) 143 144 /** 145 * Get human readable name of the deployment location. 146 * 147 * @return String 148 */ 149 public String getName() 150 { 151 return this.name; 152 } //-- String getName() 153 154 /** 155 * Get the url of the location where website is deployed, in 156 * the form <code>protocol://hostname/path</code>. 157 * <br><b>Default value is</b>: parent value [+ 158 * path adjustment] + (artifactId or project.directory 159 * property), or just parent value if 160 * site's 161 * <code>child.site.url.inherit.append.path="false"</code> 162 * 163 * @return String 164 */ 165 public String getUrl() 166 { 167 return this.url; 168 } //-- String getUrl() 169 170 /** 171 * Set when childs inherit from distribution management site 172 * url, append path or not? Note: While the type 173 * of this field is <code>String</code> for 174 * technical reasons, the semantic type is actually 175 * <code>Boolean</code> 176 * <br><b>Default value is</b>: <code>true</code> 177 * <br><b>Since</b>: Maven 3.6.1. 178 * 179 * @param childSiteUrlInheritAppendPath 180 */ 181 public void setChildSiteUrlInheritAppendPath( String childSiteUrlInheritAppendPath ) 182 { 183 this.childSiteUrlInheritAppendPath = childSiteUrlInheritAppendPath; 184 } //-- void setChildSiteUrlInheritAppendPath( String ) 185 186 /** 187 * Set a unique identifier for a deployment location. This is 188 * used to match the 189 * site to configuration in the 190 * <code>settings.xml</code> file, for example. 191 * 192 * @param id 193 */ 194 public void setId( String id ) 195 { 196 this.id = id; 197 } //-- void setId( String ) 198 199 /** 200 * 201 * 202 * @param key 203 * @param location 204 */ 205 public void setLocation( Object key, InputLocation location ) 206 { 207 if ( location != null ) 208 { 209 if ( this.locations == null ) 210 { 211 this.locations = new java.util.LinkedHashMap<Object, InputLocation>(); 212 } 213 this.locations.put( key, location ); 214 } 215 } //-- void setLocation( Object, InputLocation ) 216 217 /** 218 * Set human readable name of the deployment location. 219 * 220 * @param name 221 */ 222 public void setName( String name ) 223 { 224 this.name = name; 225 } //-- void setName( String ) 226 227 /** 228 * Set the url of the location where website is deployed, in 229 * the form <code>protocol://hostname/path</code>. 230 * <br><b>Default value is</b>: parent value [+ 231 * path adjustment] + (artifactId or project.directory 232 * property), or just parent value if 233 * site's 234 * <code>child.site.url.inherit.append.path="false"</code> 235 * 236 * @param url 237 */ 238 public void setUrl( String url ) 239 { 240 this.url = url; 241 } //-- void setUrl( String ) 242 243 244 245 246 public boolean isChildSiteUrlInheritAppendPath() 247 { 248 return ( childSiteUrlInheritAppendPath != null ) ? Boolean.parseBoolean( childSiteUrlInheritAppendPath ) : true; 249 } 250 251 public void setChildSiteUrlInheritAppendPath( boolean childSiteUrlInheritAppendPath ) 252 { 253 this.childSiteUrlInheritAppendPath = String.valueOf( childSiteUrlInheritAppendPath ); 254 } 255 256 257 258 }