aboutsummaryrefslogtreecommitdiffstats
path: root/src/org/apache/fop/pdf/StreamCache.java
blob: 21aa55a36c327e27a6c6769a028be9028d2eb38d (plain)
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
/*
 * $Id$
 * Copyright (C) 2001-2003 The Apache Software Foundation. All rights reserved.
 * For details on use and redistribution please refer to the
 * LICENSE file included with these sources.
 */

package org.apache.fop.pdf;

import java.io.OutputStream;
import java.io.IOException;

/**
 * class used to store the bytes for a PDFStream. It's actually a generic
 * cached byte array, along with a factory that returns either an
 * in-memory or tempfile based implementation based on the global
 * cacheToFile setting.
 */
public abstract class StreamCache {

    /**
     * Global setting; controls whether to use tempfiles or not.
     */
    private static boolean cacheToFile = false;

    /**
     * Change the global cacheToFile flag.
     *
     * @param tizit true if cache to file
     */
    public static void setCacheToFile(boolean tizit) {
        cacheToFile = tizit;
    }

    /**
     * Get the value of the global cacheToFile flag.
     *
     * @return the current cache to file flag
     */
    public static boolean getCacheToFile() {
        return cacheToFile;
    }

    /**
     * Get the correct implementation (based on cacheToFile) of
     * StreamCache.
     *
     * @throws IOException if there is an IO error
     * @return a new StreamCache for caching streams
     */
    public static StreamCache createStreamCache() throws IOException {
        if (cacheToFile) {
            return new TempFileStreamCache();
        } else {
            return new InMemoryStreamCache();
        }
    }

    /**
     * Get the current OutputStream. Do not store it - it may change
     * from call to call.
     *
     * @throws IOException if there is an IO error
     * @return an output stream for this cache
     */
    public abstract OutputStream getOutputStream() throws IOException;

    /**
     * Filter the cache with the supplied PDFFilter.
     *
     * @param filter the filter to apply
     * @throws IOException if there is an IO error
     */
    public abstract void applyFilter(PDFFilter filter) throws IOException;

    /**
     * Outputs the cached bytes to the given stream.
     *
     * @param stream the stream to write to
     * @throws IOException if there is an IO error
     */
    public abstract void outputStreamData(OutputStream stream) throws IOException;

    /**
     * Returns the current size of the stream.
     *
     * @throws IOException if there is an IO error
     * @return the size of the cache
     */
    public abstract int getSize() throws IOException;

    /**
     * Closes the cache and frees resources.
     *
     * @throws IOException if there is an IO error
     */
    public abstract void close() throws IOException;

    /**
     * Clears and resets the cache.
     *
     * @throws IOException if there is an IO error
     */
    public abstract void reset() throws IOException;
}