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