Package org.beanio.internal.parser.format.delimited

Class DelimitedRecordFormat

  • All Implemented Interfaces:
    RecordFormat
    public class DelimitedRecordFormat
extends java.lang.Object
implements RecordFormat
    A RecordFormat for delimited records.

    A delimited record may be configured to validate a record field count by setting a minimum and maximum length.

    Since:
    2.0

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int getMaxLength()
      Returns the maximum number of fields in the record.
      int getMaxMatchLength()
      Returns the maximum record length for identifying a record.
      int getMinLength()
      Returns the minimum number of fields in the record.
      int getMinMatchLength()
      Returns the minimum record length for identifying a record.
      boolean matches​(UnmarshallingContext context)
      Returns whether the record meets configured matching criteria during unmarshalling.
      void setMaxLength​(int maxLength)
      Sets the maximum number of fields in the record.
      void setMaxMatchLength​(int maxMatchLength)
      Sets the maximum record length for identifying a record.
      void setMinLength​(int minLength)
      Sets the minimum number of fields in the record.
      void setMinMatchLength​(int minMatchLength)
      Sets the minimum record length for identifying a record.
      java.lang.String toString()  
      void validate​(UnmarshallingContext context)
      Validates a record during unmarshalling.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • DelimitedRecordFormat

        public DelimitedRecordFormat()

    • Method Detail

      • matches

        public boolean matches​(UnmarshallingContext context)
        Description copied from interface: RecordFormat
        Returns whether the record meets configured matching criteria during unmarshalling.
        Specified by:
        matches in interface RecordFormat
        Parameters:
        context - the UnmarshallingContext
        Returns:
        true if the record meets all matching criteria, false otherwise

      • getMinLength

        public int getMinLength()
        Returns the minimum number of fields in the record. Defaults to 0.
        Returns:
        minimum field count

      • setMinLength

        public void setMinLength​(int minLength)
        Sets the minimum number of fields in the record.
        Parameters:
        minLength - minimum field count

      • getMaxLength

        public int getMaxLength()
        Returns the maximum number of fields in the record. Defaults to Integer.MAX_VALUE.
        Returns:
        maximum field count

      • setMaxLength

        public void setMaxLength​(int maxLength)
        Sets the maximum number of fields in the record.
        Parameters:
        maxLength - maximum field count

      • getMinMatchLength

        public int getMinMatchLength()
        Returns the minimum record length for identifying a record.
        Returns:
        the minimum number of fields

      • setMinMatchLength

        public void setMinMatchLength​(int minMatchLength)
        Sets the minimum record length for identifying a record.
        Parameters:
        minMatchLength - the minimum number of fields

      • getMaxMatchLength

        public int getMaxMatchLength()
        Returns the maximum record length for identifying a record.
        Returns:
        the maximum number of fields

      • setMaxMatchLength

        public void setMaxMatchLength​(int maxMatchLength)
        Sets the maximum record length for identifying a record.
        Parameters:
        maxMatchLength - the maximum number of fields

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object