1 /*
2 * Copyright (C) 2010, 2013 Marc Strapetz <marc.strapetz@syntevo.com>
3 * and other copyright owners as documented in the project's IP log.
4 *
5 * This program and the accompanying materials are made available
6 * under the terms of the Eclipse Distribution License v1.0 which
7 * accompanies this distribution, is reproduced below, and is
8 * available at http://www.eclipse.org/org/documents/edl-v10.php
9 *
10 * All rights reserved.
11 *
12 * Redistribution and use in source and binary forms, with or
13 * without modification, are permitted provided that the following
14 * conditions are met:
15 *
16 * - Redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer.
18 *
19 * - Redistributions in binary form must reproduce the above
20 * copyright notice, this list of conditions and the following
21 * disclaimer in the documentation and/or other materials provided
22 * with the distribution.
23 *
24 * - Neither the name of the Eclipse Foundation, Inc. nor the
25 * names of its contributors may be used to endorse or promote
26 * products derived from this software without specific prior
27 * written permission.
28 *
29 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
30 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
31 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
32 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
33 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
34 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
35 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
36 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
37 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
38 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
40 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
41 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
42 */
43
44 package org.eclipse.jgit.util.io;
45
46 import java.io.IOException;
47 import java.io.InputStream;
48
49 /**
50 * An input stream which canonicalizes EOLs bytes on the fly to '\n'.
51 *
52 * Optionally, a binary check on the first 8000 bytes is performed and in case
53 * of binary files, canonicalization is turned off (for the complete file).
54 *
55 * @deprecated use {@link AutoLFInputStream} instead
56 */
57 @Deprecated
58 public class EolCanonicalizingInputStream extends AutoLFInputStream {
59
60 /**
61 * Creates a new InputStream, wrapping the specified stream
62 *
63 * @param in
64 * raw input stream
65 * @param detectBinary
66 * whether binaries should be detected
67 */
68 public EolCanonicalizingInputStream(InputStream in, boolean detectBinary) {
69 super(in, detectBinary);
70 }
71
72 /**
73 * Creates a new InputStream, wrapping the specified stream
74 *
75 * @param in
76 * raw input stream
77 * @param detectBinary
78 * whether binaries should be detected
79 * @param abortIfBinary
80 * throw an IOException if the file is binary
81 */
82 public EolCanonicalizingInputStream(InputStream in, boolean detectBinary,
83 boolean abortIfBinary) {
84 super(in, detectBinary, abortIfBinary);
85 }
86
87 /**
88 * A special exception thrown when {@link AutoLFInputStream} is told to
89 * throw an exception when attempting to read a binary file. The exception
90 * may be thrown at any stage during reading.
91 *
92 * @since 3.3
93 */
94 public static class IsBinaryException extends IOException {
95 private static final long serialVersionUID = 1L;
96
97 IsBinaryException() {
98 super();
99 }
100 }
101
102 }