类 FlatFileItemReaderBuilder<T>

字段详细资料

• logger

  protected org.apache.commons.logging.Log logger

构造器详细资料

• FlatFileItemReaderBuilder

  public FlatFileItemReaderBuilder()

方法详细资料

• saveState

  public FlatFileItemReaderBuilder<T> saveState​(boolean saveState)

  Configure if the state of the ItemStreamSupport should be persisted within the ExecutionContext for restart purposes.

  参数:

  saveState - defaults to true

  返回:

  The current instance of the builder.

• name

  public FlatFileItemReaderBuilder<T> name​(java.lang.String name)

  The name used to calculate the key within the ExecutionContext. Required if saveState(boolean) is set to true.

  参数:

  name - name of the reader instance

  返回:

  The current instance of the builder.

  另请参阅:

  ItemStreamSupport.setName(String)

• maxItemCount

  public FlatFileItemReaderBuilder<T> maxItemCount​(int maxItemCount)

  Configure the max number of items to be read.

  参数:

  maxItemCount - the max items to be read

  返回:

  The current instance of the builder.

  另请参阅:

  AbstractItemCountingItemStreamItemReader.setMaxItemCount(int)

• currentItemCount

  public FlatFileItemReaderBuilder<T> currentItemCount​(int currentItemCount)

  Index for the current item. Used on restarts to indicate where to start from.

  参数:

  currentItemCount - current index

  返回:

  this instance for method chaining

  另请参阅:

  AbstractItemCountingItemStreamItemReader.setCurrentItemCount(int)

• addComment

  public FlatFileItemReaderBuilder<T> addComment​(java.lang.String comment)

  Add a string to the list of Strings that indicate commented lines. Defaults to FlatFileItemReader.DEFAULT_COMMENT_PREFIXES.

  参数:

  comment - the string to define a commented line.

  返回:

  The current instance of the builder.

  另请参阅:

  FlatFileItemReader.setComments(String[])

• comments

  public FlatFileItemReaderBuilder<T> comments​(java.lang.String... comments)

  Set an array of Strings that indicate lines that are comments (and therefore skipped by the reader). This method overrides the default comment prefixes which are FlatFileItemReader.DEFAULT_COMMENT_PREFIXES.

  参数:

  comments - an array of strings to identify comments.

  返回:

  The current instance of the builder.

  另请参阅:

  FlatFileItemReader.setComments(String[])

• recordSeparatorPolicy

  public FlatFileItemReaderBuilder<T> recordSeparatorPolicy​(RecordSeparatorPolicy policy)

  Configure a custom RecordSeparatorPolicy for the reader.

  参数:

  policy - custom policy

  返回:

  The current instance of the builder.

  另请参阅:

  FlatFileItemReader.setRecordSeparatorPolicy(RecordSeparatorPolicy)

• resource

  public FlatFileItemReaderBuilder<T> resource​(org.springframework.core.io.Resource resource)

  The Resource to be used as input.

  参数:

  resource - the input to the reader.

  返回:

  The current instance of the builder.

  另请参阅:

  FlatFileItemReader.setResource(Resource)

• strict

  public FlatFileItemReaderBuilder<T> strict​(boolean strict)

  Configure if the reader should be in strict mode (require the input Resource to exist).

  参数:

  strict - true if the input file is required to exist.

  返回:

  The current instance of the builder.

  另请参阅:

  FlatFileItemReader.setStrict(boolean)

• encoding

  public FlatFileItemReaderBuilder<T> encoding​(java.lang.String encoding)

  Configure the encoding used by the reader to read the input source. Default value is FlatFileItemReader.DEFAULT_CHARSET.

  参数:

  encoding - to use to read the input source.

  返回:

  The current instance of the builder.

  另请参阅:

  FlatFileItemReader.setEncoding(String)

• linesToSkip

  public FlatFileItemReaderBuilder<T> linesToSkip​(int linesToSkip)

  The number of lines to skip at the beginning of reading the file.

  参数:

  linesToSkip - number of lines to be skipped.

  返回:

  The current instance of the builder.

  另请参阅:

  FlatFileItemReader.setLinesToSkip(int)

• skippedLinesCallback

  public FlatFileItemReaderBuilder<T> skippedLinesCallback​(LineCallbackHandler callback)

  A callback to be called for each line that is skipped.

  参数:

  callback - the callback

  返回:

  The current instance of the builder.

  另请参阅:

  FlatFileItemReader.setSkippedLinesCallback(LineCallbackHandler)

