Merge branch 'GP-28_add_README_into_main' into GP-28_Migrate_File_Reader_into_exercise/completed

Author: shryhus

2-0-data-structures-and-algorithms/pom.xml

@@ -3,6 +3,14 @@
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
     <modelVersion>4.0.0</modelVersion>
+    <dependencies>
+        <dependency>
+            <groupId>com.bobocode</groupId>
+            <artifactId>java-fundamentals-util</artifactId>
+            <version>1.0-SNAPSHOT</version>
+            <scope>compile</scope>
+        </dependency>
+    </dependencies>
 
     <parent>
         <groupId>com.bobocode</groupId>

2-0-data-structures-and-algorithms/src/main/java/com/bobocode/linked_list/LinkedList.java

@@ -1,5 +1,9 @@
 package com.bobocode.linked_list;
 
+
+
+import com.bobocode.util.ExerciseNotCompletedException;
+
 import java.util.NoSuchElementException;
 
 /**
@@ -18,7 +22,7 @@ public class LinkedList<T> implements List<T> {
      * @return a new list of elements the were passed as method parameters
      */
     public static <T> List<T> of(T... elements) {
-        throw new UnsupportedOperationException("This method is not implemented yet"); // todo: implement this method
+        throw new ExerciseNotCompletedException(); // todo: implement this method
     }
 
     /**
@@ -28,7 +32,7 @@ public static <T> List<T> of(T... elements) {
      */
     @Override
     public void add(T element) {
-        throw new UnsupportedOperationException("This method is not implemented yet"); // todo: implement this method
+        throw new ExerciseNotCompletedException(); // todo: implement this method
     }
 
     /**
@@ -40,7 +44,7 @@ public void add(T element) {
      */
     @Override
     public void add(int index, T element) {
-        throw new UnsupportedOperationException("This method is not implemented yet"); // todo: implement this method
+        throw new ExerciseNotCompletedException(); // todo: implement this method
     }
 
     /**
@@ -52,7 +56,7 @@ public void add(int index, T element) {
      */
     @Override
     public void set(int index, T element) {
-        throw new UnsupportedOperationException("This method is not implemented yet"); // todo: implement this method
+        throw new ExerciseNotCompletedException(); // todo: implement this method
     }
 
     /**
@@ -64,18 +68,18 @@ public void set(int index, T element) {
      */
     @Override
     public T get(int index) {
-        throw new UnsupportedOperationException("This method is not implemented yet"); // todo: implement this method
+        throw new ExerciseNotCompletedException(); // todo: implement this method
     }
 
     /**
      * Returns the first element of the list. Operation is performed in constant time O(1)
      *
      * @return the first element of the list
-     * @throws java.util.NoSuchElementException if list is empty
+     * @throws NoSuchElementException if list is empty
      */
     @Override
     public T getFirst() {
-        throw new UnsupportedOperationException("This method is not implemented yet"); // todo: implement this method
+        throw new ExerciseNotCompletedException(); // todo: implement this method
     }
 
     /**
@@ -86,7 +90,7 @@ public T getFirst() {
      */
     @Override
     public T getLast() {
-        throw new UnsupportedOperationException("This method is not implemented yet"); // todo: implement this method
+        throw new ExerciseNotCompletedException(); // todo: implement this method
     }
 
     /**
@@ -97,7 +101,7 @@ public T getLast() {
      */
     @Override
     public void remove(int index) {
-        throw new UnsupportedOperationException("This method is not implemented yet"); // todo: implement this method
+        throw new ExerciseNotCompletedException(); // todo: implement this method
     }
 
 
@@ -108,7 +112,7 @@ public void remove(int index) {
      */
     @Override
     public boolean contains(T element) {
-        throw new UnsupportedOperationException("This method is not implemented yet"); // todo: implement this method
+        throw new ExerciseNotCompletedException(); // todo: implement this method
     }
 
     /**
@@ -118,7 +122,7 @@ public boolean contains(T element) {
      */
     @Override
     public boolean isEmpty() {
-        throw new UnsupportedOperationException("This method is not implemented yet"); // todo: implement this method
+        throw new ExerciseNotCompletedException(); // todo: implement this method
     }
 
     /**
@@ -128,14 +132,14 @@ public boolean isEmpty() {
      */
     @Override
     public int size() {
-        throw new UnsupportedOperationException("This method is not implemented yet"); // todo: implement this method
+        throw new ExerciseNotCompletedException(); // todo: implement this method
     }
 
     /**
      * Removes all list elements
      */
     @Override
     public void clear() {
-        throw new UnsupportedOperationException("This method is not implemented yet"); // todo: implement this method
+        throw new ExerciseNotCompletedException(); // todo: implement this method
     }
 }

3-0-java-core/src/main/java/com/bobocode/file_reader/README.MD

@@ -0,0 +1,25 @@
+# <img src="https://raw.githubusercontent.com/bobocode-projects/resources/master/image/logo_transparent_background.png" height=50/>File Reader exercise :muscle:
+Improve your Java SE and Clean Code skills
+### Task
+`FileReaders` is an API that allows you to read whole file content into a `String`. Your job is to 
+implement the *todo* section of that class.
+
+### Refactoring Task
+There is an dirty implementation of class `FileReaders` that **contains bad practices and code smells**. If you want to 
+practice in **refactoring** and improve your **clean code skills** you can start from branch **exercise/dirty** instead of 
+**master** and try to refactor existing implementation.
+  
+To verify your implementation, run `FileReadersTest.java`
+ 
+### Pre-conditions :heavy_exclamation_mark:
+You're supposed to know how to work with text files and be able to write Java code
+
+### How to start :question:
+* Just clone the repository and create a branch **exercise/your_username** if you want your code to be reviewed
+* Start implementing the **todo** section and verify your changes by running tests
+* If you don't have enough knowledge about this domain, check out the [links below](#related-materials-information_source)
+* Don't worry if you got stuck, checkout the **exercise/completed** branch and see the final implementation
+ 
+### Related materials :information_source:
+ * [Stream API tutorial](https://github.com/bobocode-projects/java-functional-features-tutorial/tree/master/stream-api)
+