1bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor/* 21d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * Copyright (C) 2009 The Guava Authors 3bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor * 4bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor * Licensed under the Apache License, Version 2.0 (the "License"); 5bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor * you may not use this file except in compliance with the License. 6bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor * You may obtain a copy of the License at 7bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor * 8bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor * http://www.apache.org/licenses/LICENSE-2.0 9bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor * 10bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor * Unless required by applicable law or agreed to in writing, software 11bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor * distributed under the License is distributed on an "AS IS" BASIS, 12bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor * See the License for the specific language governing permissions and 14bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor * limitations under the License. 15bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor */ 16bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor 17bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnorpackage com.google.common.io; 18bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor 191d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport com.google.common.annotations.Beta; 201d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 21bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnorimport java.io.IOException; 22bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor 23bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor/** 24bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor * A callback interface to process bytes from a stream. 25bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor * 26bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor * <p>{@link #processBytes} will be called for each line that is read, and 27bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor * should return {@code false} when you want to stop processing. 28bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor * 29bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor * @author Chris Nokleberg 301d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * @since 1.0 31bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor */ 321d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert@Beta 33bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnorpublic interface ByteProcessor<T> { 34bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor /** 35bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor * This method will be called for each chunk of bytes in an 36bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor * input stream. The implementation should process the bytes 37bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor * from {@code buf[off]} through {@code buf[off + len - 1]} 38bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor * (inclusive). 39bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor * 40bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor * @param buf the byte array containing the data to process 41bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor * @param off the initial offset into the array 42bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor * @param len the length of data to be processed 43bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor * @return true to continue processing, false to stop 44bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor */ 45bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor boolean processBytes(byte[] buf, int off, int len) throws IOException; 46bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor 47bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor /** Return the result of processing all the bytes. */ 48bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor T getResult(); 49bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor} 50