View Javadoc

1   /*
2    * $Id$
3    */
4   
5   package org.apache.maven.model;
6   
7     //---------------------------------/
8    //- Imported classes and packages -/
9   //---------------------------------/
10  
11  import java.util.Date;
12  
13  /**
14   * Contains the information needed for deploying websites.
15   * 
16   * @version $Revision$ $Date$
17   */
18  public class Site implements java.io.Serializable {
19  
20  
21        //--------------------------/
22       //- Class/Member Variables -/
23      //--------------------------/
24  
25      /**
26       * 
27       *             
28       *             A unique identifier for a deployment location.
29       * This is used to match the
30       *             site to configuration in the
31       * <code>settings.xml</code> file, for example.
32       *             
33       *           
34       */
35      private String id;
36  
37      /**
38       * Human readable name of the deployment location.
39       */
40      private String name;
41  
42      /**
43       * 
44       *             
45       *             The url of the location where website is
46       * deployed, in the form <code>protocol://hostname/path</code>.
47       *             
48       *           
49       */
50      private String url;
51  
52  
53        //-----------/
54       //- Methods -/
55      //-----------/
56  
57      /**
58       * Get 
59       *             
60       *             A unique identifier for a deployment location.
61       * This is used to match the
62       *             site to configuration in the
63       * <code>settings.xml</code> file, for example.
64       *             
65       *           
66       * 
67       * @return String
68       */
69      public String getId()
70      {
71          return this.id;
72      } //-- String getId() 
73  
74      /**
75       * Get human readable name of the deployment location.
76       * 
77       * @return String
78       */
79      public String getName()
80      {
81          return this.name;
82      } //-- String getName() 
83  
84      /**
85       * Get 
86       *             
87       *             The url of the location where website is
88       * deployed, in the form <code>protocol://hostname/path</code>.
89       *             
90       *           
91       * 
92       * @return String
93       */
94      public String getUrl()
95      {
96          return this.url;
97      } //-- String getUrl() 
98  
99      /**
100      * Set 
101      *             
102      *             A unique identifier for a deployment location.
103      * This is used to match the
104      *             site to configuration in the
105      * <code>settings.xml</code> file, for example.
106      *             
107      *           
108      * 
109      * @param id
110      */
111     public void setId( String id )
112     {
113         this.id = id;
114     } //-- void setId( String ) 
115 
116     /**
117      * Set human readable name of the deployment location.
118      * 
119      * @param name
120      */
121     public void setName( String name )
122     {
123         this.name = name;
124     } //-- void setName( String ) 
125 
126     /**
127      * Set 
128      *             
129      *             The url of the location where website is
130      * deployed, in the form <code>protocol://hostname/path</code>.
131      *             
132      *           
133      * 
134      * @param url
135      */
136     public void setUrl( String url )
137     {
138         this.url = url;
139     } //-- void setUrl( String ) 
140 
141 
142     private String modelEncoding = "UTF-8";
143 
144     /**
145      * Set an encoding used for reading/writing the model.
146      *
147      * @param modelEncoding the encoding used when reading/writing the model.
148      */
149     public void setModelEncoding( String modelEncoding )
150     {
151         this.modelEncoding = modelEncoding;
152     }
153 
154     /**
155      * @return the current encoding used when reading/writing this model.
156      */
157     public String getModelEncoding()
158     {
159         return modelEncoding;
160     }
161 }