Unlock 30% off on Manual Testing Annual Plans this Holiday Season.

Copied to Clipboard!

How to use create method of com.tngtech.jgiven.format.table.DefaultTableFormatter class

Best JGiven code snippet using com.tngtech.jgiven.format.table.DefaultTableFormatter.create

Source:Table.java

...19 * treats certain types of objects in a special way.20 * <p>21 * If a parameter implements the {@link java.lang.Iterable} or is an instance of22 * an array then each element of the Iterable is interpreted as a single row of23 * the table. Otherwise JGiven will only create a single row.24 * <p>25 * The elements are again interpreted differently whether they are instances of26 * {@link java.lang.Iterable} or not.27 * <p>28 * If the elements are instances of Iterable then each element becomes a cell in29 * the row. Note that the first list is taken as the header of the table if the30 * {@link Table#columnTitles()} is not set.31 * <p>32 * If the elements are not instances of Iterable, the field names become the33 * headers and field values the data. This can be overridden by the34 * {@link #objectFormatting()} attribute.35 * <p>36 * It is also possible to completely replace the way JGiven translates arguments37 * to tables by using the {@link #formatter()} attribute38 * <p>39 * <h3>Example</h3>40 * <h4>Some POJO</h4>41 *42 * <pre>43 * {44 * 	&#64;code45 * 	class CoffeeWithPrice {46 * 		String name;47 * 		double price_in_EUR;48 *49 * 		CoffeeWithPrice(String name, double priceInEur) {50 * 			this.name = name;51 * 			this.price_in_EUR = priceInEur;52 * 		}53 * 	}54 * }55 * </pre>56 *57 * <h4>The Step Method</h4>58 *59 * <pre>60 * {@code61 *     public SELF the_prices_of_the_coffees_are( @Table CoffeeWithPrice... prices ) {62 *         ...63 *     }64 * }65 * </pre>66 *67 * <h4>Invocation of the step method</h4>68 *69 * <pre>70 * {@code71 *     given().the_prices_of_the_coffees_are(72 *         new CoffeeWithPrice("Espresso", 2.0),73 *         new CoffeeWithPrice("Cappuccino", 2.5));74 * }75 * </pre>76 *77 * <h4>Text Report</h4>78 *79 * <pre>80 * {@code81 *     Given the prices of the coffees are82 *83 *          | name       | price in EUR |84 *          +------------+--------------+85 *          | Espresso   | 2.0          |86 *          | Cappuccino | 2.5          |87 *88 *89 * }90 * </pre>91 *92 * @since 0.6.193 */94@Documented95@Retention( RetentionPolicy.RUNTIME )96@Target( { ElementType.PARAMETER, ElementType.ANNOTATION_TYPE } )97public @interface Table {98    /**99     * Specifies the header type of the table. Default is {@code HORIZONTAL}.100     * <p>101     * That is explained best by an example. <br>102     * Given the following table argument:103     *104     * <pre>105     * {@code new Object[][] {106     *     { "a1", "a2", "a3" },107     *     { "b1", "b2", "b3" },108     *     { "c1", "c2", "c3" }}109     * }110     * </pre>111     *112     * Then the header type argument has the following effect.113     * <h3>{@code HeaderType.NONE}</h3> This simply specifies the the table has114     * no header. The plain text report will produce the following output.115     *116     * <pre>117     *     | a1 | a2 | a3 |118     *     | b1 | b2 | b3 |119     *     | c1 | c2 | c3 |120     * </pre>121     *122     * <h3>{@code HeaderType.HORIZONTAL}</h3> Specifies that the first123     * <em>row</em> represents the header.124     *125     * <pre>126     *     | a1 | a2 | a3 |127     *     +----+----+----+128     *     | b1 | b2 | b3 |129     *     | c1 | c2 | c3 |130     * </pre>131     *132     * <h3>{@code HeaderType.VERTICAL}</h3> Specifies that the first133     * <em>column</em> represents the header. Thus elements a1, b1, and c1. The134     * plain text report will produce the same output as for header type NONE,135     * however, the HTML report will render the first column as a header.136     *137     * <pre>138     *     | a1 | a2 | a3 |139     *     | b1 | b2 | b3 |140     *     | c1 | c2 | c3 |141     * </pre>142     *143     * <h3>{@code HeaderType.BOTH}</h3> Specifies that the first <em>row</em>144     * and the first <em>column</em> are headers. The plain text report will145     * produce the same output as for header type HORIZONTAL, however, the HTML146     * report will render the first row and the first column as headers.147     *148     * <pre>149     *     | a1 | a2 | a3 |150     *     +----+----+----+151     *     | b1 | b2 | b3 |152     *     | c1 | c2 | c3 |153     * </pre>154     *155     * <h2>Effect on POJO lists</h2> When the data is given by a list of POJOs156     * then setting the header type to {@code VERTICAL} will also157     * <em>transpose</em> the table. For example158     * <p>159     * Given the following POJO list.160     *161     * <pre>162     * {@code new CoffeeWithPrice[] {163     *         new CoffeeWithPrice("Espresso", 2.0),164     *         new CoffeeWithPrice("Cappuccino", 2.5)}165     * }166     * </pre>167     *168     * When setting the header type to {@code VERTICAL}<br>169     * Then the report will present the following table170     *171     * <pre>172     * {@code173     *     | name         | Espresso | Cappuccino |174     *     | price in EUR | 2.0      | 2.5        |175     * }176     * </pre>177     * <p>178     * The header type {@code BOTH} <em>cannot</em> be applied to POJO lists179     * </p>180     *181     * @return the header type of the table.182     */183    HeaderType header() default HORIZONTAL;184    /**185     * Whether to transpose the resulting table in the report or not.186     * <h2>Example</h2> Given the following data.187     *188     * <pre>189     * {@code new Object[][] {190     *     { "a1", "a2", "a3" },191     *     { "b1", "b2", "b3" },192     *     { "c1", "c2", "c3" }}193     * }194     * </pre>195     *196     * When transpose is set to {@code true} Then the table in the report will197     * look as follows:198     *199     * <pre>200     *     | a1 | b1 | c1 |201     *     +----+----+----+202     *     | a2 | b2 | c2 |203     *     | a3 | b3 | c3 |204     * </pre>205     *206     * instead of207     *208     * <pre>209     *     | a1 | a2 | a3 |210     *     +----+----+----+211     *     | b1 | b2 | b3 |212     *     | c1 | c2 | c3 |213     * </pre>214     */215    boolean transpose() default false;216    /**217     * Specifies which fields should be excluded in the report.218     * <p>219     * If {@link #includeFields()} is set, then this attribute has no effect220     * 221     * <p>222     * Makes only sense when supplying a list of POJOs or a single POJO.223     */224    String[] excludeFields() default {};225    /**226     * Specifies which fields should be included in the report.227     * 228     * All fields not in this list will be excluded.229     * <p>230     * Makes only sense when supplying a list of POJOs or a single POJO.231     */232    String[] includeFields() default {};233    /**234     * Explicitly specifies column titles of table header.235     * <p>236     * The first row of the data is <b>not</b> taken as the header row if this237     * attribute is set.238     * <p>239     * When a list of POJOs is given as parameter then this overrides the240     * default behavior of taking the field names as table headers.241     *242     * <h2>Example</h2> Given the following table argument:243     * 244     * <pre>245     * {@code new Object[][] {246     *     { "a1", "a2", "a3" },247     *     { "b1", "b2", "b3" },248     *     { "c1", "c2", "c3" }}249     * }250     * </pre>251     *252     * Then the {@link #columnTitles()} attribute is set as follows:253     *254     * <pre>255     * columnTitles = { "t1", "t2", "t3" }256     * </pre>257     *258     * Then the resulting table will look as follows259     *260     * <pre>261     *     | t1 | t2 | t3 |262     *     +----+----+----+263     *     | a1 | a2 | a3 |264     *     | b1 | b2 | b3 |265     *     | c1 | c2 | c3 |266     * </pre>267     * 268     * @since 0.7.1269     */270    String[] columnTitles() default {};271    /**272     * Whether or not columns with only {@code null} values are shown or not.273     * Default is to not show them.274     * 275     * @since 0.7.1276     */277    boolean includeNullColumns() default false;278    /**279     * Automatically number the rows of the table Default is not to generate280     * one.281     * <p>282     * If the table has a horizontal header, the generated column has header283     * '#'. To use a different header use {@link #numberedRowsHeader}.284     * 285     * @since 0.8.2286     */287    boolean numberedRows() default false;288    /**289     * Like {@link #numberedRows} but specifies a different header for the290     * generated column. This implicitly sets {@see #numberedRows} to291     * {@code true}.292     * <p>293     * Note that in case the table has no horizontal header a294     * {@see JGivenWrongUsageException} will be thrown if this value is set.295     *296     * @since 0.8.2297     */298    String numberedRowsHeader() default AnnotationUtil.ABSENT;299    /**300     * Automatically number the columns of a table Default is not to generate301     * one.302     * <p>303     * If the table has a vertical header, the generated row has header '#'. To304     * use a different header use {@link #numberedColumnsHeader}.305     *306     * @since 0.8.2307     */308    boolean numberedColumns() default false;309    /**310     * Like {@link #numberedColumns} but specifies a different header for the311     * generated row. This implicitly sets {@see #numberedColumns} to312     * {@code true}.313     * <p>314     * Note that in case the table has no vertical header a315     * {@see JGivenWrongUsageException} will be thrown if this value is set.316     *317     * @since 0.8.2318     */319    String numberedColumnsHeader() default AnnotationUtil.ABSENT;320    public enum HeaderType {321        /**322         * The table has no header323         */324        NONE,325        /**326         * Treat the first row as a header327         */328        HORIZONTAL,329        /**330         * Treat the first column as a header331         */332        VERTICAL,333        /**334         * Treat both, the first row and the first column as headers335         */336        BOTH;337        public boolean isHorizontal() {338            return this == HORIZONTAL || this == BOTH;339        }340        public boolean isVertical() {341            return this == VERTICAL || this == BOTH;342        }343    }344    /**345     * The formatter to use to translate the parameter object to a table. If you346     * only want to override how POJOs are formatted you should use the347     * {@link #objectFormatting()} or {@link #rowFormatter()} attribute.348     *349     * @since 0.10.0350     */351    Class<? extends TableFormatterFactory> formatter() default DefaultTableFormatter.Factory.class;352    /**353     * How to format rows when the rows are plain Objects, i.e. no Iterables.354     * Note that this setting is ignored if a different {@link #rowFormatter()}355     * is set. In addition, JGiven will automatically switch to the356     * {@link com.tngtech.jgiven.annotation.Table.ObjectFormatting#PLAIN}357     * formatter when there is an additional formatting annotation besides the358     * {@code @Table} annotation.359     * 360     * @since 0.10.0361     */362    ObjectFormatting objectFormatting() default ObjectFormatting.FIELDS;363    /**364     * Possible choices for the {@link #objectFormatting()} attribute.365     * 366     * @since 0.10.0367     */368    public enum ObjectFormatting {369        /**370         * Each field of the object becomes a column in the table371         */372        FIELDS,373        /**374         * There is only one column and the values are created by formatting375         * each Object using the standard JGiven formatting.376         */377        PLAIN378    }379    /**380     * Specifies a factory to create a custom381     * {@link com.tngtech.jgiven.format.table.RowFormatter} that is used to382     * format POJOs each row of the table.383     * <p>384     * The default implementation evaluates the {@link #objectFormatting()}385     * attribute and creates a corresponding RowFormatter386     * </p>387     *388     * @since 0.10.0389     */390    Class<? extends RowFormatterFactory> rowFormatter() default DefaultRowFormatterFactory.class;391    /**392     * Specify a custom {@link NamedFormats} annotation393     *394     * <p>395     * The {@link NamedFormat} defined in this set will be used when formatting396     * POJOs fields.<br>397     * </p>398     *399     */...

Source:DataTableFormatterTest.java

...205        }206    }207    public static class TestRowFormatterFactory implements RowFormatterFactory {208        @Override209        public RowFormatter create( Class<?> parameterType, String parameterName, Table tableAnnotation,210                Annotation[] annotations,211                FormatterConfiguration configuration, ObjectFormatter<?> objectFormatter ) {212            return new TestRowFormatter();213        }214    }215}...

