RoutablePrintWriter (OpenSymphony SiteMesh 2.5 API)

java.lang.Object
- java.io.Writer
- - java.io.PrintWriter
  - - com.opensymphony.module.sitemesh.filter.RoutablePrintWriter

All Implemented Interfaces:

SitemeshWriter, java.io.Closeable, java.io.Flushable, java.lang.Appendable, java.lang.AutoCloseable
```
public class RoutablePrintWriter
extends java.io.PrintWriter
implements SitemeshWriter
```
Provides a PrintWriter that routes through to another PrintWriter, however the destination can be changed at any point. The destination can be passed in using a factory, so it will not be created until it's actually needed.

Version:

$Revision: 1.1 $

Author:

Joe Walnes

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`RoutablePrintWriter.DestinationFactory` Factory to lazily instantiate the destination.
`private static class`	`RoutablePrintWriter.NullWriter` Just to keep super constructor for PrintWriter happy - it's never actually used.

Field Summary

Fields
Modifier and Type Field and Description

private java.io.PrintWriter destination

private RoutablePrintWriter.DestinationFactory factory
- Fields inherited from class java.io.PrintWriter
  out
- Fields inherited from class java.io.Writer
  lock

Fields
Modifier and Type	Field and Description
`private java.io.PrintWriter`	`destination`
`private RoutablePrintWriter.DestinationFactory`	`factory`

Constructor Summary

Constructors
Constructor and Description

RoutablePrintWriter(RoutablePrintWriter.DestinationFactory factory)

Constructors
Constructor and Description
`RoutablePrintWriter(RoutablePrintWriter.DestinationFactory factory)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`checkError()`
`void`	`close()`
`void`	`flush()`
`private java.io.PrintWriter`	`getDestination()`
`SitemeshBuffer`	`getSitemeshBuffer()` Get the underlying buffer for the writer
`void`	`print(boolean b)`
`void`	`print(char c)`
`void`	`print(char[] s)`
`void`	`print(double d)`
`void`	`print(float f)`
`void`	`print(int i)`
`void`	`print(long l)`
`void`	`print(java.lang.Object obj)`
`void`	`print(java.lang.String s)`
`void`	`println()`
`void`	`println(boolean x)`
`void`	`println(char x)`
`void`	`println(char[] x)`
`void`	`println(double x)`
`void`	`println(float x)`
`void`	`println(int x)`
`void`	`println(long x)`
`void`	`println(java.lang.Object x)`
`void`	`println(java.lang.String x)`
`void`	`updateDestination(RoutablePrintWriter.DestinationFactory factory)`
`void`	`write(char[] buf)`
`void`	`write(char[] buf, int off, int len)`
`void`	`write(int c)`
`void`	`write(java.lang.String s)`
`void`	`write(java.lang.String s, int off, int len)`
`boolean`	`writeSitemeshBufferFragment(SitemeshBufferFragment bufferFragment)` Write a sitemesh buffer fragment to the writer.

Methods inherited from class java.io.PrintWriter
append, append, append, clearError, format, format, printf, printf, setError

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

- Field Detail
  - destination
```
private java.io.PrintWriter destination
```
  - factory
```
private RoutablePrintWriter.DestinationFactory factory
```
- Constructor Detail
  - RoutablePrintWriter
```
public RoutablePrintWriter(RoutablePrintWriter.DestinationFactory factory)
```
- Method Detail
  - getDestination
```
private java.io.PrintWriter getDestination()
```
  - updateDestination
```
public void updateDestination(RoutablePrintWriter.DestinationFactory factory)
```
  - close
```
public void close()
```
    Specified by:
    
    close in interface java.io.Closeable
    
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Overrides:
    
    close in class java.io.PrintWriter
  - println
```
public void println(java.lang.Object x)
```
    Overrides:
    
    println in class java.io.PrintWriter
  - println
```
public void println(java.lang.String x)
```
    Overrides:
    
    println in class java.io.PrintWriter
  - println
```
public void println(char[] x)
```
    Overrides:
    
    println in class java.io.PrintWriter
  - println
```
public void println(double x)
```
    Overrides:
    
    println in class java.io.PrintWriter
  - println
```
public void println(float x)
```
    Overrides:
    
    println in class java.io.PrintWriter
  - println
```
public void println(long x)
```
    Overrides:
    
    println in class java.io.PrintWriter
  - println
```
public void println(int x)
```
    Overrides:
    
    println in class java.io.PrintWriter
  - println
```
public void println(char x)
```
    Overrides:
    
    println in class java.io.PrintWriter
  - println
```
public void println(boolean x)
```
    Overrides:
    
    println in class java.io.PrintWriter
  - println
```
public void println()
```
    Overrides:
    
    println in class java.io.PrintWriter
  - print
```
public void print(java.lang.Object obj)
```
    Overrides:
    
    print in class java.io.PrintWriter
  - print
```
public void print(java.lang.String s)
```
    Overrides:
    
    print in class java.io.PrintWriter
  - print
```
public void print(char[] s)
```
    Overrides:
    
    print in class java.io.PrintWriter
  - print
```
public void print(double d)
```
    Overrides:
    
    print in class java.io.PrintWriter
  - print
```
public void print(float f)
```
    Overrides:
    
    print in class java.io.PrintWriter
  - print
```
public void print(long l)
```
    Overrides:
    
    print in class java.io.PrintWriter
  - print
```
public void print(int i)
```
    Overrides:
    
    print in class java.io.PrintWriter
  - print
```
public void print(char c)
```
    Overrides:
    
    print in class java.io.PrintWriter
  - print
```
public void print(boolean b)
```
    Overrides:
    
    print in class java.io.PrintWriter
  - write
```
public void write(java.lang.String s)
```
    Overrides:
    
    write in class java.io.PrintWriter
  - write
```
public void write(java.lang.String s,
                  int off,
                  int len)