• lineMapper

  public FlatFileItemReaderBuilder<T> lineMapper​(LineMapper<T> lineMapper)

  A LineMapper implementation to be used.

  参数:

  lineMapper - LineMapper

  返回:

  The current instance of the builder.

  另请参阅:

  FlatFileItemReader.setLineMapper(LineMapper)

• fieldSetMapper

  public FlatFileItemReaderBuilder<T> fieldSetMapper​(FieldSetMapper<T> mapper)

  A FieldSetMapper implementation to be used.

  参数:

  mapper - a FieldSetMapper

  返回:

  The current instance of the builder.

  另请参阅:

  DefaultLineMapper.setFieldSetMapper(FieldSetMapper)

• lineTokenizer

  public FlatFileItemReaderBuilder<T> lineTokenizer​(LineTokenizer tokenizer)

  A LineTokenizer implementation to be used.

  参数:

  tokenizer - a LineTokenizer

  返回:

  The current instance of the builder.

  另请参阅:

  DefaultLineMapper.setLineTokenizer(LineTokenizer)

• delimited

  public FlatFileItemReaderBuilder.DelimitedBuilder<T> delimited()

  Returns an instance of a FlatFileItemReaderBuilder.DelimitedBuilder for building a DelimitedLineTokenizer. The DelimitedLineTokenizer configured by this builder will only be used if one is not explicitly configured via lineTokenizer

  返回:

  a FlatFileItemReaderBuilder.DelimitedBuilder

• fixedLength

  public FlatFileItemReaderBuilder.FixedLengthBuilder<T> fixedLength()

  Returns an instance of a FlatFileItemReaderBuilder.FixedLengthBuilder for building a FixedLengthTokenizer. The FixedLengthTokenizer configured by this builder will only be used if the lineTokenizer has not been configured.

  返回:

  a FlatFileItemReaderBuilder.FixedLengthBuilder

• targetType

  public FlatFileItemReaderBuilder<T> targetType​(java.lang.Class<? extends T> targetType)

  The class that will represent the "item" to be returned from the reader. This class is used via the BeanWrapperFieldSetMapper. If more complex logic is required, providing your own FieldSetMapper via fieldSetMapper is required.

  参数:

  targetType - The class to map to

  返回:

  The current instance of the builder.

  另请参阅:

  BeanWrapperFieldSetMapper.setTargetType(Class)

• prototypeBeanName

  public FlatFileItemReaderBuilder<T> prototypeBeanName​(java.lang.String prototypeBeanName)

  Configures the id of a prototype scoped bean to be used as the item returned by the reader.

  参数:

  prototypeBeanName - the name of a prototype scoped bean

  返回:

  The current instance of the builder.

  另请参阅:

  BeanWrapperFieldSetMapper.setPrototypeBeanName(String)

• beanFactory

  public FlatFileItemReaderBuilder<T> beanFactory​(org.springframework.beans.factory.BeanFactory beanFactory)

  Configures the BeanFactory used to create the beans that are returned as items.

  参数:

  beanFactory - a BeanFactory

  返回:

  The current instance of the builder.

  另请参阅:

  BeanWrapperFieldSetMapper.setBeanFactory(BeanFactory)

• customEditors

  public FlatFileItemReaderBuilder<T> customEditors​(java.util.Map<java.lang.Class<?>,​java.beans.PropertyEditor> customEditors)

  Register custom type converters for beans being mapped.

  参数:

  customEditors - a Map of editors

  返回:

  The current instance of the builder.

  另请参阅:

  BeanWrapperFieldSetMapper.setCustomEditors(Map)

• distanceLimit

  public FlatFileItemReaderBuilder<T> distanceLimit​(int distanceLimit)

  Configures the maximum tolerance between the actual spelling of a field's name and the property's name.

  参数:

  distanceLimit - distance limit to set

  返回:

  The current instance of the builder.

  另请参阅:

  BeanWrapperFieldSetMapper.setDistanceLimit(int)

• beanMapperStrict

  public FlatFileItemReaderBuilder<T> beanMapperStrict​(boolean beanMapperStrict)

  If set to true, mapping will fail if the FieldSet contains fields that cannot be mapped to the bean.

  参数:

  beanMapperStrict - defaults to false

  返回:

  The current instance of the builder.

  另请参阅:

  BeanWrapperFieldSetMapper.setStrict(boolean)

• build

  public FlatFileItemReader<T> build()

  Builds the FlatFileItemReader.

  返回:

  a FlatFileItemReader