Source:DefaultTableFormatter.java

...107    }108    DataTable pojosToTableValue( Iterable<?> objects, final Table tableAnnotation, String parameterName, Annotation[] annotations ) {109        Object first = objects.iterator().next();110        RowFormatterFactory objectRowFormatterFactory = ReflectionUtil.newInstance( tableAnnotation.rowFormatter() );111        RowFormatter formatter = objectRowFormatterFactory.create( first.getClass(), parameterName, tableAnnotation, annotations,112            formatterConfiguration, objectFormatter );113        List<List<String>> list = Lists.newArrayList();114        if( tableAnnotation.header() != Table.HeaderType.NONE ) {115            if( tableAnnotation.columnTitles().length > 0 ) {116                list.add( Arrays.asList( tableAnnotation.columnTitles() ) );117            } else {118                list.add( formatter.header() );119            }120        }121        for( Object o : objects ) {122            list.add( formatter.formatRow( o ) );123        }124        list = formatter.postProcess( list );125        list = tableAnnotation.transpose() || tableAnnotation.header().isVertical() ? transpose( list ) : list;126        return new DataTable( tableAnnotation.header(), list );127    }128    static List<List<String>> transpose( List<List<String>> list ) {129        List<List<String>> transposed = Lists.newArrayList();130        for( int rowIdx = 0; rowIdx < list.size(); rowIdx++ ) {131            List<String> row = list.get( rowIdx );132            for( int colIdx = 0; colIdx < row.size(); colIdx++ ) {133                if( rowIdx == 0 ) {134                    transposed.add( Lists.<String>newArrayList() );135                }136                transposed.get( colIdx ).add( row.get( colIdx ) );137            }138        }139        return transposed;140    }141    private static List<String> toStringList( Object row ) {142        List<String> list = Lists.newArrayList();143        Iterable<?> objects = toIterable( row );144        if( objects == null ) {145            throw new JGivenWrongUsageException( "@Table annotated argument cannot be converted to a data table." );146        }147        for( Object o : objects ) {148            list.add( toDefaultStringFormat( o ) );149        }150        return list;151    }152    private static Iterable<?> toIterable( Object value ) {153        if( value instanceof Iterable<?> ) {154            return (Iterable<?>) value;155        }156        if( value.getClass().isArray() ) {157            return arrayToList( value );158        }159        return null;160    }161    private static Iterable<?> arrayToList( Object array ) {162        int length = Array.getLength( array );163        if( length == 0 ) {164            return Collections.emptyList();165        }166        List<Object> result = Lists.newArrayList();167        for( int i = 0; i < length; i++ ) {168            result.add( Array.get( array, i ) );169        }170        return result;171    }172    private static String toDefaultStringFormat( Object value ) {173        return DefaultFormatter.INSTANCE.format( value );174    }175    public static class Factory implements TableFormatterFactory {176        @Override177        public TableFormatter create( FormatterConfiguration formatterConfiguration, ObjectFormatter<?> objectFormatter ) {178            return new DefaultTableFormatter( formatterConfiguration, objectFormatter );179        }180    }181}...

