Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jakewharton/flip-tables
Because pretty-printing text tables in Java should be easy.
https://github.com/jakewharton/flip-tables
Last synced: 9 days ago
JSON representation
Because pretty-printing text tables in Java should be easy.
- Host: GitHub
- URL: https://github.com/jakewharton/flip-tables
- Owner: JakeWharton
- License: apache-2.0
- Created: 2014-02-25T08:34:27.000Z (over 10 years ago)
- Default Branch: trunk
- Last Pushed: 2024-04-12T22:48:20.000Z (7 months ago)
- Last Synced: 2024-04-14T08:41:39.149Z (7 months ago)
- Language: Java
- Size: 235 KB
- Stars: 627
- Watchers: 19
- Forks: 75
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
Flip Tables
===========
Because pretty-printing text tables in Java should be easy.
(╯°□°）╯︵ ┻━┻
Development on this project has basically stopped. You can find a more
comprehensive and actively-developed text table library at
https://github.com/JakeWharton/picnic.
Usage
-----
A `FlipTable` requires headers and data in string form:
```java
String[] headers = { "Test", "Header" };
String[][] data = {
{ "Foo", "Bar" },
{ "Kit", "Kat" },
};
System.out.println(FlipTable.of(headers, data));
```
```
╔══════╤════════╗
║ Test │ Header ║
╠══════╪════════╣
║ Foo │ Bar ║
╟──────┼────────╢
║ Kit │ Kat ║
╚══════╧════════╝
```
They can be empty:
```java
String[] headers = { "Test", "Header" };
String[][] data = {};
System.out.println(FlipTable.of(headers, data));
```
```
╔══════╤════════╗
║ Test │ Header ║
╠══════╧════════╣
║ (empty) ║
╚═══════════════╝
```
Newlines are supported:
```java
String[] headers = { "One Two\nThree", "Four" };
String[][] data = { { "Five", "Six\nSeven Eight" } };
System.out.println(FlipTable.of(headers, data));
```
```
╔═════════╤═════════════╗
║ One Two │ Four ║
║ Three │ ║
╠═════════╪═════════════╣
║ Five │ Six ║
║ │ Seven Eight ║
╚═════════╧═════════════╝
```
Which means tables can be nested:
```java
String[] innerHeaders = { "One", "Two" };
String[][] innerData = { { "1", "2" } };
String inner = FlipTable.of(innerHeaders, innerData);
String[] headers = { "Left", "Right" };
String[][] data = { { inner, inner } };
System.out.println(FlipTable.of(headers, data));
```
```
╔═══════════════╤═══════════════╗
║ Left │ Right ║
╠═══════════════╪═══════════════╣
║ ╔═════╤═════╗ │ ╔═════╤═════╗ ║
║ ║ One │ Two ║ │ ║ One │ Two ║ ║
║ ╠═════╪═════╣ │ ╠═════╪═════╣ ║
║ ║ 1 │ 2 ║ │ ║ 1 │ 2 ║ ║
║ ╚═════╧═════╝ │ ╚═════╧═════╝ ║
╚═══════════════╧═══════════════╝
```
Helper methods convert from types like lists:
```java
List people = Arrays.asList(new Person("Foo", "Bar"), new Person("Kit", "Kat"));
System.out.println(FlipTableConverters.fromIterable(people, Person.class));
```
```
╔═══════════╤══════════╗
║ FirstName │ LastName ║
╠═══════════╪══════════╣
║ Foo │ Bar ║
╟───────────┼──────────╢
║ Kit │ Kat ║
╚═══════════╧══════════╝
```
Or a database result:
```java
ResultSet resultSet = statement.executeQuery("SELECT first_name, last_name FROM users");
System.out.println(FlipTableConverters.fromResultSet(resultSet));
```
```
╔════════════╤═══════════╗
║ first_name │ last_name ║
╠════════════╪═══════════╣
║ Jake │ Wharton ║
╟────────────┼───────────╢
║ Edward │ Snowden ║
╚════════════╧═══════════╝
```
Arbitrary objects are also supported:
```java
String[] headers = { "First Name", "Last Name", "Age", "Type" };
Object[][] data = {
{ "Big", "Bird", 16, PersonType.COSTUME },
{ "Joe", "Smith", 42, PersonType.HUMAN },
{ "Oscar", "Grouchant", 8, PersonType.PUPPET }
};
System.out.println(FlipTableConverters.fromObjects(headers, data));
```
```
╔════════════╤═══════════╤═════╤═════════╗
║ First Name │ Last Name │ Age │ Type ║
╠════════════╪═══════════╪═════╪═════════╣
║ Big │ Bird │ 16 │ COSTUME ║
╟────────────┼───────────┼─────┼─────────╢
║ Joe │ Smith │ 42 │ HUMAN ║
╟────────────┼───────────┼─────┼─────────╢
║ Oscar │ Grouchant │ 8 │ PUPPET ║
╚════════════╧═══════════╧═════╧═════════╝
```
Download
--------
Download the [latest jar][1] or reference on Maven central as
`com.jakewharton.fliptables:fliptables:1.1.1`.
Snapshots of the development version are available in [Sonatype's `snapshots` repository][snap].
License
-------
Copyright 2014 Jake Wharton
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
[1]: https://search.maven.org/remote_content?g=com.jakewharton.fliptables&a=fliptables&v=LATEST
[snap]: https://oss.sonatype.org/content/repositories/snapshots/