rename local path to base path
[jSite2.git] / src / net / pterodactylus / jsite / project / Project.java
1 /*
2  * jSite2 - Project.java -
3  * Copyright © 2008 David Roden
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 2 of the License, or
8  * (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
18  */
19
20 package net.pterodactylus.jsite.project;
21
22 import java.beans.PropertyChangeListener;
23
24 import net.pterodactylus.util.beans.AbstractBean;
25
26 /**
27  * Container for project information. A Project is capable of notifying
28  * {@link PropertyChangeListener}s if any of the contained properties change.
29  * 
30  * @author David ‘Bombe’ Roden <bombe@freenetproject.org>
31  * @version $Id$
32  */
33 public class Project extends AbstractBean {
34
35         /** Name of the “name” property. */
36         public static final String PROPERTY_NAME = "name";
37
38         /** Name of the “description” property. */
39         public static final String PROPERTY_DESCRIPTION = "description";
40
41         /** Name of the “public key” property. */
42         public static final String PROPERTY_PUBLIC_KEY = "publicKey";
43
44         /** Name of the “private key” property. */
45         public static final String PROPERTY_PRIVATE_KEY = "privateKey";
46
47         /** Name of the “local path” property. */
48         public static final String PROPERTY_BASE_PATH = "basePath";
49
50         /** The name of the project. */
51         private String name;
52
53         /** The description of the project. */
54         private String description;
55
56         /** The public key. */
57         private String publicKey;
58
59         /** The private key. */
60         private String privateKey;
61
62         /** The base path of the project. */
63         private String basePath;
64
65         //
66         // EVENT MANAGEMENT
67         //
68
69         /**
70          * Returns the name of the project.
71          * 
72          * @return The name of the project
73          */
74         public String getName() {
75                 return name;
76         }
77
78         /**
79          * Sets the name of the project.
80          * 
81          * @param name
82          *            The name of the project
83          */
84         public void setName(String name) {
85                 String oldName = this.name;
86                 this.name = name;
87                 fireIfPropertyChanged(PROPERTY_NAME, oldName, name);
88         }
89
90         /**
91          * Returns the description of the project.
92          * 
93          * @return The description of the project
94          */
95         public String getDescription() {
96                 return description;
97         }
98
99         /**
100          * Sets the description of the project
101          * 
102          * @param description
103          *            The description of the project
104          */
105         public void setDescription(String description) {
106                 String oldDescription = this.description;
107                 this.description = description;
108                 fireIfPropertyChanged(PROPERTY_DESCRIPTION, oldDescription, description);
109         }
110
111         /**
112          * Returns the public key of the project.
113          * 
114          * @return The public key of the project
115          */
116         public String getPublicKey() {
117                 return publicKey;
118         }
119
120         /**
121          * Sets the public key of the project.
122          * 
123          * @param publicKey
124          *            The public key of the project
125          */
126         public void setPublicKey(String publicKey) {
127                 String oldPublicKey = this.publicKey;
128                 this.publicKey = publicKey;
129                 fireIfPropertyChanged(PROPERTY_PUBLIC_KEY, oldPublicKey, publicKey);
130         }
131
132         /**
133          * Returns the private key of the project.
134          * 
135          * @return The private key of the project
136          */
137         public String getPrivateKey() {
138                 return privateKey;
139         }
140
141         /**
142          * Sets the private key of the project.
143          * 
144          * @param privateKey
145          *            The private key of the project
146          */
147         public void setPrivateKey(String privateKey) {
148                 String oldPrivateKey = this.privateKey;
149                 this.privateKey = privateKey;
150                 fireIfPropertyChanged(PROPERTY_PRIVATE_KEY, oldPrivateKey, privateKey);
151         }
152
153         /**
154          * Returns the base path of the project.
155          * 
156          * @return The base path of the project
157          */
158         public String getBasePath() {
159                 return basePath;
160         }
161
162         /**
163          * Sets the base path of the project.
164          * 
165          * @param basePath
166          *            The base path of the project
167          */
168         public void setBasePath(String basePath) {
169                 String oldBasePath = this.basePath;
170                 this.basePath = basePath;
171                 fireIfPropertyChanged(PROPERTY_BASE_PATH, oldBasePath, basePath);
172         }
173
174 }