Coverage Report - org.tap4j.producer.Producer
 
Classes in this File Line Coverage Branch Coverage Complexity
Producer
N/A
N/A
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.producer;
 25  
 
 26  
 import java.io.File;
 27  
 import java.io.Writer;
 28  
 
 29  
 import org.tap4j.model.TestSet;
 30  
 import org.tap4j.representer.Representer;
 31  
 
 32  
 /**
 33  
  * Produces a TAP Stream.
 34  
  * 
 35  
  * @since 1.0
 36  
  */
 37  
 public interface Producer {
 38  
 
 39  
     /**
 40  
      * Returns a String representing the TAP Stream produced from a TestSet.
 41  
      * 
 42  
      * @param testSet TestSet
 43  
      * @return TAP Stream
 44  
      * @throws ProducerException
 45  
      */
 46  
     String dump(TestSet testSet);
 47  
 
 48  
     /**
 49  
      * Writes the TAP Stream produced from a TestSet into a Writer.
 50  
      * 
 51  
      * @param testSet TestSet
 52  
      * @param writer Writer
 53  
      * @throws ProducerException
 54  
      */
 55  
     void dump(TestSet testSet, Writer writer);
 56  
 
 57  
     /**
 58  
      * Writes the TAP Stream into an output File.
 59  
      * 
 60  
      * @param testSet TestSet
 61  
      * @param output Output File
 62  
      * @throws ProducerException
 63  
      */
 64  
     void dump(TestSet testSet, File output);
 65  
 
 66  
     /**
 67  
      * Returns the Representer used in the Producer.
 68  
      * 
 69  
      * @return Representer
 70  
      */
 71  
     Representer getRepresenter();
 72  
 
 73  
 }