Merge pull request #10 from joutvhu/development

Release 1.0.0

Author: joutvhu

README.md

@@ -5,3 +5,19 @@ Fixed Width Parser is a small library that purpose is:
 - Parse fixed width string to java object.
 
 - Export java object to fixed width string.
+
+## Installation
+
+- Add dependency
+
+```groovy
+compile "com.github.joutvhu:fixed-width-parser:1.0.0"
+```
+
+```xml
+<dependency>
+    <groupId>com.github.joutvhu</groupId>
+    <artifactId>fixed-width-parser</artifactId>
+    <version>1.0.0</version>
+</dependency>
+```

build.gradle

@@ -7,7 +7,7 @@ plugins {
 }
 
 group = 'com.github.joutvhu'
-version '0.0.10-SNAPSHOT'
+version '1.0.0'
 sourceCompatibility = 1.8
 targetCompatibility = 1.8
 

src/main/java/com/joutvhu/fixedwidth/parser/annotation/FixedField.java

@@ -7,6 +7,8 @@
 import java.lang.annotation.*;
 
 /**
+ * Used to annotate the fixed width field
+ *
  * @author Giao Ho
  * @since 1.0.0
  */

src/main/java/com/joutvhu/fixedwidth/parser/annotation/FixedObject.java

@@ -7,6 +7,8 @@
 import java.lang.annotation.*;
 
 /**
+ * Used to annotate the fixed width object
+ *
  * @author Giao Ho
  * @since 1.0.0
  */

src/main/java/com/joutvhu/fixedwidth/parser/annotation/FixedParam.java

@@ -7,6 +7,8 @@
 import java.lang.annotation.*;
 
 /**
+ * Used to annotate the fixed width param
+ *
  * @author Giao Ho
  * @since 1.0.0
  */

src/main/java/com/joutvhu/fixedwidth/parser/constraint/FixedFormat.java

@@ -3,6 +3,8 @@
 import java.lang.annotation.*;
 
 /**
+ * Setups constraint for value by format
+ *
  * @author Giao Ho
  * @since 1.0.0
  */

src/main/java/com/joutvhu/fixedwidth/parser/constraint/FixedOption.java

@@ -3,6 +3,8 @@
 import java.lang.annotation.*;
 
 /**
+ * Setups constraint for value by options
+ *
  * @author Giao Ho
  * @since 1.0.0
  */

src/main/java/com/joutvhu/fixedwidth/parser/constraint/FixedRegex.java

@@ -3,6 +3,8 @@
 import java.lang.annotation.*;
 
 /**
+ * Setups constraint for value by regular expression
+ *
  * @author Giao Ho
  * @since 1.0.0
  */

src/main/java/com/joutvhu/fixedwidth/parser/convert/FixedWidthReader.java

@@ -4,6 +4,9 @@
 import com.joutvhu.fixedwidth.parser.support.FixedTypeInfo;
 
 /**
+ * Fixed width reader
+ *
+ * @param <T> result type
  * @author Giao Ho
  * @since 1.0.0
  */

src/main/java/com/joutvhu/fixedwidth/parser/convert/FixedWidthValidator.java

@@ -5,6 +5,8 @@
 import com.joutvhu.fixedwidth.parser.util.CommonUtil;
 
 /**
+ * Fixed width validator
+ *
  * @author Giao Ho
  * @since 1.0.0
  */
@@ -13,6 +15,15 @@ public FixedWidthValidator(FixedTypeInfo info, FixedParseStrategy strategy) {
         super(info, strategy);
     }
 
