Class IndentedLineWriter

  • All Implemented Interfaces:
    Closeable, Flushable, Appendable, AutoCloseable

    public class IndentedLineWriter
    extends FilterWriter
    A writer that put some spaces in front of every lines. The indentation is initially set to 0 spaces. Users must invoke setIndentation(int) in order to set a different value.
    Since:
    2.4
    Author:
    Martin Desruisseaux
    • Field Summary

      • Fields inherited from class FilterWriter

        out
      • Fields inherited from class Writer

        lock
    • Constructor Summary

      Constructors 
      Constructor Description
      IndentedLineWriter​(Writer out)
      Constructs a stream which will add spaces in front of each line.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected void beginNewLine()
      Invoked when a new line is begining.
      int getIdentation()
      Returns the current indentation.
      void setIndentation​(int width)
      Sets the indentation to the specified value.
      void write​(char[] buffer, int offset, int length)
      Writes a portion of an array of characters.
      void write​(int c)
      Writes a single character.
      void write​(String string, int offset, int length)
      Writes a portion of a string.
      • Methods inherited from class FilterWriter

        close, flush
      • Methods inherited from class Writer

        append, append, append, nullWriter, write, write
      • Methods inherited from class Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • IndentedLineWriter

        public IndentedLineWriter​(Writer out)
        Constructs a stream which will add spaces in front of each line.
        Parameters:
        out - The underlying stream to write to.
    • Method Detail

      • getIdentation

        public int getIdentation()
        Returns the current indentation.
        Returns:
        The current indentation.
      • setIndentation

        public void setIndentation​(int width)
        Sets the indentation to the specified value.
        Parameters:
        width - The new indentation.
      • beginNewLine

        protected void beginNewLine()
                             throws IOException
        Invoked when a new line is begining. The default implementation writes the amount of spaces specified by the last call to setIndentation(int).
        Throws:
        IOException - If an I/O error occurs
      • write

        public void write​(int c)
                   throws IOException
        Writes a single character.
        Overrides:
        write in class FilterWriter
        Throws:
        IOException - If an I/O error occurs.
      • write

        public void write​(char[] buffer,
                          int offset,
                          int length)
                   throws IOException
        Writes a portion of an array of characters.
        Overrides:
        write in class FilterWriter
        Parameters:
        buffer - Buffer of characters to be written.
        offset - Offset from which to start reading characters.
        length - Number of characters to be written.
        Throws:
        IOException - If an I/O error occurs.
      • write

        public void write​(String string,
                          int offset,
                          int length)
                   throws IOException
        Writes a portion of a string.
        Overrides:
        write in class FilterWriter
        Parameters:
        string - String to be written.
        offset - Offset from which to start reading characters.
        length - Number of characters to be written.
        Throws:
        IOException - If an I/O error occurs.