Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
 /*
  * Copyright 2006-2010 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
  *      http://www.apache.org/licenses/LICENSE-2.0
  *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.springframework.batch.item;

A specialisation of ItemReader that allows the user to look ahead into the stream of items. This is useful, for instance, when reading flat file data that contains record separator lines which are actually part of the next record.

The detailed contract for peek() has to be defined by the implementation because there is no general way to define it in a concurrent environment. The definition of "the next read()" operation is tenuous if multiple clients are reading concurrently, and the ability to peek implies that some state is likely to be stored, so implementations of PeekableItemReader may well be restricted to single threaded use.

Author(s):
Dave Syer
public interface PeekableItemReader<T> extends ItemReader<T> {

Get the next item that would be returned by ItemReader.read(), without affecting the result of ItemReader.read().

Returns:
the next item
Throws:
java.lang.Exception if there is a problem
New to GrepCode? Check out our FAQ X