create

Using AI Code Generation

1import com.tngtech.jgiven.format.table.DefaultTableFormatter;2import com.tngtech.jgiven.format.table.TableFormatter;3public class TableFormatterDemo {4	public static void main(String[] args) {5		TableFormatter tableFormatter = new DefaultTableFormatter();6		String[][] data = new String[][] { { "1", "2", "3" }, { "4", "5", "6" } };7		System.out.println(tableFormatter.create(data));8	}9}10import com.tngtech.jgiven.format.table.DefaultTableFormatter;11import com.tngtech.jgiven.format.table.TableFormatter;12public class TableFormatterDemo {13	public static void main(String[] args) {14		TableFormatter tableFormatter = new DefaultTableFormatter();15		String[][] data = new String[][] { { "1", "2", "3" }, { "4", "5", "6" } };16		System.out.println(tableFormatter.create(data, " "));17	}18}19import com.tngtech.jgiven.format.table.DefaultTableFormatter;20import com.tngtech.jgiven.format.table.TableFormatter;21public class TableFormatterDemo {22	public static void main(String[] args) {23		TableFormatter tableFormatter = new DefaultTableFormatter();24		String[][] data = new String[][] { { "1", "2", "3" }, { "4", "5", "6" } };25		System.out.println(tableFormatter.create(data, " ", " "));26	}27}28import com.tngtech.jgiven.format.table.DefaultTableFormatter;29import com.tngtech.jgiven.format.table.TableFormatter;30public class TableFormatterDemo {31	public static void main(String[] args) {32		TableFormatter tableFormatter = new DefaultTableFormatter();33		String[][] data = new String[][] { { "1", "2", "

create

Using AI Code Generation

1package com.tngtech.jgiven.format.table;2import java.util.ArrayList;3import java.util.List;4public class DefaultTableFormatterTest {5    public static void main(String[] args) {6        List<String> list = new ArrayList<>();7        list.add("a");8        list.add("b");9        DefaultTableFormatter formatter = new DefaultTableFormatter();10        String table = formatter.create(list

create

Using AI Code Generation

1import com.tngtech.jgiven.format.table.DefaultTableFormatter;2public class 1 {3    public static void main(String[] args) {4        DefaultTableFormatter formatter = new DefaultTableFormatter();5        String[][] data = {{"a", "b"}, {"c", "d"}};6        String table = formatter.create(data);7        System.out.println(table);8    }9}10import com.tngtech.jgiven.format.table.DefaultTableFormatter;11public class 2 {12    public static void main(String[] args) {13        DefaultTableFormatter formatter = new DefaultTableFormatter();14        String[][] data = {{"a", "b"}, {"c", "d"}};15        String table = formatter.create(data);16        System.out.println(table);17    }18}19import com.tngtech.jgiven.format.table.DefaultTableFormatter;20public class 3 {21    public static void main(String[] args) {22        DefaultTableFormatter formatter = new DefaultTableFormatter();23        String[][] data = {{"a", "b"}, {"c", "d"}};24        String table = formatter.create(data);25        System.out.println(table);26    }27}28import com.tngtech.jgiven.format.table.DefaultTableFormatter;29public class 4 {30    public static void main(String[] args) {31        DefaultTableFormatter formatter = new DefaultTableFormatter();32        String[][] data = {{"a", "b"}, {"c", "d"}};33        String table = formatter.create(data);34        System.out.println(table);35    }36}37import com.tngtech.jgiven.format.table.DefaultTableFormatter;38public class 5 {39    public static void main(String[] args) {40        DefaultTableFormatter formatter = new DefaultTableFormatter();41        String[][] data = {{"a", "b"}, {"c", "d"}};

create

Using AI Code Generation

1package com.tngtech.jgiven.format.table;2import com.tngtech.jgiven.format.table.TableFormatter;3public class DefaultTableFormatter {4public static void main(String[] args) {5TableFormatter tableFormatter = create();6System.out.println(tableFormatter);7}8public static TableFormatter create() {9return new TableFormatter();10}11}

create

Using AI Code Generation

1public class DefaultTableFormatterTest {2    public static void main(String[] args) {3        DefaultTableFormatter defaultTableFormatter = new DefaultTableFormatter();4        System.out.println(defaultTableFormatter.create(new String[] {"1", "2", "3", "4"}));5    }6}

create

Using AI Code Generation

1package com.tngtech.jgiven.format.table;2import com.tngtech.jgiven.format.table.TableFormatter.Table;3public class TableFormatterExample {4    public static void main(String[] args) {5        Table table = DefaultTableFormatter.create()6            .row("name", "age")7            .row("John", "25")8            .row("Jane", "20")9            .build();10        System.out.println(table);11    }12}13package com.tngtech.jgiven.format.table;14import com.tngtech.jgiven.format.table.TableFormatter.Table;15public class TableFormatterExample {16    public static void main(String[] args) {17        Table table = DefaultTableFormatter.create()18            .row("name", "age")19            .row("John", "25")20            .row("Jane", "20")21            .build();22        System.out.println(table);23    }24}25package com.tngtech.jgiven.format.table;26import com.tngtech.jgiven.format.table.TableFormatter.Table;27public class TableFormatterExample {28    public static void main(String[] args) {29        Table table = DefaultTableFormatter.create()30            .row("name", "age")31            .row("John", "25")32            .row("Jane", "20")33            .build();34        System.out.println(table);35    }36}37package com.tngtech.jgiven.format.table;38import com.tngtech.jgiven

create

Using AI Code Generation

1package com.tngtech.jgiven.format.table;2public class TableFormatterCreateMethod {3    public static void main(String[] args) {4        String[][] table = DefaultTableFormatter.create(3, 3);5        for (int i = 0; i < table.length; i++) {6            for (int j = 0; j < table[i].length; j++) {7                System.out.print(table[i][j] + " ");8            }9            System.out.println();10        }11    }12}13package com.tngtech.jgiven.format.table;14public class TableFormatterCreateMethod {15    public static void main(String[] args) {

create

Using AI Code Generation

1DefaultTableFormatter defaultTableFormatter = new DefaultTableFormatter();2TableFormatter tableFormatter = defaultTableFormatter.create( " | " , " | " , " | " , " | " );3String table = tableFormatter.format( " | " , " | " , " | " , " | " );4System.out.println(table);5HtmlTableFormatter htmlTableFormatter = new HtmlTableFormatter();6TableFormatter tableFormatter = htmlTableFormatter.create( " | " , " | " , " | " , " | " );7String table = tableFormatter.format( " | " , " | " , " | " , " | " );8System.out.println(table);9MarkdownTableFormatter markdownTableFormatter = new MarkdownTableFormatter();10TableFormatter tableFormatter = markdownTableFormatter.create( " | " , " | " , " | " , " | " );11String table = tableFormatter.format( " | " , " | " , " | " , " | " );12System.out.println(table);13TextTableFormatter textTableFormatter = new TextTableFormatter();14TableFormatter tableFormatter = textTableFormatter.create( " | " , " | " , " | " , " | " );15String table = tableFormatter.format( " | " , " | " , " | " , " | " );16System.out.println(table);17XmlTableFormatter xmlTableFormatter = new XmlTableFormatter();18TableFormatter tableFormatter = xmlTableFormatter.create( " | " , " | " , " | " , " | " );19String table = tableFormatter.format( " | " , " | " , " | " , " | " );20System.out.println(table);21CsvTableFormatter csvTableFormatter = new CsvTableFormatter();22TableFormatter tableFormatter = csvTableFormatter.create( " | " , " | " , " | " , " | " );23String table = tableFormatter.format( " | " , " | " , " | " , " | " );24System.out.println(table);

create

Using AI Code Generation

1package com.tngtech.jgiven.format.table;2import java.util.ArrayList;3import java.util.List;4public class DefaultTableFormatterCreateMethod {5    public static void main(String[] args) {6        String[] headers = new String[] { "Name", "Age" };7        List<String> list = new ArrayList<String>();8        list.add("John");9        list.add("20");10        DefaultTableFormatter tableFormatter = new DefaultTableFormatter();11        String table = tableFormatter.create(headers, list);12        System.out.println(table);13    }14}15package com.tngtech.jgiven.format.table;16import java.util.ArrayList;17import java.util.List;18public class DefaultTableFormatterCreateMethod {19    public static void main(String[] args) {20        String[] headers = new String[] { "Name", "Age" };21        List<String> list = new ArrayList<String>();22        list.add("John");23        list.add("20");24        DefaultTableFormatter tableFormatter = new DefaultTableFormatter();25        String table = tableFormatter.create(headers, list);26        System.out.println(table);27    }28}29package com.tngtech.jgiven.format.table;30import java.util.ArrayList;31import java.util.List;32public class DefaultTableFormatterCreateMethod {33    public static void main(String[] args) {34        String[] headers = new String[] { "Name", "Age" };35        List<String> list = new ArrayList<String>();36        list.add("John");37        list.add("20");38        DefaultTableFormatter tableFormatter = new DefaultTableFormatter();39        String table = tableFormatter.create(headers, list);40        System.out.println(table);41    }42}43package com.tngtech.jgiven.format.table;44import java.util

Automation Testing Tutorials

Learn to execute automation testing from scratch with LambdaTest Learning Hub. Right from setting up the prerequisites to run your first automation test, to following best practices and diving deeper into advanced test scenarios. LambdaTest Learning Hubs compile a list of step-by-step guides to help you be proficient with different test automation frameworks i.e. Selenium, Cypress, TestNG etc.