```
    Overrides:
    
    write in class java.io.PrintWriter
  - write
```
public void write(char[] buf)
```
    Overrides:
    
    write in class java.io.PrintWriter
  - write
```
public void write(char[] buf,
                  int off,
                  int len)
```
    Overrides:
    
    write in class java.io.PrintWriter
  - write
```
public void write(int c)
```
    Overrides:
    
    write in class java.io.PrintWriter
  - checkError
```
public boolean checkError()
```
    Overrides:
    
    checkError in class java.io.PrintWriter
  - flush
```
public void flush()
```
    Specified by:
    
    flush in interface java.io.Flushable
    
    Overrides:
    
    flush in class java.io.PrintWriter
  - writeSitemeshBufferFragment
```
public boolean writeSitemeshBufferFragment(SitemeshBufferFragment bufferFragment)
                                    throws java.io.IOException
```
    Description copied from interface: SitemeshWriter
    
    Write a sitemesh buffer fragment to the writer. This may not be written immediately, it may be stored and written later, when this buffer is written out to a writer.
    
    Specified by:
    
    writeSitemeshBufferFragment in interface SitemeshWriter
    
    Parameters:
    
    bufferFragment - The buffer fragment to write
    
    Returns:
    
    True if the buffer was written immediately, or false if it will be written later
    
    Throws:
    
    java.io.IOException - If an IOException occurred
  - getSitemeshBuffer
```
public SitemeshBuffer getSitemeshBuffer()
```
    Description copied from interface: SitemeshWriter
    
    Get the underlying buffer for the writer
    
    Specified by:
    
    getSitemeshBuffer in interface SitemeshWriter
    
    Returns:
    
    The underlying buffer

Class RoutablePrintWriter

Nested Class Summary

Field Summary

Fields inherited from class java.io.PrintWriter

Fields inherited from class java.io.Writer

Constructor Summary

Method Summary

Methods inherited from class java.io.PrintWriter

Methods inherited from class java.lang.Object

Field Detail

destination

factory

Constructor Detail

RoutablePrintWriter

Method Detail

getDestination

updateDestination

close

println

println

println

println

println

println

println

println

println

println

print

print

print

print

print

print

print

print

print

write

write

write

write

write

checkError

flush

writeSitemeshBufferFragment

getSitemeshBuffer