View Javadoc
1   // =================== DO NOT EDIT THIS FILE ====================
2   // Generated by Modello 1.9.1,
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
46       * <code>project.directory</code> property), or just parent
47       * value if 
48       *            
49       * <code>child.urls.inherit.append.path="false"</code>
50       *             
51       *           
52       */
53      private String url;
54  
55      /**
56       * 
57       *             
58       *             When childs inherit from urls, append path or
59       * not?. Note: While the type
60       *             of this field is <code>String</code> for
61       * technical reasons, the semantic type is actually
62       *             <code>Boolean</code>
63       *             <br /><b>Default value is</b>: <code>true</code>
64       *             
65       *           
66       */
67      private String childInheritAppendPath;
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 urls, append path or not?.
106      * 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      * 
112      * @return String
113      */
114     public String getChildInheritAppendPath()
115     {
116         return this.childInheritAppendPath;
117     } //-- String getChildInheritAppendPath()
118 
119     /**
120      * Get a unique identifier for a deployment location. This is
121      * used to match the
122      *             site to configuration in the
123      * <code>settings.xml</code> file, for example.
124      * 
125      * @return String
126      */
127     public String getId()
128     {
129         return this.id;
130     } //-- String getId()
131 
132     /**
133      * 
134      * 
135      * @param key
136      * @return InputLocation
137      */
138     public InputLocation getLocation( Object key )
139     {
140         return ( locations != null ) ? locations.get( key ) : null;
141     } //-- InputLocation getLocation( Object )
142 
143     /**
144      * Get human readable name of the deployment location.
145      * 
146      * @return String
147      */
148     public String getName()
149     {
150         return this.name;
151     } //-- String getName()
152 
153     /**
154      * Get the url of the location where website is deployed, in
155      * the form <code>protocol://hostname/path</code>.
156      *             <br><b>Default value is</b>: parent value [+
157      * path adjustment] + (artifactId or
158      * <code>project.directory</code> property), or just parent
159      * value if 
160      *            
161      * <code>child.urls.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 urls, append path or not?.
172      * 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      * 
178      * @param childInheritAppendPath
179      */
180     public void setChildInheritAppendPath( String childInheritAppendPath )
181     {
182         this.childInheritAppendPath = childInheritAppendPath;
183     } //-- void setChildInheritAppendPath( String )
184 
185     /**
186      * Set a unique identifier for a deployment location. This is
187      * used to match the
188      *             site to configuration in the
189      * <code>settings.xml</code> file, for example.
190      * 
191      * @param id
192      */
193     public void setId( String id )
194     {
195         this.id = id;
196     } //-- void setId( String )
197 
198     /**
199      * 
200      * 
201      * @param key
202      * @param location
203      */
204     public void setLocation( Object key, InputLocation location )
205     {
206         if ( location != null )
207         {
208             if ( this.locations == null )
209             {
210                 this.locations = new java.util.LinkedHashMap<Object, InputLocation>();
211             }
212             this.locations.put( key, location );
213         }
214     } //-- void setLocation( Object, InputLocation )
215 
216     /**
217      * Set human readable name of the deployment location.
218      * 
219      * @param name
220      */
221     public void setName( String name )
222     {
223         this.name = name;
224     } //-- void setName( String )
225 
226     /**
227      * Set the url of the location where website is deployed, in
228      * the form <code>protocol://hostname/path</code>.
229      *             <br><b>Default value is</b>: parent value [+
230      * path adjustment] + (artifactId or
231      * <code>project.directory</code> property), or just parent
232      * value if 
233      *            
234      * <code>child.urls.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     public boolean isChildInheritAppendPath()
246     {
247         return ( childInheritAppendPath != null ) ? Boolean.parseBoolean( childInheritAppendPath ) : true;
248     }
249 
250     public void setChildInheritAppendPath( boolean childInheritAppendPath )
251     {
252         this.childInheritAppendPath = String.valueOf( childInheritAppendPath );
253     }
254             
255           
256 }