PrettyWriter

java.lang.Object
- java.io.Writer
- - gnu.text.PrettyWriter

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.lang.Appendable, java.lang.AutoCloseable
```
public class PrettyWriter
extends java.io.Writer
```
A pretty printer. This code is transcribed from pprint.lisp in Steel Bank Common Lisp, which is again based on the code in CMU Common Lisp.

Field Summary

Fields
Modifier and Type	Field and Description
`char[]`	`buffer` Holds all the text that has been output but not yet printed.
`int`	`bufferFillPointer` The index into BUFFER where more text should be put.
`static ThreadLocation`	`indentLoc`
`static int`	`initialBufferSize`
`static ThreadLocation`	`lineLengthLoc`
`static ThreadLocation`	`miserWidthLoc`
`static int`	`NEWLINE_FILL`
`static int`	`NEWLINE_LINEAR`
`static int`	`NEWLINE_LITERAL`
`static int`	`NEWLINE_MANDATORY`
`static int`	`NEWLINE_MISER`
`static int`	`NEWLINE_SPACE` A non-nested ' ' gets an implicit NEWLINE_SPACE.
`protected java.io.Writer`	`out`
`int`	`pendingBlocksCount` Number of startLogicalBlock - number of endLogicalBlock.

Fields inherited from class java.io.Writer
lock

Constructor Summary

Constructors
Constructor and Description
`PrettyWriter(java.io.Writer out)`
`PrettyWriter(java.io.Writer out, boolean prettyPrintingMode)`
`PrettyWriter(java.io.Writer out, int lineLength)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addIndentation(int amount, boolean current)`
`void`	`clearBuffer()`
`void`	`clearWordEnd()`
`void`	`close()`
`void`	`closeThis()` Flush and close this local Writer, but not underlying Writers.
`void`	`endLogicalBlock()`
`void`	`endLogicalBlock(java.lang.String suffix)`
`int`	`enqueue(int kind, int size)`
`int`	`enqueueIndent(char kind, int amount)`
`void`	`enqueueNewline(int kind)`
`void`	`flush()`
`void`	`forcePrettyOutput()`
`int`	`getColumnNumber()` Not meaningful if `prettyPrintingMode > 0`.
`protected int`	`getMiserWidth()`
`int`	`getPrettyPrintingMode()` Return pretty-printing mode.
`boolean`	`isPrettyPrinting()` Is pretty printing enabled?
`void`	`lineAbbreviationHappened()`
`void`	`setColumnNumber(int column)`
`void`	`setIndentation(int column)`
`void`	`setPrettyPrinting(boolean mode)` Turn pretty printing on or off.
`void`	`setPrettyPrintingMode(int mode)` Control pretty-printing mode.
`void`	`startLogicalBlock(java.lang.String prefix, boolean perLine, java.lang.String suffix)`
`void`	`write(char[] str)`
`void`	`write(char[] str, int start, int count)`
`void`	`write(int ch)`
`void`	`write(java.lang.String str)`
`void`	`write(java.lang.String str, int start, int count)`
`void`	`writeBreak(int kind)`
`void`	`writeWordEnd()` Note the end of a "word".
`void`	`writeWordStart()` Maybe write a word-separating space.

Methods inherited from class java.io.Writer
append, append, append

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - out
```
protected java.io.Writer out
```
  - lineLengthLoc
```
public static ThreadLocation lineLengthLoc
```
  - miserWidthLoc
```
public static ThreadLocation miserWidthLoc
```
  - indentLoc
```
public static ThreadLocation indentLoc
```
  - initialBufferSize
```
public static int initialBufferSize
```
  - buffer
```
public char[] buffer
```
    Holds all the text that has been output but not yet printed.
  - bufferFillPointer
```
public int bufferFillPointer
```
    The index into BUFFER where more text should be put.
  - pendingBlocksCount
```
public int pendingBlocksCount
```
    Number of startLogicalBlock - number of endLogicalBlock.
  - NEWLINE_LINEAR
```
public static final int NEWLINE_LINEAR
```
    See Also:
    Constant Field Values
  - NEWLINE_LITERAL
```
public static final int NEWLINE_LITERAL
```
    See Also:
    Constant Field Values
  - NEWLINE_FILL
```
public static final int NEWLINE_FILL
```
    See Also:
    Constant Field Values
  - NEWLINE_SPACE
```
public static final int NEWLINE_SPACE
```
    A non-nested ' ' gets an implicit NEWLINE_SPACE. This is treated similarly to NEWLINE_FILL, but not quite.
    
    See Also:
    Constant Field Values
  - NEWLINE_MISER
```
public static final int NEWLINE_MISER
```
    See Also:
    Constant Field Values
  - NEWLINE_MANDATORY
```
public static final int NEWLINE_MANDATORY
```
    See Also:
    Constant Field Values
- Constructor Detail
  - PrettyWriter
```
public PrettyWriter(java.io.Writer out)
```
  - PrettyWriter
