| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| TapConsumer |
|
| 1.0;1 |
| 1 | /* | |
| 2 | * The MIT License | |
| 3 | * | |
| 4 | * Copyright (c) 2010 Bruno P. Kinoshita <http://www.kinoshita.eti.br> | |
| 5 | * | |
| 6 | * Permission is hereby granted, free of charge, to any person obtaining a copy | |
| 7 | * of this software and associated documentation files (the "Software"), to deal | |
| 8 | * in the Software without restriction, including without limitation the rights | |
| 9 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
| 10 | * copies of the Software, and to permit persons to whom the Software is | |
| 11 | * furnished to do so, subject to the following conditions: | |
| 12 | * | |
| 13 | * The above copyright notice and this permission notice shall be included in | |
| 14 | * all copies or substantial portions of the Software. | |
| 15 | * | |
| 16 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
| 17 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
| 18 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
| 19 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
| 20 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
| 21 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | |
| 22 | * THE SOFTWARE. | |
| 23 | */ | |
| 24 | package org.tap4j.consumer; | |
| 25 | ||
| 26 | import java.io.File; | |
| 27 | ||
| 28 | import org.tap4j.model.TestSet; | |
| 29 | import org.tap4j.parser.Parser; | |
| 30 | ||
| 31 | /** | |
| 32 | * TAP Consumer is the responsible for generating the TAP Stream. | |
| 33 | * | |
| 34 | * @since 1.0 | |
| 35 | */ | |
| 36 | public interface TapConsumer { | |
| 37 | ||
| 38 | /** | |
| 39 | * Parses a TAP File. | |
| 40 | * | |
| 41 | * @param file TAP File. | |
| 42 | * @return TestSet | |
| 43 | * @throws TapConsumerException | |
| 44 | */ | |
| 45 | TestSet load(File file); | |
| 46 | ||
| 47 | /** | |
| 48 | * Parses a TAP Stream. | |
| 49 | * | |
| 50 | * @param tapStream TAP Stream | |
| 51 | * @return TestSet | |
| 52 | * @throws TapConsumerException | |
| 53 | */ | |
| 54 | TestSet load(String tapStream); | |
| 55 | ||
| 56 | /** | |
| 57 | * Returns the TestSet resulted from parsing a TAP File or TAP Stream. | |
| 58 | * | |
| 59 | * @return TestSet | |
| 60 | */ | |
| 61 | TestSet getTestSet(); | |
| 62 | ||
| 63 | /** | |
| 64 | * Returns the Parser used in the Consumer. | |
| 65 | * | |
| 66 | * @return Parser | |
| 67 | */ | |
| 68 | Parser getParser(); | |
| 69 | ||
| 70 | } |