java-fwf/docs/index.html at main · fixed-width-file/java-fwf · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>java-fwf - Fixed Width File Processing for Java</title>
    <style>
        :root {
            --primary: #2563eb;
            --primary-dark: #1d4ed8;
            --bg: #0f172a;
            --surface: #1e293b;
            --text: #f8fafc;
            --text-muted: #94a3b8;
            --border: #334155;
            --accent: #38bdf8;
        }

        body {
            margin: 0;
            font-family: system-ui, -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Oxygen, Ubuntu, Cantarell, sans-serif;
            background-color: var(--bg);
            color: var(--text);
            line-height: 1.6;
        }

        .container {
            max-width: 1000px;
            margin: 0 auto;
            padding: 3rem 1.5rem;
        }

        header {
            text-align: center;
            margin-bottom: 4rem;
        }

        h1 {
            font-size: 3rem;
            font-weight: 800;
            background: linear-gradient(135deg, #60a5fa 0%, #a855f7 100%);
            -webkit-background-clip: text;
            -webkit-text-fill-color: transparent;
            margin-bottom: 1rem;
        }

        p.subtitle {
            font-size: 1.25rem;
            color: var(--text-muted);
            max-width: 600px;
            margin: 0 auto 2rem;
        }

        .badge-list {
            display: flex;
            gap: 0.75rem;
            justify-content: center;
            margin-bottom: 2rem;
        }

        .badge {
            background: var(--surface);
            border: 1px solid var(--border);
            padding: 0.25rem 0.75rem;
            border-radius: 9999px;
            font-size: 0.875rem;
            color: var(--accent);
        }

        .btn-group {
            display: flex;
            gap: 1rem;
            justify-content: center;
        }

        .btn {
            display: inline-block;
            padding: 0.75rem 1.5rem;
            border-radius: 0.5rem;
            font-weight: 600;
            text-decoration: none;
            transition: all 0.2s ease;
        }

        .btn-primary {
            background-color: var(--primary);
            color: white;
        }

        .btn-primary:hover {
            background-color: var(--primary-dark);
        }

        .btn-secondary {
            background-color: var(--surface);
            color: var(--text);
            border: 1px solid var(--border);
        }

        .btn-secondary:hover {
            border-color: var(--accent);
        }

        .grid {
            display: grid;
            grid-template-columns: repeat(auto-fit, minmax(280px, 1fr));
            gap: 1.5rem;
            margin-bottom: 4rem;
        }

        .card {
            background: var(--surface);
            border: 1px solid var(--border);
            border-radius: 0.75rem;
            padding: 1.5rem;
        }

        .card h3 {
            margin-top: 0;
            color: var(--accent);
        }

        pre {
            background: #090d16;
            border: 1px solid var(--border);
            border-radius: 0.5rem;
            padding: 1rem;
            overflow-x: auto;
            color: #e2e8f0;
            font-size: 0.9rem;
        }

        footer {
            text-align: center;
            color: var(--text-muted);
            border-top: 1px solid var(--border);
            padding-top: 2rem;
            margin-top: 4rem;
        }
    </style>
</head>
<body>
    <div class="container">
        <header>
            <h1>java-fwf</h1>
            <p class="subtitle">A fast, type-safe, language-agnostic compliant Java library for parsing, formatting, and generating Fixed Width Files (FWF).</p>
            <div class="badge-list">
                <span class="badge">Java 17+ / 25</span>
                <span class="badge">JUnit 5</span>
                <span class="badge">100% Coverage</span>
                <span class="badge">FWF Spec v1.0.0</span>
            </div>
            <div class="btn-group">
                <a href="apidocs/index.html" class="btn btn-primary">Browse Javadocs API</a>
                <a href="https://github.com/fixed-width-file/java-fwf" class="btn btn-secondary">GitHub Repository</a>
            </div>
        </header>

        <section class="grid">
            <div class="card">
                <h3>⚡ Type-Safe Column Definitions</h3>
                <p>Support for <code>CharColumn</code>, <code>RightCharColumn</code>, <code>PositiveIntegerColumn</code>, <code>PositiveDecimalColumn</code>, <code>DateColumn</code>, <code>TimeColumn</code>, and <code>DateTimeColumn</code>.</p>
            </div>
            <div class="card">
                <h3>📜 Structure Descriptors</h3>
                <p>Compose header, details, and footer rows using <code>HeaderRowDescriptor</code>, <code>DetailRowDescriptor</code>, and <code>FooterRowDescriptor</code>.</p>
            </div>
            <div class="card">
                <h3>🔍 Cross-Language Hydration</h3>
                <p>Fully compatible with Python <code>pyfwf</code> hydration JSON formats and compliant with <code>fwf-compliance-tests</code> v1.0.0.</p>
            </div>
        </section>

        <section>
            <h2>Quick Usage Example</h2>
            <pre><code>import io.github.kelsoncm.fwf.columns.*;
import io.github.kelsoncm.fwf.descriptors.*;
import io.github.kelsoncm.fwf.readers.Reader;
import java.util.List;

// 1. Define Columns
CharColumn nameCol = new CharColumn("name", 20);
PositiveIntegerColumn ageCol = new PositiveIntegerColumn("age", 3);

// 2. Define Descriptors
DetailRowDescriptor detail = new DetailRowDescriptor(List.of(nameCol, ageCol));
FileDescriptor fileDescriptor = new FileDescriptor(List.of(detail));

// 3. Read Content
String content = "KELSON MEDEIROS     045\n";
Reader reader = new Reader(content, fileDescriptor, "\n");

for (var row : reader) {
    System.out.println("Name: " + row.get("name") + ", Age: " + row.get("age"));
}</code></pre>
        </section>

        <footer>
            <p>&copy; 2026 Kelson da Costa Medeiros &bull; Fixed Width File Ecosystem</p>
        </footer>
    </div>
</body>
</html>