support for custom predicate for mixed lines

README.md

@@ -123,7 +123,7 @@ CatSnowball
 EmplJoe3      Smith     
 ```
 
-with this files:
+with these files:
 
 ```java
 @FixedLine(startsWith = "Empl")
@@ -137,6 +137,8 @@ public class EmployeeMixed {
 }
 ```
 
+(fields could be final as well).
+
 ```java
 @FixedLine(startsWith = "Cat")
 public class CatMixed {
@@ -231,6 +233,16 @@ public class HeaderSplit {
 }
 ```
 
+## Custom rules for mixed lines
+
+There is a `startsWith` parameter for easy-to-use identifying the class to deserialize, but sometimes it is not enough. So there is a `predicate` parameter in `FixedLine` annotation where you should pass your own custom rule as predicate. Just implement `Predicate<String>` and pass pointer to class in annotation.
+
+```java
+@FixedLine(predicate = EmployeePositionPredicate.class)
+```
+
+This class will be initialized just once and cached. 
+
 ## Benchmark
 
 There is a benchmark, you can run it with `gradle jmh` command. Also, you can change running parameters of it in file `src/jmh/java/name/velikodniy/vitaliy/fixedlength/benchmark/BenchmarkRunner.java`. 

src/main/java/name/velikodniy/vitaliy/fixedlength/FixedLength.java

@@ -17,12 +17,15 @@
 import java.util.Arrays;
 import java.util.Collections;
 import java.util.Comparator;
+import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 import java.util.Objects;
+import java.util.Optional;
 import java.util.Scanner;
 import java.util.Spliterator;
 import java.util.Spliterators;
+import java.util.function.Predicate;
 import java.util.logging.Logger;
 import java.util.regex.Pattern;
 import java.util.stream.Collectors;
@@ -40,6 +43,7 @@ public class FixedLength<T> {
             Class<? extends Formatter<? extends Serializable>>
             > FORMATTERS
             = Formatter.getDefaultFormatters();
+    private final Map<Class<? extends Predicate<String>>, Predicate<String>> predicates = new HashMap<>();
     private final List<FixedFormatLine<? extends T>> lineTypes = new ArrayList<>();
     private boolean skipUnknownLines = true;
     private boolean skipErroneousFields = false;
@@ -53,7 +57,8 @@ private FixedFormatLine<T> classToLineDesc(final Class<? extends T> clazz) {
         fixedFormatLine.clazz = clazz;
         FixedLine annotation = clazz.getDeclaredAnnotation(FixedLine.class);
         if (annotation != null) {
-            fixedFormatLine.startsWith = annotation.startsWith();
+            fixedFormatLine.setStartsWith(annotation.startsWith());
+            fixedFormatLine.predicate = annotation.predicate();
         }
         for (Field field : getAllFields(clazz)) {
             FixedField fieldAnnotation = field.getDeclaredAnnotation(FixedField.class);
@@ -150,21 +155,32 @@ public FixedLength<T> usingLineDelimiter(String delimiterString) {
         return this;
     }
 
-    private FixedFormatRecord fixedFormatLine(String line) {
-        if (lineTypes.size() == 1) {
-            if (lineTypes.get(0).startsWith == null) {
-                return new FixedFormatRecord(line, lineTypes.get(0));
-            } else if (line.startsWith(lineTypes.get(0).startsWith)) {
-                return new FixedFormatRecord(line, lineTypes.get(0));
-            } else {
-                return null;
+    private Predicate<String> getPredicate(Class<? extends Predicate<String>> clazz) {
+        if (predicates.containsKey(clazz)) {
+            return predicates.get(clazz);
+        } else {
+            Predicate<String> predicate;
+            try {
+                predicate = clazz.getDeclaredConstructor().newInstance();
+            } catch (InstantiationException | IllegalAccessException | InvocationTargetException |
+                     NoSuchMethodException e) {
+                throw new FixedLengthException("Cannot init predicate, it should have empty constructor", e);
             }
+            predicates.put(clazz, predicate);
+            return predicate;
         }
+    }
+
+    private FixedFormatRecord fixedFormatLine(String line) {
         for (FixedFormatLine<? extends T> lineType : lineTypes) {
             if (
-                    lineType.startsWith != null
-                            &&
-                            line.startsWith(lineType.startsWith)
+                    lineType.getStartsWith()
+                            .map(line::startsWith)
+                            .orElse(true) &&
+                    lineType.getPredicate()
+                            .map(this::getPredicate)
+                            .map(p -> p.test(line))
+                            .orElse(true)
             ) {
                 return new FixedFormatRecord(line, lineType);
             }
@@ -386,18 +402,27 @@ private FixedFormatRecord(
 
     private static class FixedFormatLine<T> {
         private String startsWith = null;
+        private Class<? extends Predicate<String>> predicate;
         private Class<? extends T> clazz;
         private final List<FixedFormatField> fixedFormatFields = new ArrayList<>();
         private Method splitAfterMethod;
 
-        public String getStartsWith() {
-            return startsWith;
+        public Optional<String> getStartsWith() {
+            return Optional.ofNullable(startsWith).flatMap(s -> s.isEmpty() ? Optional.empty() : Optional.of(s));
+        }
+
+        public Optional<Class<? extends Predicate<String>>> getPredicate() {
+            return Optional.ofNullable(predicate);
         }
 
         public void setStartsWith(String startsWith) {
             this.startsWith = startsWith;
         }
 
+        public void setPredicate(Class<? extends Predicate<String>> predicate) {
+            this.predicate = predicate;
+        }
+
         public Class<? extends T> getClazz() {
             return clazz;
         }

src/main/java/name/velikodniy/vitaliy/fixedlength/annotation/FixedLine.java

@@ -4,6 +4,7 @@
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
+import java.util.function.Predicate;
 
 @Retention(RetentionPolicy.RUNTIME)
 @Target(ElementType.TYPE)
@@ -13,5 +14,19 @@
      *
      * @return Indicator of line type
      */
-    String startsWith();
+    String startsWith() default "";
+
+    /**
+     * Predicate to check if the line is of this type.
+     *
+     * @return Predicate to check the line type.
+     */
+    Class<? extends Predicate<String>> predicate() default DefaultPredicate.class;
+
+    class DefaultPredicate implements Predicate<String> {
+        @Override
+        public boolean test(String line) {
+            return true; // Default predicate always returns true
+        }
+    }
 }

src/test/java/AbstractPerson.java → src/test/java/name/velikodniy/vitaliy/fixedlength/AbstractPerson.java

@@ -1,4 +1,5 @@
-import name.velikodniy.vitaliy.fixedlength.Align;
+package name.velikodniy.vitaliy.fixedlength;
+
 import name.velikodniy.vitaliy.fixedlength.annotation.FixedField;
 
 public abstract class AbstractPerson {

src/test/java/CatMixed.java → src/test/java/name/velikodniy/vitaliy/fixedlength/CatMixed.java

@@ -1,4 +1,5 @@
-import name.velikodniy.vitaliy.fixedlength.Align;
+package name.velikodniy.vitaliy.fixedlength;
+
 import name.velikodniy.vitaliy.fixedlength.annotation.FixedField;
 import name.velikodniy.vitaliy.fixedlength.annotation.FixedLine;
 

src/test/java/Employee.java → src/test/java/name/velikodniy/vitaliy/fixedlength/Employee.java

@@ -1,4 +1,5 @@
-import name.velikodniy.vitaliy.fixedlength.Align;
+package name.velikodniy.vitaliy.fixedlength;
+
 import name.velikodniy.vitaliy.fixedlength.annotation.FixedField;
 
 import java.math.BigDecimal;

src/test/java/EmployeeMixed.java → src/test/java/name/velikodniy/vitaliy/fixedlength/EmployeeMixed.java

@@ -1,4 +1,5 @@
-import name.velikodniy.vitaliy.fixedlength.Align;
+package name.velikodniy.vitaliy.fixedlength;
+
 import name.velikodniy.vitaliy.fixedlength.annotation.FixedField;
 import name.velikodniy.vitaliy.fixedlength.annotation.FixedLine;
 

src/test/java/name/velikodniy/vitaliy/fixedlength/EmployeePosition.java

@@ -0,0 +1,15 @@
+package name.velikodniy.vitaliy.fixedlength;
+
+import name.velikodniy.vitaliy.fixedlength.annotation.FixedField;
+import name.velikodniy.vitaliy.fixedlength.annotation.FixedLine;
+
+@FixedLine(predicate = EmployeePositionPredicate.class)
+public class EmployeePosition {
+
+    @FixedField(offset = 1, length = 10, align = Align.LEFT)
+    private String position;
+
+    public String getPosition() {
+        return position;
+    }
+}

src/test/java/name/velikodniy/vitaliy/fixedlength/EmployeePositionPredicate.java

@@ -0,0 +1,11 @@
+package name.velikodniy.vitaliy.fixedlength;
+
+import java.util.function.Predicate;
+
+public class EmployeePositionPredicate implements Predicate<String> {
+
+    @Override
+    public boolean test(String s) {
+        return s.contains("POSITION");
+    }
+}

src/test/java/name/velikodniy/vitaliy/fixedlength/EmployeeWithEmptyAnnotation.java

@@ -0,0 +1,13 @@
+package name.velikodniy.vitaliy.fixedlength;
+
+import name.velikodniy.vitaliy.fixedlength.annotation.FixedField;
+import name.velikodniy.vitaliy.fixedlength.annotation.FixedLine;
+
+@FixedLine
+public class EmployeeWithEmptyAnnotation implements Row {
+    @FixedField(offset = 1, length = 10, align = Align.LEFT)
+    public String firstName;
+
+    @FixedField(offset = 11, length = 10, align = Align.LEFT)
+    String lastName;
+}

src/test/java/FormatterTest.java → src/test/java/name/velikodniy/vitaliy/fixedlength/FormatterTest.java

@@ -1,4 +1,5 @@
-import name.velikodniy.vitaliy.fixedlength.FixedLength;
+package name.velikodniy.vitaliy.fixedlength;
+
 import org.junit.jupiter.api.DisplayName;
 import org.junit.jupiter.api.Test;
 

src/test/java/HeaderSplit.java → src/test/java/name/velikodniy/vitaliy/fixedlength/HeaderSplit.java

@@ -1,3 +1,5 @@
+package name.velikodniy.vitaliy.fixedlength;
+
 import name.velikodniy.vitaliy.fixedlength.annotation.FixedField;
 import name.velikodniy.vitaliy.fixedlength.annotation.FixedLine;
 import name.velikodniy.vitaliy.fixedlength.annotation.SplitLineAfter;

src/test/java/InheritedEmployee.java → src/test/java/name/velikodniy/vitaliy/fixedlength/InheritedEmployee.java

@@ -1,4 +1,5 @@
-import name.velikodniy.vitaliy.fixedlength.Align;
+package name.velikodniy.vitaliy.fixedlength;
+
 import name.velikodniy.vitaliy.fixedlength.annotation.FixedField;
 
 import java.math.BigDecimal;

src/test/java/ParserTest.java → src/test/java/name/velikodniy/vitaliy/fixedlength/ParserTest.java

@@ -1,5 +1,5 @@
-import name.velikodniy.vitaliy.fixedlength.FixedLength;
-import name.velikodniy.vitaliy.fixedlength.FixedLengthException;
+package name.velikodniy.vitaliy.fixedlength;
+
 import org.junit.jupiter.api.DisplayName;
 import org.junit.jupiter.api.Test;
 
@@ -13,7 +13,10 @@
 
 import static org.hamcrest.CoreMatchers.instanceOf;
 import static org.hamcrest.MatcherAssert.assertThat;
-import static org.junit.jupiter.api.Assertions.*;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertNotNull;
+import static org.junit.jupiter.api.Assertions.assertNull;
+import static org.junit.jupiter.api.Assertions.assertThrows;
 
 class ParserTest {
 
@@ -38,14 +41,18 @@ class ParserTest {
 
     String mixedTypesWrongSplitRecordExample =
             "HEADERMy Title  00        EmplJoe1      Smith     Developer 07500010012009\n" +
-                    "CatSnowball  20200103\n" +
-                    "EmplJoe3      Smith     Developer ";
+            "CatSnowball  20200103\n" +
+            "EmplJoe3      Smith     Developer ";
 
     String mixedTypesCustomDelimiter =
             "EmplJoe1      Smith     Developer 07500010012009@" +
             "CatSnowball  20200103@" +
             "EmplJoe3      Smith     Developer ";
 
+    String mixedTypesCustomExample =
+            "EmplJoe1      Smith     Developer 07500010012009\n" +
+            "Engineer      POSITION";
+
     @Test
     @DisplayName("Parse as input stream with default charset and one line type")
     void testParseInheritedOneLineType() throws FixedLengthException {
@@ -54,12 +61,12 @@ void testParseInheritedOneLineType() throws FixedLengthException {
                 .parse(new ByteArrayInputStream(singleTypeExample.getBytes()));
 
         assertEquals(2, parse.size());
-        parse.forEach( e ->{
-            assertNotNull(((InheritedEmployee)e).firstName);
-            assertNotNull(((InheritedEmployee)e).lastName);
+        parse.forEach(e -> {
+            assertNotNull(((InheritedEmployee) e).firstName);
+            assertNotNull(((InheritedEmployee) e).lastName);
         });
     }
-    
+
     @Test
     @DisplayName("Parse as input stream with default charset and one line type")
     void testParseOneLineType() throws FixedLengthException {
@@ -70,13 +77,23 @@ void testParseOneLineType() throws FixedLengthException {
         assertEquals(2, parse.size());
     }
 
+    @Test
+    @DisplayName("Parse as input stream with default charset and one line type and empty annotation")
+    void testParseOneLineTypeEmptyAnnotation() throws FixedLengthException {
+        List<Row> parse = new FixedLength<Row>()
+                .registerLineType(EmployeeWithEmptyAnnotation.class)
+                .parse(new ByteArrayInputStream(singleTypeExample.getBytes()));
+
+        assertEquals(2, parse.size());
+    }
+
     @Test
     @DisplayName("Parse as input stream with throwing exception when format erroneous fields")
     void testParseThrowsExceptionOnInvalidFormat() throws FixedLengthException {
         assertThrows(DateTimeParseException.class, () ->
                 new FixedLength<Row>()
-                    .registerLineType(Employee.class)
-                    .parse(new ByteArrayInputStream(singleTypeWithErrorExample.getBytes())));
+                        .registerLineType(Employee.class)
+                        .parse(new ByteArrayInputStream(singleTypeWithErrorExample.getBytes())));
     }
 
     @Test
@@ -188,4 +205,15 @@ void testParseReaderWithDefaultCharset() throws FixedLengthException {
 
         assertEquals(2, parse.size());
     }
+
+    @Test
+    @DisplayName("Parse as input stream with default charset and mixed line type and custom predicate")
+    void testParseMixedLineTypeCustomPredicate() throws FixedLengthException {
+        List<Object> parse = new FixedLength<>()
+                .registerLineType(EmployeeMixed.class)
+                .registerLineType(EmployeePosition.class)
+                .parse(new ByteArrayInputStream(mixedTypesCustomExample.getBytes()));
+
+        assertEquals(2, parse.size());
+    }
 }

src/test/java/name/velikodniy/vitaliy/fixedlength/Row.java

@@ -0,0 +1,4 @@
+package name.velikodniy.vitaliy.fixedlength;
+
+public interface Row {
+}