Class AbstractBeanListProcessor<T,C extends Context>

Type Parameters:
T - the annotated class type.
All Implemented Interfaces:
ConversionProcessor, Processor<C>
Direct Known Subclasses:
BeanListProcessor

public abstract class AbstractBeanListProcessor<T,C extends Context> extends AbstractBeanProcessor<T,C>
A convenience Processor implementation for storing all java objects generated form the parsed input into a list. A typical use case of this class will be:


 parserSettings.setRowProcessor(new BeanListProcessor(MyObject.class));
 parser.parse(reader); // will invoke the {@link AbstractBeanListProcessor#beanProcessed(Object, C)} method for each generated object.

 List&lt;T&gt; beans = rowProcessor.getBeans();
 

See Also:
  • Field Details

    • beans

      private List<T> beans
    • headers

      private String[] headers
    • expectedBeanCount

      private final int expectedBeanCount
  • Constructor Details

    • AbstractBeanListProcessor

      public AbstractBeanListProcessor(Class<T> beanType)
      Creates a processor that stores java beans of a given type into a list
      Parameters:
      beanType - the class with its attributes mapped to fields of records parsed by an AbstractParser or written by an AbstractWriter.
    • AbstractBeanListProcessor

      public AbstractBeanListProcessor(Class<T> beanType, int expectedBeanCount)
      Creates a processor that stores java beans of a given type into a list
      Parameters:
      beanType - the class with its attributes mapped to fields of records parsed by an AbstractParser or written by an AbstractWriter.
      expectedBeanCount - expected number of rows to be parsed from the input which will be converted into java beans. Used to pre-allocate the size of the output List returned by getBeans()
  • Method Details

    • beanProcessed

      public void beanProcessed(T bean, C context)
      Stores the generated java bean produced with a parsed record into a list.
      Specified by:
      beanProcessed in class AbstractBeanProcessor<T,C extends Context>
      Parameters:
      bean - java bean generated with the information extracted by the parser for an individual record
      context - A contextual object with information and controls over the current state of the parsing process
      See Also:
    • getBeans

      public List<T> getBeans()
      Returns the list of generated java beans at the end of the parsing process.
      Returns:
      the list of generated java beans at the end of the parsing process.
    • processStarted

      public void processStarted(C context)
      Description copied from interface: Processor
      This method will by invoked by the parser once, when it is ready to start processing the input.
      Specified by:
      processStarted in interface Processor<T>
      Overrides:
      processStarted in class AbstractBeanProcessor<T,C extends Context>
      Parameters:
      context - A contextual object with information and controls over the current state of the parsing process
    • processEnded

      public void processEnded(C context)
      Description copied from interface: Processor
      This method will by invoked by the parser once, after the parsing process stopped and all resources were closed.

      It will always be called by the parser: in case of errors, if the end of the input us reached, or if the user stopped the process manually using Context.stop().

      Specified by:
      processEnded in interface Processor<T>
      Overrides:
      processEnded in class AbstractBeanProcessor<T,C extends Context>
      Parameters:
      context - A contextual object with information and controls over the state of the parsing process
    • getHeaders

      public String[] getHeaders()
      Returns the record headers. This can be either the headers defined in CommonSettings.getHeaders() or the headers parsed in the file when CommonSettings.getHeaders() equals true
      Returns:
      the headers of all records parsed.