+    /**
+     * Get error message
+     *
+     * @param message        native message or message template
+     * @param nativeMessage  the message is native message
+     * @param defaultMessage use this message if the message is blank
+     * @param arguments      the arguments
+     * @return message
+     */
     protected String getMessage(String message, boolean nativeMessage, String defaultMessage, Object... arguments) {
         if (CommonUtil.isBlank(message)) {
             message = defaultMessage;

src/main/java/com/joutvhu/fixedwidth/parser/convert/FixedWidthWriter.java

@@ -4,6 +4,9 @@
 import com.joutvhu.fixedwidth.parser.support.FixedTypeInfo;
 
 /**
+ * Fixed width writer
+ *
+ * @param <T> input type
  * @author Giao Ho
  * @since 1.0.0
  */

src/main/java/com/joutvhu/fixedwidth/parser/convert/ParsingApprover.java

@@ -5,6 +5,8 @@
 import com.joutvhu.fixedwidth.parser.support.FixedTypeInfo;
 
 /**
+ * Parsing approver
+ *
  * @author Giao Ho
  * @since 1.0.0
  */
@@ -17,6 +19,9 @@ public ParsingApprover(FixedTypeInfo info, FixedParseStrategy strategy) {
         this.strategy = strategy;
     }
 
+    /**
+     * Can't use this class to read, write or validate fixed width string
+     */
     protected void reject() {
         throw new FixedException("Can't use this class.");
     }

src/main/java/com/joutvhu/fixedwidth/parser/convert/StringReader.java

@@ -3,9 +3,19 @@
 import com.joutvhu.fixedwidth.parser.support.StringAssembler;
 
 /**
+ * Deserialization
+ * Fixed width string reader
+ *
  * @author Giao Ho
  * @since 1.0.0
  */
 public interface StringReader<T> {
+    /**
+     * Deserialize
+     * Read object value from {@link StringAssembler}
+     *
+     * @param assembler the {@link StringAssembler}
+     * @return object value
+     */
     T read(StringAssembler assembler);
 }

src/main/java/com/joutvhu/fixedwidth/parser/convert/StringValidator.java

@@ -1,9 +1,17 @@
 package com.joutvhu.fixedwidth.parser.convert;
 
 /**
+ * Fixed width validator
+ *
  * @author Giao Ho
  * @since 1.0.0
  */
 public interface StringValidator {
-    boolean validate(String value, ValidationType type);
+    /**
+     * Validate string value
+     *
+     * @param value is string value
+     * @param type  the {@link ValidationType}
+     */
+    void validate(String value, ValidationType type);
 }

src/main/java/com/joutvhu/fixedwidth/parser/convert/StringWriter.java

@@ -1,9 +1,19 @@
 package com.joutvhu.fixedwidth.parser.convert;
 
 /**
+ * Serialization
+ * Fixed width string writer
+ *
  * @author Giao Ho
  * @since 1.0.0
  */
 public interface StringWriter<T> {
+    /**
+     * Serialize
+     * Write object to string
+     *
+     * @param value object
+     * @return string
+     */
     String write(T value);
 }

src/main/java/com/joutvhu/fixedwidth/parser/convert/ValidationType.java

@@ -1,6 +1,8 @@
 package com.joutvhu.fixedwidth.parser.convert;
 
 /**
+ * Validation type enum, before read or after write
+ *
  * @author Giao Ho
  * @since 1.0.0
  */

src/main/java/com/joutvhu/fixedwidth/parser/convert/validator/BooleanValidator.java

@@ -13,6 +13,8 @@
 import java.util.List;
 
 /**
+ * Boolean validator
+ *
  * @author Giao Ho
  * @since 1.0.0
  */
@@ -31,14 +33,13 @@ public void setOptions(String[] options) {
     }
 
     @Override
-    public boolean validate(String value, ValidationType type) {
+    public void validate(String value, ValidationType type) {
         if (splitOptions(fixedFormat.format()) && !options.contains(value)) {
             String message = getMessage(fixedFormat.message(),
                     fixedFormat.nativeMessage(),
                     "{title} should be equal to one of the following value(s): {0}.",
                     "\"" + StringUtils.join(options, "\", \"") + "\"");
             throw new InvalidException(message);
         }
-        return true;
     }
 }

src/main/java/com/joutvhu/fixedwidth/parser/convert/validator/DateValidator.java

@@ -8,6 +8,8 @@
 import com.joutvhu.fixedwidth.parser.util.TypeConstants;
 
 /**
+ * Date time validator
+ *
  * @author Giao Ho
  * @since 1.0.0
  */
@@ -19,19 +21,14 @@ public DateValidator(FixedTypeInfo info, FixedParseStrategy strategy) {
     }
 
     @Override
-    public boolean validate(String value, ValidationType type) {
-        if (CommonUtil.isNotBlank(value)) {
-            if (CommonUtil.isNotBlank(fixedFormat.format()) &&
-                    !CommonUtil.isDateValid(value, fixedFormat.format(), true)) {
-                String message = getMessage(fixedFormat.message(),
-                        fixedFormat.nativeMessage(),
-                        "{title} should be in format {0}.",
-                        fixedFormat.format());
-                throw new InvalidException(message);
-            }
-        } else {
-
+    public void validate(String value, ValidationType type) {
+        if (CommonUtil.isNotBlank(fixedFormat.format()) &&
+                !CommonUtil.isDateValid(value, fixedFormat.format(), true)) {
+            String message = getMessage(fixedFormat.message(),
+                    fixedFormat.nativeMessage(),
+                    "{title} should be in format {0}.",
+                    fixedFormat.format());
+            throw new InvalidException(message);
         }
-        return true;
     }
 }

src/main/java/com/joutvhu/fixedwidth/parser/convert/validator/FormatValidator.java

@@ -6,6 +6,8 @@
 import com.joutvhu.fixedwidth.parser.support.FixedTypeInfo;
 
 /**
+ * Validator for {@link FixedFormat} annotation
+ *
  * @author Giao Ho
  * @since 1.0.0
  */

src/main/java/com/joutvhu/fixedwidth/parser/convert/validator/OptionValidator.java

@@ -12,6 +12,8 @@
 import java.util.List;
 
 /**
+ * Validator for {@link FixedOption} annotation
+ *
  * @author Giao Ho
  * @since 1.0.0
  */
@@ -25,7 +27,7 @@ public OptionValidator(FixedTypeInfo info, FixedParseStrategy strategy) {
     }
 
     @Override
-    public boolean validate(String value, ValidationType type) {
+    public void validate(String value, ValidationType type) {
         if (CommonUtil.isNotBlank(fixedOption.options())) {
             List<String> options = CommonUtil.listOf(fixedOption.options());
             if (!options.contains(value)) {
@@ -36,6 +38,5 @@ public boolean validate(String value, ValidationType type) {
                 throw new InvalidException(message);
             }
         }
-        return true;
     }
 }

src/main/java/com/joutvhu/fixedwidth/parser/convert/validator/RegexValidator.java

@@ -10,6 +10,8 @@
 import com.joutvhu.fixedwidth.parser.util.CommonUtil;
 
 /**
+ * Validator for {@link FixedRegex} annotation
+ *
  * @author Giao Ho
  * @since 1.0.0
  */
@@ -23,14 +25,13 @@ public RegexValidator(FixedTypeInfo info, FixedParseStrategy strategy) {
     }
 
     @Override
-    public boolean validate(String value, ValidationType type) {
+    public void validate(String value, ValidationType type) {
         if (CommonUtil.isNotBlank(fixedRegex.regex()) && !Pattern.matches(fixedRegex.regex(), value)) {
             String message = getMessage(fixedRegex.message(),
                     fixedRegex.nativeMessage(),
                     "{title} doesn't match by /{0}/ regex.",
                     fixedRegex.regex());
             throw new InvalidException(message);
         }
-        return true;
     }
 }