    View Javadoc
    1   package org.apache.commons.net.io;
    2
    3   /* ====================================================================
    4    * The Apache Software License, Version 1.1
    5    *
    6    * Copyright (c) 2001 The Apache Software Foundation.  All rights
    7    * reserved.
    8    *
    9    * Redistribution and use in source and binary forms, with or without
    10   * modification, are permitted provided that the following conditions
    11   * are met:
    12   *
    13   * 1. Redistributions of source code must retain the above copyright
    14   *    notice, this list of conditions and the following disclaimer.
    15   *
    16   * 2. Redistributions in binary form must reproduce the above copyright
    17   *    notice, this list of conditions and the following disclaimer in
    18   *    the documentation and/or other materials provided with the
    19   *    distribution.
    20   *
    21   * 3. The end-user documentation included with the redistribution,
    22   *    if any, must include the following acknowledgment:
    23   *       "This product includes software developed by the
    24   *        Apache Software Foundation (http://www.apache.org/)."
    25   *    Alternately, this acknowledgment may appear in the software itself,
    26   *    if and wherever such third-party acknowledgments normally appear.
    27   *
    28   * 4. The names "Apache" and "Apache Software Foundation" and
    29   *    "Apache Commons" must not be used to endorse or promote products
    30   *    derived from this software without prior written permission. For
    31   *    written permission, please contact apache@apache.org.
    32   *
    33   * 5. Products derived from this software may not be called "Apache",
    34   *    nor may "Apache" appear in their name, without
    35   *    prior written permission of the Apache Software Foundation.
    36   *
    37   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
    38   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
    39   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
    40   * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
    41   * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
    42   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
    43   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
    44   * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
    45   * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
    46   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
    47   * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
    48   * SUCH DAMAGE.
    49   * ====================================================================
    50   *
    51   * This software consists of voluntary contributions made by many
    52   * individuals on behalf of the Apache Software Foundation.  For more
    53   * information on the Apache Software Foundation, please see
    54   * <http://www.apache.org/>;.
    55   */
    56
    57  import java.io.FilterOutputStream;
    58  import java.io.IOException;
    59  import java.io.OutputStream;
    60
    61  /****
    62   * This class wraps an output stream, replacing all singly occurring
    63   * <LF> (linefeed) characters with <CR><LF> (carriage return
    64   * followed by linefeed), which is the NETASCII standard for representing
    65   * a newline.
    66   * You would use this class to implement ASCII file transfers requiring
    67   * conversion to NETASCII.
    68   * <p>
    69   * <p>
    70   * @author Daniel F. Savarese
    71   ***/
    72
    73  public final class ToNetASCIIOutputStream extends FilterOutputStream
    74  {
    75      private boolean __lastWasCR;
    76
    77      /****
    78       * Creates a ToNetASCIIOutputStream instance that wraps an existing
    79       * OutputStream.
    80       * <p>
    81       * @param output  The OutputStream to wrap.
    82       ***/
    83      public ToNetASCIIOutputStream(OutputStream output)
    84      {
    85          super(output);
    86          __lastWasCR = false;
    87      }
    88
    89
    90      /****
    91       * Writes a byte to the stream.    Note that a call to this method
    92       * may result in multiple writes to the underlying input stream in order
    93       * to convert naked newlines to NETASCII line separators.
    94       * This is transparent to the programmer and is only mentioned for
    95       * completeness.
    96       * <p>
    97       * @param ch The byte to write.
    98       * @exception IOException If an error occurs while writing to the underlying
    99       *            stream.
    100      ***/
    101     public synchronized void write(int ch)
    102     throws IOException
    103     {
    104         switch (ch)
    105         {
    106         case '\r':
    107             __lastWasCR = true;
    108             out.write('\r');
    109             return ;
    110         case '\n':
    111             if (!__lastWasCR)
    112                 out.write('\r');
    113             // Fall through
    114         default:
    115             __lastWasCR = false;
    116             out.write(ch);
    117             return ;
    118         }
    119     }
    120
    121
    122     /****
    123      * Writes a byte array to the stream.
    124      * <p>
    125      * @param buffer  The byte array to write.
    126      * @exception IOException If an error occurs while writing to the underlying
    127      *            stream.
    128      ***/
    129     public synchronized void write(byte buffer[])
    130     throws IOException
    131     {
    132         write(buffer, 0, buffer.length);
    133     }
    134
    135
    136     /****
    137      * Writes a number of bytes from a byte array to the stream starting from
    138      * a given offset.
    139      * <p>
    140      * @param buffer  The byte array to write.
    141      * @param offset  The offset into the array at which to start copying data.
    142      * @param length  The number of bytes to write.
    143      * @exception IOException If an error occurs while writing to the underlying
    144      *            stream.
    145      ***/
    146     public synchronized void write(byte buffer[], int offset, int length)
    147     throws IOException
    148     {
    149         while (length-- > 0)
    150             write(buffer[offset++]);
    151     }
    152
    153 }

This page was automatically generated by Maven