```
public PrettyWriter(java.io.Writer out,
            int lineLength)
```
  - PrettyWriter
```
public PrettyWriter(java.io.Writer out,
            boolean prettyPrintingMode)
```
- Method Detail
  - setPrettyPrintingMode
```
public void setPrettyPrintingMode(int mode)
```
    Control pretty-printing mode.
    
    Parameters:
    mode - the value 0 disables pretty-printing; the value 1 enables ecplicit pretty-printing; the value 2 enables pretty-printing with auto-fill, which means that spaces are treated like enqueing NEWLINE_SPACE (essentiall a 'fill').
  - getPrettyPrintingMode
```
public int getPrettyPrintingMode()
```
    Return pretty-printing mode.
    
    Returns:
    0, 1, 2, as described for setPrettyPrintingMode(int).
  - isPrettyPrinting
```
public boolean isPrettyPrinting()
```
    Is pretty printing enabled?
  - setPrettyPrinting
```
public void setPrettyPrinting(boolean mode)
```
    Turn pretty printing on or off. Equivalent to setPrettyPrintingMode(mode?1:0).
  - writeWordEnd
```
public void writeWordEnd()
```
    Note the end of a "word". See writeWordStart().
  - writeWordStart
```
public void writeWordStart()
```
    Maybe write a word-separating space. Specifically, write a space if the previous output was writeWordEnd(). Otherwise, do nothing.
  - clearWordEnd
```
public void clearWordEnd()
```
  - write
```
public void write(int ch)
```
    Overrides:
    
    write in class java.io.Writer
  - write
```
public void write(java.lang.String str)
```
    Overrides:
    
    write in class java.io.Writer
  - write
```
public void write(java.lang.String str,
         int start,
         int count)
```
    Overrides:
    
    write in class java.io.Writer
  - write
```
public void write(char[] str)
```
    Overrides:
    
    write in class java.io.Writer
  - write
```
public void write(char[] str,
         int start,
         int count)
```
    Specified by:
    
    write in class java.io.Writer
  - setIndentation
```
public void setIndentation(int column)
```
  - enqueue
```
public int enqueue(int kind,
          int size)
```
  - enqueueNewline
```
public void enqueueNewline(int kind)
```
  - writeBreak
```
public final void writeBreak(int kind)
```
  - enqueueIndent
```
public int enqueueIndent(char kind,
                int amount)
```
  - addIndentation
```
public void addIndentation(int amount,
                  boolean current)
```
  - startLogicalBlock
```
public void startLogicalBlock(java.lang.String prefix,
                     boolean perLine,
                     java.lang.String suffix)
```
  - endLogicalBlock
```
public void endLogicalBlock()
```
  - endLogicalBlock
```
public void endLogicalBlock(java.lang.String suffix)
```
  - getMiserWidth
```
protected int getMiserWidth()
```
  - lineAbbreviationHappened
```
public void lineAbbreviationHappened()
```
  - forcePrettyOutput
```
public void forcePrettyOutput()
                       throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - flush
```
public void flush()
```
    Specified by:
    
    flush in interface java.io.Flushable
    
    Specified by:
    
    flush in class java.io.Writer
  - close
```
public void close()
           throws java.io.IOException
```
    Specified by:
    
    close in interface java.io.Closeable
    
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Specified by:
    
    close in class java.io.Writer
    
    Throws:
    
    java.io.IOException
  - closeThis
```
public void closeThis()
               throws java.io.IOException
```
    Flush and close this local Writer, but not underlying Writers.
    
    Throws:
    
    java.io.IOException
  - getColumnNumber
```
public int getColumnNumber()
```
    Not meaningful if prettyPrintingMode > 0.
  - setColumnNumber
```
public void setColumnNumber(int column)
```
  - clearBuffer
```
public void clearBuffer()
```

Class PrettyWriter

Field Summary

Fields inherited from class java.io.Writer

Constructor Summary

Method Summary

Methods inherited from class java.io.Writer

Methods inherited from class java.lang.Object

Field Detail

out

lineLengthLoc

miserWidthLoc

indentLoc

initialBufferSize

buffer

bufferFillPointer

pendingBlocksCount

NEWLINE_LINEAR

NEWLINE_LITERAL

NEWLINE_FILL

NEWLINE_SPACE

NEWLINE_MISER

NEWLINE_MANDATORY

Constructor Detail

PrettyWriter

PrettyWriter

PrettyWriter

Method Detail

setPrettyPrintingMode

getPrettyPrintingMode

isPrettyPrinting

setPrettyPrinting

writeWordEnd

writeWordStart

clearWordEnd

write

write

write

write

write

setIndentation

enqueue

enqueueNewline

writeBreak

enqueueIndent

addIndentation

startLogicalBlock

endLogicalBlock

endLogicalBlock

getMiserWidth

lineAbbreviationHappened

forcePrettyOutput

flush

close

closeThis

getColumnNumber

setColumnNumber

clearBuffer