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   * This is an activator which will detect an operating system's
15   * attributes in order
16   *         to activate its profile.
17   * 
18   * @version $Revision$ $Date$
19   */
20  public class ActivationOS implements java.io.Serializable {
21  
22  
23        //--------------------------/
24       //- Class/Member Variables -/
25      //--------------------------/
26  
27      /**
28       * 
29       *             
30       *             The name of the operating system to be used to
31       * activate the profile. This must be an exact match
32       *             of the <code>${os.name}</code> Java property,
33       * such as <code>Windows XP</code>.
34       *             
35       *           
36       */
37      private String name;
38  
39      /**
40       * 
41       *             
42       *             The general family of the OS to be used to
43       * activate the profile, such as
44       *             <code>windows</code> or <code>unix</code>.
45       *             
46       *           
47       */
48      private String family;
49  
50      /**
51       * The architecture of the operating system to be used to
52       * activate the
53       *           profile.
54       */
55      private String arch;
56  
57      /**
58       * The version of the operating system to be used to activate
59       * the
60       *           profile.
61       */
62      private String version;
63  
64  
65        //-----------/
66       //- Methods -/
67      //-----------/
68  
69      /**
70       * Get the architecture of the operating system to be used to
71       * activate the
72       *           profile.
73       * 
74       * @return String
75       */
76      public String getArch()
77      {
78          return this.arch;
79      } //-- String getArch() 
80  
81      /**
82       * Get 
83       *             
84       *             The general family of the OS to be used to
85       * activate the profile, such as
86       *             <code>windows</code> or <code>unix</code>.
87       *             
88       *           
89       * 
90       * @return String
91       */
92      public String getFamily()
93      {
94          return this.family;
95      } //-- String getFamily() 
96  
97      /**
98       * Get 
99       *             
100      *             The name of the operating system to be used to
101      * activate the profile. This must be an exact match
102      *             of the <code>${os.name}</code> Java property,
103      * such as <code>Windows XP</code>.
104      *             
105      *           
106      * 
107      * @return String
108      */
109     public String getName()
110     {
111         return this.name;
112     } //-- String getName() 
113 
114     /**
115      * Get the version of the operating system to be used to
116      * activate the
117      *           profile.
118      * 
119      * @return String
120      */
121     public String getVersion()
122     {
123         return this.version;
124     } //-- String getVersion() 
125 
126     /**
127      * Set the architecture of the operating system to be used to
128      * activate the
129      *           profile.
130      * 
131      * @param arch
132      */
133     public void setArch( String arch )
134     {
135         this.arch = arch;
136     } //-- void setArch( String ) 
137 
138     /**
139      * Set 
140      *             
141      *             The general family of the OS to be used to
142      * activate the profile, such as
143      *             <code>windows</code> or <code>unix</code>.
144      *             
145      *           
146      * 
147      * @param family
148      */
149     public void setFamily( String family )
150     {
151         this.family = family;
152     } //-- void setFamily( String ) 
153 
154     /**
155      * Set 
156      *             
157      *             The name of the operating system to be used to
158      * activate the profile. This must be an exact match
159      *             of the <code>${os.name}</code> Java property,
160      * such as <code>Windows XP</code>.
161      *             
162      *           
163      * 
164      * @param name
165      */
166     public void setName( String name )
167     {
168         this.name = name;
169     } //-- void setName( String ) 
170 
171     /**
172      * Set the version of the operating system to be used to
173      * activate the
174      *           profile.
175      * 
176      * @param version
177      */
178     public void setVersion( String version )
179     {
180         this.version = version;
181     } //-- void setVersion( String ) 
182 
183 
184     private String modelEncoding = "UTF-8";
185 
186     /**
187      * Set an encoding used for reading/writing the model.
188      *
189      * @param modelEncoding the encoding used when reading/writing the model.
190      */
191     public void setModelEncoding( String modelEncoding )
192     {
193         this.modelEncoding = modelEncoding;
194     }
195 
196     /**
197      * @return the current encoding used when reading/writing this model.
198      */
199     public String getModelEncoding()
200     {
201         return modelEncoding;
202     }
203 }