Spelling mistakes

Author: cardil

.gitignore

@@ -7,11 +7,21 @@
 *.jar
 *.war
 *.ear
+
+# Eclipse IDE
 /.classpath
 /.project
 /.settings/org.eclipse.core.resources.prefs
 /.settings/org.eclipse.jdt.core.prefs
 /.settings/org.eclipse.m2e.core.prefs
 /.settings/org.eclipse.jdt.ui.prefs
+
+# Netbeans IDE
 /nbactions.xml
 /nbactions-ci.xml
+
+# IntiliJ IDE
+
+/*.iml
+/.idea
+

README.md

@@ -6,7 +6,7 @@ This small library holds a set of Exceptions that implements idea of fast, reusa
 
 ## Caution
 
-This classes shouldn't be used in any public API or library. It is designed to be used for in-house development of end user applications which will report Bugs in standarized error pages or post them to issue tracker.
+This classes shouldn't be used in any public API or library. It is designed to be used for in-house development of end user applications which will report Bugs in standardized error pages or post them to issue tracker.
 
 ## Requirements
 
@@ -69,7 +69,7 @@ try {
 
 #### Functional try to execute blocks
 
-Using functional blocks to handle operations, that are intended to operate properly, simplify the code and makes it more readable. It's also good way to deal with untested, uncovered `catch` blocks. It's easy and gives developers nice way of dealing with countless operations that supose to work as intended.
+Using functional blocks to handle operations, that are intended to operate properly, simplify the code and makes it more readable. It's also good way to deal with untested, uncovered `catch` blocks. It's easy and gives developers nice way of dealing with countless operations that suppose to work as intended.
 
 Example:
 
@@ -82,7 +82,21 @@ InputStream is = EidPreconditions.tryToExecute(new RiskyCode<InputStream>() {
     }
 }, "20150718:121521");
 ```
- 
+
+###Contributing
+
+Contributions are welcome!
+
+To contribute, follow the standard [git flow](http://danielkummer.github.io/git-flow-cheatsheet/) of:
+
+1. Fork it
+1. Create your feature branch (`git checkout -b feature/my-new-feature`)
+1. Commit your changes (`git commit -am 'Add some feature'`)
+1. Push to the branch (`git push origin feature/my-new-feature`)
+1. Create new Pull Request
+
+Even if you can't contribute code, if you have an idea for an improvement please open an [issue](https://github.com/wavesoftware/java-eid-exceptions/issues).
+
 ### Releases
 
-- 0.1.0 (idea imported from Guava Library and COI code)
+- 0.1.0 (idea imported from Guava Library and COI code)

src/main/java/pl/wavesoftware/eid/exceptions/Eid.java

@@ -24,7 +24,7 @@
 
 /**
  * <strong>This class shouldn't be used in any public API or library.</strong> It is designed to be used for in-house development
- * of end user applications which will report Bugs in standarized error pages or post them to issue tracker.
+ * of end user applications which will report Bugs in standardized error pages or post them to issue tracker.
  * <p>
  * Exception identifier for all Eid Runtime Exceptions.
  *
@@ -65,7 +65,7 @@ public class Eid implements Serializable {
     /**
      * Constructor
      *
-     * @param id the exception id, must be unique developer insereted string, from date
+     * @param id the exception id, must be unique developer inserted string, from date
      * @param ref an optional reference
      */
     public Eid(String id, @Nullable String ref) {
@@ -77,7 +77,7 @@ public Eid(String id, @Nullable String ref) {
     /**
      * Constructor
      *
-     * @param id the exception id, must be unique developer insereted string, from date
+     * @param id the exception id, must be unique developer inserted string, from date
      */
     public Eid(String id) {
         this(id, null);
@@ -127,7 +127,7 @@ public static UniqIdGenerator setUniqIdGenerator(UniqIdGenerator uniqIdGenerator
     }
 
     /**
-     * Sets the actual format that will be used in {@link toString()} method. It will return previously used format.
+     * Sets the actual format that will be used in {@link #toString()} method. It will return previously used format.
      *
      * @param format a format compliant with {@link String#format(String, Object...)} with 2 object arguments
      * @return a previously used format
@@ -142,7 +142,7 @@ public static String setFormat(String format) {
     }
 
     /**
-     * Sets the actual format that will be used in {@link toString()} method
+     * Sets the actual format that will be used in {@link #toString()} method
      *
      * @param refFormat a format compliant with {@link String#format(String, Object...)} with 3 object arguments
      * @return a previously used format
@@ -151,9 +151,9 @@ public static String setFormat(String format) {
      */
     public static String setRefFormat(String refFormat) {
         validateFormat(refFormat, REF_FORMAT_NUM_SPEC);
-        String prevoiusly = Eid.refFormat;
+        String previously = Eid.refFormat;
         Eid.refFormat = refFormat;
-        return prevoiusly;
+        return previously;
     }
 
     @Override
@@ -183,39 +183,39 @@ public String getRef() {
     }
 
     /**
-     * Gets uniq generated string for this instance of Eid
+     * Gets unique generated string for this instance of Eid
      *
-     * @return a uniq string
+     * @return a unique string
      */
     public String getUniq() {
         return uniq;
     }
 
     static void validateFormat(String format, int numSpecifiers) {
         if (format == null) {
-            throw new IllegalArgumentException("Format can't be null, but just recieved one");
+            throw new IllegalArgumentException("Format can't be null, but just received one");
         }
         List<String> specifiers = new ArrayList<>();
         for (int i = 0; i < numSpecifiers; i++) {
             specifiers.add(i + "-test-id");
         }
-        String formated = String.format(format, specifiers.toArray());
+        String formatted = String.format(format, specifiers.toArray());
         for (String specifier : specifiers) {
-            if (!formated.contains(specifier)) {
+            if (!formatted.contains(specifier)) {
                 throw new IllegalArgumentException("Given format contains to little format specifiers, "
                     + "expected " + numSpecifiers + " but given \"" + format + "\"");
             }
         }
     }
 
     /**
-     * It is used to generate unique ID for each EID object. It's mustn't be secure becouse it just indicate EID object while
+     * It is used to generate unique ID for each EID object. It's mustn't be secure because it just indicate EID object while
      * logging.
      */
     public interface UniqIdGenerator {
 
         /**
-         * Generates a uniq string ID
+         * Generates a unique string ID
          *
          * @return a generated unique ID
          */

src/main/java/pl/wavesoftware/eid/utils/EidPreconditions.java

@@ -26,7 +26,7 @@
 
 /**
  * <strong>This class shouldn't be used in any public API or library.</strong> It is designed to be used for in-house development
- * of end user applications which will report Bugs in standarized error pages or post them to issue tracker.
+ * of end user applications which will report Bugs in standardized error pages or post them to issue tracker.
  * <p>
  * Static convenience methods that help a method or constructor check whether it was invoked correctly (whether its
  * <i>preconditions</i>
@@ -175,7 +175,7 @@ public static void checkState(@Nonnull boolean expression, @Nonnull Eid eid) {
     /**
      * Ensures that an object reference passed as a parameter to the calling method is not null.
      *
-     * @param <T>
+     * @param <T> type of object reference being checked
      * @param reference an object reference
      * @param eid the exception message to use if the check fails; will be converted to a string using
      * {@link String#valueOf(Object)}
@@ -194,7 +194,7 @@ public static <T> T checkNotNull(@Nullable T reference, @Nonnull String eid) {
     /**
      * Ensures that an object reference passed as a parameter to the calling method is not null.
      *
-     * @param <T>
+     * @param <T> type of object reference being checked
      * @param reference an object reference
      * @param eid the exception message to use if the check fails; will be converted to a string using
      * {@link String#valueOf(Object)}
@@ -259,7 +259,7 @@ public static int checkElementIndex(int index, int size, @Nonnull Eid eid) {
     }
 
     /**
-     * Tries to execute code in given block, and if exception is thrown, it will gets retrown as a {@link EidRuntimeException}
+     * Tries to execute code in given block, and if exception is thrown, it will gets rethrown as a {@link EidRuntimeException}
      * with eid given as a argument
      * <p>
      * Example:
@@ -276,7 +276,7 @@ public static int checkElementIndex(int index, int size, @Nonnull Eid eid) {
      *
      * @param <R> return type
      * @param code code to be executed within a try-catch block
-     * @param eid uniq developer identifier from date for ex.: "20150716:123200"
+     * @param eid unique developer identifier from date for ex.: "20150716:123200"
      * @return A block of code return type, if exception is not thrown
      * @throws EidRuntimeException if code block thrown any exception, which in that case is wrapped in EidRuntimeException
      */
@@ -295,7 +295,7 @@ public static <R> R tryToExecute(@Nonnull RiskyCode<R> code, @Nonnull String eid
     }
 
     /**
-     * Tries to execute code in given block, and if exception is thrown, it will gets retrown as a {@link EidRuntimeException}
+     * Tries to execute code in given block, and if exception is thrown, it will gets rethrown as a {@link EidRuntimeException}
      * with eid given as a argument
      * <p>
      * Example:
@@ -312,7 +312,7 @@ public static <R> R tryToExecute(@Nonnull RiskyCode<R> code, @Nonnull String eid
      *
      * @param <R> return type
      * @param code code to be executed within a try-catch block
-     * @param eid uniq developer identifier from date for ex.: "20150716:123200"
+     * @param eid unique developer identifier from date for ex.: "20150716:123200"
      * @return A block of code return type, if exception is not thrown
      * @throws EidRuntimeException if code block thrown any exception, which in that case is wrapped in EidRuntimeException
      */
@@ -341,7 +341,7 @@ public interface RiskyCode<R> {
          * Executes a client code
          *
          * @return a object of client code
-         * @throws Exception this exception sould be set to concrete one
+         * @throws Exception this exception should be set to concrete one
          */
         @SuppressWarnings({
             "pmd:SignatureDeclareThrowsException",

src/test/java/pl/wavesoftware/eid/exceptions/EidTest.java

@@ -38,7 +38,7 @@ public void testSetMessageFormat_Null() {
             String format = null;
             // then
             thrown.expect(IllegalArgumentException.class);
-            thrown.expectMessage("Format can't be null, but just recieved one");
+            thrown.expectMessage("Format can't be null, but just received one");
             // when
             Eid.setMessageFormat(format);
         } finally {
@@ -74,11 +74,11 @@ public String generateUniqId() {
                 }
             };
             // when
-            UniqIdGenerator prevoius = Eid.setUniqIdGenerator(generator);
-            UniqIdGenerator set = Eid.setUniqIdGenerator(prevoius);
+            UniqIdGenerator previous = Eid.setUniqIdGenerator(generator);
+            UniqIdGenerator set = Eid.setUniqIdGenerator(previous);
             // then
             assertThat(set).isSameAs(generator);
-            assertThat(prevoius).isSameAs(Eid.DEFAULT_UNIQ_ID_GENERATOR);
+            assertThat(previous).isSameAs(Eid.DEFAULT_UNIQ_ID_GENERATOR);
         } finally {
             Eid.setUniqIdGenerator(Eid.DEFAULT_UNIQ_ID_GENERATOR);
         }
@@ -106,7 +106,7 @@ public void testSetFormat_Null() {
             String format = null;
             // then
             thrown.expect(IllegalArgumentException.class);
-            thrown.expectMessage("Format can't be null, but just recieved one");
+            thrown.expectMessage("Format can't be null, but just received one");
             // when
             Eid.setFormat(format);
         } finally {
@@ -168,7 +168,7 @@ public void testSetRefFormat_Null() {
             String refFormat = null;
             // then
             thrown.expect(IllegalArgumentException.class);
-            thrown.expectMessage("Format can't be null, but just recieved one");
+            thrown.expectMessage("Format can't be null, but just received one");
             // when
             Eid.setRefFormat(refFormat);
         } finally {