1 /* 2 * Copyright 2017 Google Inc. 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 * https://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 trebuchet.extractors 18 19 import trebuchet.io.BufferProducer 20 import trebuchet.io.StreamingReader 21 22 /** 23 * An extractor that operates on string data sources 24 */ 25 interface Extractor { 26 /** 27 * Starts extraction from the given data source. 28 * 29 * @param stream The data to extract from 30 * @param processSubStream A callback mechanism to begin extracting sub-streams as encountered. 31 * The callback can be invoked as often as necessary. One extractor can produce 32 * multiple sub-streams. 33 */ extractnull34 fun extract(stream: StreamingReader, processSubStream: (BufferProducer) -> Unit) 35 }