Package org.apache.maven.doxia.util

Class LineBreaker

  • public class LineBreaker
extends java.lang.Object
    Allows to specify the line-length of an output writer.
    Version:
    $Id$

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int DEFAULT_MAX_LINE_LENGTH
      The default maximal line length.
      private java.io.Writer destination
      The destination writer.
      private static java.lang.String EOL
      The system dependent EOL.
      private int lineLength
      The current line length.
      private int maxLineLength
      The maximal line length.
      private java.lang.StringBuilder word
      The string buffer to store the current text.
      private java.io.BufferedWriter writer
      The writer to use.

    • Constructor Summary

      Constructors 
      Constructor Description
      LineBreaker​(java.io.Writer out)
      Constructs a new LineBreaker with DEFAULT_MAX_LINE_LENGTH.
      LineBreaker​(java.io.Writer out, int max)
      Constructs a new LineBreaker with the given max line length.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void close()
      Close the writer.
      void flush()
      Write out the current StringBuilder and flush the writer.
      java.io.Writer getDestination()
      Returns the current destination writer.
      void write​(java.lang.String text)
      Writes the given text to the writer.
      void write​(java.lang.String text, boolean preserveSpace)
      Writes the given text to the writer.
      private void writeWord()
      Writes the current StringBuilder to the writer.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • DEFAULT_MAX_LINE_LENGTH

        public static final int DEFAULT_MAX_LINE_LENGTH
        The default maximal line length.
        See Also:
        Constant Field Values

      • EOL

        private static final java.lang.String EOL
        The system dependent EOL.

      • destination

        private java.io.Writer destination
        The destination writer.

      • writer

        private java.io.BufferedWriter writer
        The writer to use.

      • maxLineLength

        private int maxLineLength
        The maximal line length.

      • lineLength

        private int lineLength
        The current line length.

      • word

        private java.lang.StringBuilder word
        The string buffer to store the current text.

    • Constructor Detail

      • LineBreaker

        public LineBreaker​(java.io.Writer out)
        Constructs a new LineBreaker with DEFAULT_MAX_LINE_LENGTH.
        Parameters:
        out - The writer to use.

      • LineBreaker

        public LineBreaker​(java.io.Writer out,
                   int max)
        Constructs a new LineBreaker with the given max line length.
        Parameters:
        out - The writer to use.
        max - The maximal line length.

    • Method Detail

      • getDestination

        public java.io.Writer getDestination()
        Returns the current destination writer.
        Returns:
        The destination.

      • write

        public void write​(java.lang.String text)
           throws java.io.IOException
        Writes the given text to the writer. White space is not preserved.
        Parameters:
        text - The text to write.
        Throws:
        java.io.IOException - if there's a problem writing the text.

      • write

        public void write​(java.lang.String text,
                  boolean preserveSpace)
        Writes the given text to the writer.
        Parameters:
        text - The text to write.
        preserveSpace - True to preserve white space.

      • flush

        public void flush()
        Write out the current StringBuilder and flush the writer. Any IOException will be swallowed.

      • writeWord

        private void writeWord()
                throws java.io.IOException
        Writes the current StringBuilder to the writer.
        Throws:
        java.io.IOException - if an exception occurs during writing.

      • close

        public void close()
        Close the writer.