1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * https://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.apache.commons.compress.utils;
20
21 import java.io.FilterOutputStream;
22 import java.io.IOException;
23 import java.io.OutputStream;
24
25 /**
26 * Stream that tracks the number of bytes read.
27 *
28 * @since 1.3
29 * @NotThreadSafe
30 * @deprecated Use {@link org.apache.commons.io.output.CountingOutputStream}.
31 */
32 @Deprecated
33 public class CountingOutputStream extends FilterOutputStream {
34 private long bytesWritten;
35
36 /**
37 * Creates a {@code CountingOutputStream} filter built on top of the specified underlying output stream.
38 *
39 * @param out the underlying output stream to be assigned to the field {@code this.out} for later use, or {@code null} if this instance is to be created
40 * without an underlying stream.
41 */
42 public CountingOutputStream(final OutputStream out) {
43 super(out);
44 }
45
46 /**
47 * Increments the counter of already written bytes. Doesn't increment if the EOF has been hit (written == -1)
48 *
49 * @param written the number of bytes written
50 */
51 protected void count(final long written) {
52 if (written != -1) {
53 bytesWritten += written;
54 }
55 }
56
57 /**
58 * Returns the current number of bytes written to this stream.
59 *
60 * @return the number of written bytes
61 */
62 public long getBytesWritten() {
63 return bytesWritten;
64 }
65
66 @Override
67 public void write(final byte[] b) throws IOException {
68 write(b, 0, b.length);
69 }
70
71 @Override
72 public void write(final byte[] b, final int off, final int len) throws IOException {
73 out.write(b, off, len);
74 count(len);
75 }
76
77 @Override
78 public void write(final int b) throws IOException {
79 out.write(b);
80 count(1);
81 }
82 }