forked from oliviercailloux/Apartments
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #10 from av1m/SMPO-MajChangeLog
SM/PO : Maj change log
- Loading branch information
Showing
1 changed file
with
100 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,103 @@ | ||
= Changelog | ||
|
||
This file notes all the modifications (a minimum important) made on the java code | ||
|
||
|
||
|
||
* link:changelog.adoc#unreleased-incoming-changes[Unreleased] : Incoming changes | ||
* link:changelog.adoc#first-iteration---04202020[Iteration 1] : Changes done in the first iteration | ||
== *Unreleased*: Incoming changes | ||
|
||
* *Changes :* _ApartmentFactory:generateApartmentFromJsonPath(Path)_ : The name of this function will be changed to generateApartment**s**FromJsonPath(Path) | ||
* *Deletion* of *_ApartmentGenerator_* class | ||
* *Changes :* _readApartmentXMLFormat_ will use default values set in _Apartment_ class instead of using those specified in the class. | ||
* *Security :* _formApartmentGUI_ Checks if values writen in the form, without any spaces before and after, are not empty. | ||
|
||
== First Iteration - 04/20/2020 | ||
|
||
|
||
* Dependency changes | ||
** *Removed :* | ||
*** _com.google.code.gson_ > _gson_ | ||
*** _com.squareup.okhttp3_ > _okhttp_ | ||
*** _joda-time_ > _joda-time_ | ||
*** _org.joda_ > _joda-convert_ | ||
*** _junit_ > _junit_ | ||
|
||
** *Added :* | ||
*** _javax.json.bind_ > _javax.json.bind-api_ version *1.0* | ||
*** _org.eclipse_ > _yasson_ version *1.0* | ||
*** _org.glassfish_ > _javax.json_ version *1.1.4* | ||
*** _javax.json_ > _javax.json-api version *1.1* | ||
*** _org.junit.jupiter_ > _junit-jupiter-api_ *5.4.2* | ||
|
||
** *Updated :* | ||
*** _org.slf4j_ > _slf4j-api_ from *1.7.26* -> *1.7.30* | ||
*** _com.google.guava_ > _guava_ from *27.1-jre* -> *29.0-jre* | ||
*** _org.eclipse.platform_ > _org.eclipse.jface_ from *3.15.100* -> *3.19.0* | ||
*** _com.google.maps_ > _google-maps-services_ from *0.9.0* -> *0.11.0* | ||
*** _org.eclipse.platform_ > _org.eclipse.core.commands_ from *3.9.200* -> *3.9.700* | ||
*** _org.eclipse.platform_ > _org.eclipse.equinox.common_ from *3.10.0* -> *3.11.0* | ||
*** *BUILD :* _maven-surefire-plugin_ from *2.22.1* -> *2.22.2* | ||
|
||
* Package *_apartment_* | ||
|
||
** Class *_ApartmentGenerator_ -> Depercated :* use _ApartmentFactory_ instead. | ||
|
||
|
||
** Class *_Apartment_* : | ||
|
||
*** *Removed :* Deletion of _Apartment_ constructor -> Need to use the _Apartment.Builder_ class. | ||
*** *Added :* _Apartment.Builder:setDescription(String description)_ | ||
*** *Added :* _Apartment.Builder:setWifi(boolean wifi)_ | ||
*** *Added :* _Apartment.Builder:setTele(boolean tele)_ | ||
*** *Security :* An address cannot longer be a _null_ value. | ||
*** *Security :* Use of _Apartment_ checks while using Apartment.Builder's setters. | ||
*** *Fixed :* Apartment instances are now immutable : All setters of the Apartment class are now in private access. | ||
*** *Changed :* While creating a apartment using Builder class, you need to specify WIFI and TV availability. | ||
*** *Changed :* _getTerrace()_, _getWifi()_ & _getTele()_ return now a Boolean object and no longer a primitive java boolean type value. | ||
*** *Changed :* setFloorAreaTerrace(double d) --> d must be > 0. | ||
|
||
|
||
** Class *_ApartmentFactory_ -> Added* : | ||
|
||
*** *Added :* _generateRandomRealApartment()_ throws _IOException_ returns _Apartment_ : Get a random apartment with a real address or throws IOException if the API is not available. | ||
*** *Added :* _generateRandomApartment()_ returns _Apartment_ : Get a random apartment with a real address iff the API is available or a fake one in the other case. | ||
*** *Added :* _generateRandomRealApartments(int n)_ throws _IOException_ returns _List<Apartment>_ : Get a _List_ of _n_ random apartments with really existing addresses or throws IOException if the API is not available. | ||
*** *Added :* _generateRandomApartments(int n)_ returns _List<Apartment>_ : Get a _List_ of _n_ random apartments with really existing addresses iff the API is available or a fake one in the other case. | ||
*** *Added :* _generateApartmentFromJsonPath(Path p)_ throws _IOException_ returns _List<Apartment>_ : Get a _List_ of _Apartment_ from a file Path given in argument. Throws a _IOException_ if the Path given does not point to any file. | ||
*** *Added :* _getDefaultApartments()_ throws _IOException_ returns _List<Apartment>_ : Get a _List_ of _Apartment_ from the default json file containing apartments. | ||
|
||
|
||
* Package *_utils_* | ||
|
||
** Class *_JsonConvert_ -> Added :* | ||
|
||
*** *Added :* void _apartmentToJson(Apartment a)_ throws _IOException_ : Save an _Apartment_ to the default json file containing apartments. | ||
*** *Added :* void _apartmentToJson(Apartment a, Path jsonPath)_ : Save an _Apartment_ to the default json file containing apartments. | ||
*** *Added :* _getAddressFromJson(String json)_ returns _String_ : Extract the "address" field from a Json string | ||
*** *Added :* _jsonToApartment(Path p)_ throws _IOException_ returns _Apartment_ : return an Apartment instance corresponding to the informations of the json file _p_. An IOException is thrown if Path given does not point to any file. | ||
*** *Added :* _jsonToApartments()_ throws _IOException_ return _List<Apartment>_ : Get a _List_ of _Apartment_ from the default json file containing apartments. An IOException is thrown if the default file does not exist. | ||
*** *Added :* _jsonToApartments(Path p)_ throws _IOException_ returns _List<Apartment>_ : Get a _List_ of _Apartment_ from the json file path containing apartments given. | ||
*** *Added :* void _apartmentsToJson(List<Apartment> l)_ throws _IOException_ : Save a _List_ of _Apartment_ to the default json recording file. Throws an IOException if the default file is not available. | ||
*** *Added :* void _apartmentsToJson(List<Apartment> l, Path p)_ throws _IOException_ : Save a _List_ of _Apartment_ to the json recording file _p_ given in parameters. Throws an IOException if the _p_ does not point to any file. | ||
|
||
* Package *_readapartments_* | ||
|
||
** Class *_readApartmentXMLFormat_ :* | ||
|
||
*** *Changes :* An apartment is build with default values if the XML content does not contains optional field. | ||
|
||
* Package *_gui_* | ||
|
||
** Class *_LayoutApartementGUI_ :* | ||
|
||
*** *Changes :* Use _generateRandomRealApartments(int n)_ to generate a _List_ of random _Apartment_. | ||
|
||
** Class *_FormApartmentGUI_ :* | ||
|
||
*** *Changes :* Check if _int_ values without any space before and after are not empty. | ||
|
||
|
||
|