forked from shrinkwrap/shrinkwrap
-
Notifications
You must be signed in to change notification settings - Fork 2
/
Archive.java
565 lines (522 loc) · 20.9 KB
/
Archive.java
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
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
/*
* JBoss, Home of Professional Open Source
* Copyright 2009, Red Hat Middleware LLC, and individual contributors
* by the @authors tag. See the copyright.txt in the distribution for a
* full listing of individual contributors.
*
* 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.
*/
package org.jboss.shrinkwrap.api;
import java.io.OutputStream;
import java.util.Collection;
import java.util.Map;
import org.jboss.shrinkwrap.api.asset.Asset;
import org.jboss.shrinkwrap.api.asset.NamedAsset;
import org.jboss.shrinkwrap.api.exporter.StreamExporter;
import org.jboss.shrinkwrap.api.formatter.Formatter;
import org.jboss.shrinkwrap.api.formatter.Formatters;
/**
* Represents a collection of resources which may be constructed programmatically. In effect this represents a virtual
* filesystem.
*
* <br />
* <br />
* All {@link Archive} types support the addition of {@link Node}s under a designated {@link ArchivePath} (context). The
* contents of a {@link Node} are either a directory or {@link Asset}.
*
* <br />
* <br />
* {@link Archive}s are generally created via an {@link ArchiveFactory} or via the default configuration shortcut
* {@link ShrinkWrap} utility class.
*
* <br />
* <br />
* Because {@link Archive}s are {@link Assignable}, they may be wrapped in another user "view" used to perform
* operations like adding JavaEE Spec-specific resources or exporting in ZIP format.
*
* @author <a href="mailto:andrew.rubinger@jboss.org">ALR</a>
* @version $Revision: $
*/
public interface Archive<T extends Archive<T>> extends Assignable {
// -------------------------------------------------------------------------------------||
// Contracts --------------------------------------------------------------------------||
// -------------------------------------------------------------------------------------||
/**
* Obtains the name of this archive (ie. myLibrary.jar)
*/
String getName();
/**
* Adds the specified asset under the specified path into the target context
*
* @param target
* The context under which to add the assets
* @param asset
* @return
* @throws IllegalArgumentException
* If no target or assets were specified
* @throws IllegalArchivePathException
* If the target is invalid.
*/
T add(Asset asset, ArchivePath target) throws IllegalArgumentException;
/**
* Adds the specified asset under the specified target (directory) using the specified name. The resultant path will
* be treating the specified path as a prefix namespace, then appending the name.
*
* @param target
* The context directory under which to add the asset
* @param name
* The name to assign the assent under the target namespace
* @param asset
* @return
* @throws IllegalArgumentException
* If the target, name, or asset was not specified
* @throws IllegalArchivePathException
* If the target is invalid.
*/
T add(Asset asset, ArchivePath target, String name) throws IllegalArgumentException;
/**
* Adds the specified asset under the specified target (directory) using the specified name. The resultant path will
* be treating the specified path as a prefix namespace, then appending the name.
*
* @param target
* The context directory under which to add the asset
* @param name
* The name to assign the assent under the target namespace
* @param asset
* @return
* @throws IllegalArgumentException
* If the target, name, or asset was not specified
* @throws IllegalArchivePathException
* If the target is invalid.
*/
T add(Asset asset, String target, String name) throws IllegalArgumentException;
/**
* Adds the asset encapsulated within the specified {@link NamedAsset} under the encapsulated name and target
* (directory)
*
* @param namedAsset
* @return
* @throws IllegalArgumentException
* If either the target or asset is not specified
* @throws IllegalArchivePathException
* If the target is invalid.
*/
T add(NamedAsset namedAsset) throws IllegalArgumentException;
/**
* Adds the specified resource under the context denoted by the specified target
*
* @param target
* @param asset
* @return
* @throws IllegalArgumentException
* If either the target or asset is not specified
* @throws IllegalArchivePathException
* If the target is invalid.
*/
T add(Asset asset, String target) throws IllegalArgumentException;
/**
* Adds the specified directory.
*
* @param path
* The path to add
* @return This archive
* @throws IllegalArgumentException
* If no path was specified
* @throws IllegalArchivePathException
* If the path is invalid.
*/
T addAsDirectory(String path) throws IllegalArgumentException;
/**
* Adds the specified directories.
*
* @param paths
* The paths to add
* @return This archive
* @throws IllegalArgumentException
* If no paths were specified
* @throws IllegalArchivePathException
* If at least one path is invalid.
*/
T addAsDirectories(String... paths) throws IllegalArgumentException;
/**
* Adds the specified directory.
*
* @param path
* The path to add
* @return This archive
* @throws IllegalArgumentException
* If no path was specified
* @throws IllegalArchivePathException
* If the path is invalid.
*/
T addAsDirectory(ArchivePath path) throws IllegalArgumentException;
/**
* Adds the specified directories.
*
* @param paths
* The paths to add
* @return This archive
* @throws IllegalArgumentException
* If no paths were specified
* @throws IllegalArchivePathException
* If at least one path is invalid.
*/
T addAsDirectories(ArchivePath... paths) throws IllegalArgumentException;
/**
* Obtains the {@link Node} located at the specified path
*
* @param path
* @return The {@link Node}, or null if nothing is found at the specified path
* @throws IllegalArgumentException
* If the path is not specified
*/
Node get(ArchivePath path) throws IllegalArgumentException;
/**
* Obtains the {@link Node} located at the specified path
*
* @param path
* @return The {@link Node}, or null if nothing is found at the Path
* @throws IllegalArgumentException
* If the path is not specified
*/
Node get(String path) throws IllegalArgumentException;
/**
* Get a nested {@link Archive} as a specific type.<br/>
* <br/>
*
* The found Archives must have been added as a Archive, no import is performed.
*
* @param <X>
* @param type
* The Type to return the Archive as
* @param path
* The location of the Archive
* @return The found Archive as given type or null if none found at given path
* @throws IllegalArgumentException
* if found {@link Asset} is not pointing to a {@link Archive}
* @see Archive#getAsType(Class, ArchivePath)
* @see Archive#add(Archive, ArchivePath, Class)
* @see Archive#add(Archive, String, Class)
*/
<X extends Archive<X>> X getAsType(Class<X> type, String path);
/**
* Get a nested {@link Archive} as a specific type.<br/>
* <br/>
*
* The found Archives must have been added as a Archive, no import is performed.
*
* @param <X>
* @param type
* The Type to return the Archive as
* @param path
* The location of the Archive
* @return The found Archive as given type or null if none found at given {@link ArchivePath}
* @throws IllegalArgumentException
* if found {@link Asset} is not pointing to a {@link Archive}
* @see Archive#add(Archive, ArchivePath, Class)
* @see Archive#add(Archive, String, Class)
*/
<X extends Archive<X>> X getAsType(Class<X> type, ArchivePath path);
/**
* Get all nested {@link Archive} matching the filter as a specific type.<br/>
* <br/>
*
* The found Archives must have been added as a Archive, no import is performed.
*
* @param <X>
* @param type
* The Type to return the Archive as
* @param filter
* Filter to match result
* @return A {@link Collection} of found Archives matching given filter or empty {@link Collection} if non found.
* @throws IllegalArgumentException
* if found {@link Asset} is not pointing to a {@link Archive}
* @see Archive#getAsType(Class, ArchivePath)
* @see Archive#add(Archive, ArchivePath, Class)
* @see Archive#add(Archive, String, Class)
*/
<X extends Archive<X>> Collection<X> getAsType(Class<X> type, Filter<ArchivePath> filter);
/**
* Get a nested {@link Archive} as a specific type using the specify {@code ArchiveFormat}
*
* @param type
* The Type to return the Archive as
* @param path
* The location of the Archive
* @param archive
* The archive format
* @return The found Archive as given type or null if none found at the given path
* @see Archive#add(Archive, ArchivePath, Class)
* @see Archive#add(Archive, String, Class)
*/
<X extends Archive<X>> X getAsType(Class<X> type, String path, ArchiveFormat archiveFormat);
/**
* Get a nested {@link Archive} located in a {@code ArchivePath} as a specific type using the specify
* {@code ArchiveFormat}
*
* @param type
* The Type to return the Archive as
* @param path
* The location of the Archive
* @param archive
* The archive format
* @return The found Archive as given type or null if none found at given {@link ArchivePath}
* @see Archive#add(Archive, ArchivePath, Class)
* @see Archive#add(Archive, String, Class)
*/
<X extends Archive<X>> X getAsType(Class<X> type, ArchivePath path, ArchiveFormat archiveFormat);
/**
* Get all nested {@link Archive} matching the filter as a specific type using the specify {@code ArchiveFormat}.
*
* @param <X>
* @param type
* The Type to return the Archive as
* @param filter
* Filter to match result
* @param archive
* The archive format
* @return A {@link Collection} of found Archives matching given filter or empty {@link Collection} if non found.
* @see Archive#getAsType(Class, ArchivePath, ArchiveFormatStreamBindings)
* @see Archive#add(Archive, ArchivePath, Class)
* @see Archive#add(Archive, String, Class)
*/
<X extends Archive<X>> Collection<X> getAsType(Class<X> type, Filter<ArchivePath> filter,
ArchiveFormat archiveFormat);
/**
* Denotes whether this archive contains a resource at the specified path
*
* @param path
* @return
* @throws IllegalArgumentException
* If the path is not specified
*/
boolean contains(ArchivePath path) throws IllegalArgumentException;
/**
* Denotes whether this archive contains a resource at the specified path
*
* @param path
* @return
* @throws IllegalArgumentException
* If the path is not specified
*/
boolean contains(String path) throws IllegalArgumentException;
/**
* Removes the {@link Node} in the {@link Archive} at the specified {@link ArchivePath}. If the path is a directory,
* recursively removes all contents. If the path does not exist, return null.
*
* @param path
* @return The Node removed
*/
Node delete(ArchivePath path) throws IllegalArgumentException;
/**
* Removes the {@link Node} in the {@link Archive} at the {@link ArchivePath} indicated by the specified String
* archivePath. If the path is a directory, recursively removes all contents. If the path does not exist, return
* null.
*
* @param archivePath
* @return The Node removed
* @see #delete(ArchivePath)
*/
Node delete(String archivePath) throws IllegalArgumentException;
/**
* Obtains all assets in this archive, along with their respective paths. The returned Map will be an immutable view.
*
* @return
*/
Map<ArchivePath, Node> getContent();
/**
* Obtains all assets matching given filter in this archive, along with its respective Path. The returned Map will
* be an immutable view.
*
* @return
*/
Map<ArchivePath, Node> getContent(Filter<ArchivePath> filter);
/**
* Add an archive under a specific context and maintain the archive name as context path.
*
* @param path
* to use
* @param archive
* to add
* @param exporter
* Exporter type to use in fulfilling the {@link Asset#openStream()} contract for the added (nested)
* archive.
* @return
* @throws IllegalArgumentException
* If any argument is not specified
*/
T add(Archive<?> archive, ArchivePath path, Class<? extends StreamExporter> exporter)
throws IllegalArgumentException;
/**
* Add an archive under a specific context and maintain the archive name as context path.
*
* @param path
* to use
* @param archive
* to add
* @param exporter
* Exporter type to use in fulfilling the {@link Asset#openStream()} contract for the added (nested)
* archive.
* @return
* @throws IllegalArgumentException
* If the path or archive are not specified
*/
T add(Archive<?> archive, String path, Class<? extends StreamExporter> exporter) throws IllegalArgumentException;
/**
* Merge the contents from an existing archive without maintaining the archive name in the context path.
*
* @param source
* Archive to add contents from
* @return
* @throws IllegalArgumentException
* If the existing archive is not specified
*/
T merge(Archive<?> source) throws IllegalArgumentException;
/**
* Merge the contents from an existing archive without maintaining the archive name in the context path.
*
* The filter control which {@link ArchivePath}s to include form the source {@link Archive}.
*
* @param source
* Archive to add contents from
* @return
* @throws IllegalArgumentException
* If the existing archive is not specified
*/
T merge(Archive<?> source, Filter<ArchivePath> filter) throws IllegalArgumentException;
/**
* Merge the contents from an existing archive in a specific path without maintaining the archive name in the
* context path.
*
* @param source
* Archive to add contents from
* @param path
* Path to add contents to
* @return
* @throws IllegalArgumentException
* If the path or existing archive is not specified
*/
T merge(Archive<?> source, ArchivePath path) throws IllegalArgumentException;
/**
* Merge the contents from an existing archive in a specific path without maintaining the archive name in the
* context path.
*
* @param source
* Archive to add contents from
* @param path
* Path to add contents to
* @return
* @throws IllegalArgumentException
* If the path or existing archive is not specified
*/
T merge(Archive<?> source, String path) throws IllegalArgumentException;
/**
* Merge the contents from an existing archive in a specific path without maintaining the archive name in the
* context path. The filter control which {@link ArchivePath}s to include form the source {@link Archive}.
*
* @param source
* Archive to add contents from
* @param path
* Path to add contents to
* @param filter
* Filter to use for including {@link Asset}s in the merge.
* @return
* @throws IllegalArgumentException
* If the path or existing archive is not specified
*/
T merge(Archive<?> source, ArchivePath path, Filter<ArchivePath> filter) throws IllegalArgumentException;
/**
* Merge the contents from an existing archive in a specific path without maintaining the archive name in the
* context path. The filter control which {@link ArchivePath}s to include form the source {@link Archive}.
*
* @param source
* Archive to add contents from
* @param path
* Path to add contents to
* @param filter
* Filter to use for including {@link Asset}s in the merge.
* @return
* @throws IllegalArgumentException
* If the path or existing archive is not specified
*/
T merge(Archive<?> source, String path, Filter<ArchivePath> filter) throws IllegalArgumentException;
/**
* Moves the asset under the source path to the target path.
*
* @param source
* The context under which to remove the assets
* @param target
* The context under which to add the moved assets
* @return the resulting archive with the moved assets
* @throws IllegalArgumentException
* If any of the paths is not specified
* @throws IllegalArchivePathException
* If the source path is invalid.
*/
T move(ArchivePath source, ArchivePath target) throws IllegalArgumentException, IllegalArchivePathException;
/**
* Moves the asset under the source path to the target path.
*
* @param source
* The context under which to remove the assets
* @param target
* The context under which to add the moved assets
* @return the resulting archive with the moved assets
* @throws IllegalArgumentException
* If any of the paths is not specified
* @throws IllegalArchivePathException
* If the source path is invalid.
*/
T move(String source, String target) throws IllegalArgumentException, IllegalArchivePathException;
/**
* Acts as a shorthand for {@link Archive#toString(Formatter)} where the {@link Formatters#SIMPLE} is leveraged.
*
* @return
*/
String toString();
/**
* If "true" is specified, acts as a shorthand for {@link Archive#toString(Formatter)} where the
* {@link Formatters#VERBOSE} is leveraged. Otherwise the {@link Formatters#SIMPLE} will be used (equivalent to
* {@link Archive#toString()}).
*
* @return
*/
String toString(boolean verbose);
/**
* Returns a view of this {@link Archive} as returned from the specified {@link Formatter}. Common options may be to
* use the predefined formatters located in {@link Formatters}
*
* @param formatter
* @return
* @throws IllegalArgumentException
* If the formatter is not specified
*/
String toString(Formatter formatter) throws IllegalArgumentException;
/**
* Prints the content of this {@link Archive} to the specified {@link OutputStream} on the format defined by the
* specified {@link Formatter}. The caller is responsible for opening, flushing and eventually closing the stream.
*
* @param outputStream
* the stream to print the archive contents to
* @param formatter
* the output format
* @throws IllegalArgumentException
* if an exceptions occur when writing the archive contents.
*/
void writeTo(OutputStream outputStream, Formatter formatter) throws IllegalArgumentException;
/**
* Creates a shallow copy of this {@link Archive}. Assets from this archive are made available under the same paths.
* However, removing old assets or adding new assets on this archive affects does not affect the new archive.
*
* @return a new archive with a copy of the pointers to the assets
*/
Archive<T> shallowCopy();
}