org.apache.juneau.utils

Class ZipFileList

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.AbstractSequentialList<E>

java.util.LinkedList<ZipFileList.ZipFileEntry>

org.apache.juneau.utils.ZipFileList

All Implemented Interfaces:

Serializable, Cloneable, Iterable<ZipFileList.ZipFileEntry>, Collection<ZipFileList.ZipFileEntry>, Deque<ZipFileList.ZipFileEntry>, List<ZipFileList.ZipFileEntry>, Queue<ZipFileList.ZipFileEntry>, Streamable

@Response
public class ZipFileList
extends LinkedList<ZipFileList.ZipFileEntry>
implements Streamable

Utility class for representing the contents of a zip file as a list of entries whose contents don't resolve until serialization time.

Generally associated with RestServlets using the responseHandlers annotation so that REST methods can easily create ZIP file responses by simply returning instances of this class.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ZipFileList.FileEntry ZipFileList entry for File entry types.
static interface	ZipFileList.ZipFileEntry Interface for ZipFileList entries.

Field Summary

Fields

Modifier and Type	Field and Description
String	fileName The name of the zip file.

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
ZipFileList(String fileName) Constructor.

Method Summary

Modifier and Type	Method and Description
ZipFileList	append(ZipFileList.ZipFileEntry e) Add an entry to this list.
String	getContentDisposition() Returns the value for the Content-Disposition header.
MediaType	getMediaType() Returns the serialized media type for this resource (e.g.
void	streamTo(OutputStream os) Serialize this object to the specified output stream.

Methods inherited from class java.util.LinkedList

add, add, addAll, addAll, addFirst, addLast, clear, clone, contains, descendingIterator, element, get, getFirst, getLast, indexOf, lastIndexOf, listIterator, offer, offerFirst, offerLast, peek, peekFirst, peekLast, poll, pollFirst, pollLast, pop, push, remove, remove, remove, removeFirst, removeFirstOccurrence, removeLast, removeLastOccurrence, set, size, spliterator, toArray, toArray

Methods inherited from class java.util.AbstractSequentialList

iterator

Methods inherited from class java.util.AbstractList

equals, hashCode, listIterator, removeRange, subList

Methods inherited from class java.util.AbstractCollection

containsAll, isEmpty, removeAll, retainAll, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List

containsAll, equals, hashCode, isEmpty, iterator, listIterator, removeAll, replaceAll, retainAll, sort, subList

Methods inherited from interface java.util.Deque

iterator

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Field Detail

fileName

public final String fileName

The name of the zip file.

Constructor Detail

ZipFileList

public ZipFileList(String fileName)

Constructor.

Parameters:

fileName - The file name of the zip file to create.

Method Detail

getMediaType

@Header(value="Content-Type")
public MediaType getMediaType()

Description copied from interface: Streamable

Returns the serialized media type for this resource (e.g. "text/html").

Specified by:

getMediaType in interface Streamable

Returns:

The media type, or null if the media type is not known.

getContentDisposition

@Header(value="Content-Disposition")
public String getContentDisposition()

Returns the value for the Content-Disposition header.

Returns:

The value for the Content-Disposition header.

streamTo

@ResponseBody
public void streamTo(OutputStream os)
                            throws IOException

Description copied from interface: Streamable

Serialize this object to the specified output stream.

Specified by:

streamTo in interface Streamable

Parameters:

os - The output stream to stream to.

Throws:

IOException - Thrown by underlying stream.

append

public ZipFileList append(ZipFileList.ZipFileEntry e)

Add an entry to this list.

Parameters:

e - The zip file entry.

Returns:

This object (for method chaining).