RoutablePrintWriter (sitemesh 2.5.0 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.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface RoutablePrintWriter.DestinationFactory
Factory to lazily instantiate the destination.

Nested Classes
Modifier and Type	Class and Description
`static interface`	`RoutablePrintWriter.DestinationFactory` Factory to lazily instantiate the destination.

Field Summary
- Fields inherited from class java.io.PrintWriter
  out
- Fields inherited from class java.io.Writer
  lock

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()` Taken from `Writer`
`void`	`flush()` Taken from `Writer`
`SitemeshBuffer`	`getSitemeshBuffer()` Get the underlying buffer for the writer
`java.io.Writer`	`getUnderlyingWriter()` Because writer is a class and not an interface we need a way to self reference so we can pass the underlying Writer onto other Writers.
`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)` Taken from `Writer`
`void`	`write(char[] buf, int off, int len)` Taken from `Writer`
`void`	`write(int c)` Taken from `Writer`
`void`	`write(java.lang.String s)` Taken from `Writer`
`void`	`write(java.lang.String s, int off, int len)` Taken from `Writer`
`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

- Constructor Detail
  - RoutablePrintWriter
```
public RoutablePrintWriter(RoutablePrintWriter.DestinationFactory factory)
```
- Method Detail
  - updateDestination
```
public void updateDestination(RoutablePrintWriter.DestinationFactory factory)
```
  - getUnderlyingWriter
```
public java.io.Writer getUnderlyingWriter()
```
    Description copied from interface: SitemeshWriter
    
    Because writer is a class and not an interface we need a way to self reference so we can pass the underlying Writer onto other Writers.
    
    Specified by:
    
    getUnderlyingWriter in interface SitemeshWriter
    
    Returns:
    
    a self reference to this so it can be wrapped say.
  - close
```
public void close()
```
    Description copied from interface: SitemeshWriter
    
    Taken from Writer
    
    Specified by:
    
    close in interface SitemeshWriter
    
    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)
```
    Description copied from interface: SitemeshWriter
    
    Taken from Writer
    
    Specified by:
    
    write in interface SitemeshWriter
    
    Overrides:
    
    write in class java.io.PrintWriter
    
    Parameters:
    
    s - the characters to write
  - write
```
public void write(java.lang.String s,
                  int off,
                  int len)
```
    Description copied from interface: SitemeshWriter
    
    Taken from Writer
    
    Specified by:
    
    write in interface SitemeshWriter
    
    Overrides:
    
    write in class java.io.PrintWriter
    
    Parameters:
    
    s - the characters to write
    
    off - the offset to write from
    
    len - the length to write
  - write
```
public void write(char[] buf)
```
    Description copied from interface: SitemeshWriter
    
    Taken from Writer
    
    Specified by:
    
    write in interface SitemeshWriter
    
    Overrides:
    
    write in class java.io.PrintWriter
    
    Parameters:
    
    buf - the characters to write
  - write
```
public void write(char[] buf,
                  int off,
                  int len)
```
    Description copied from interface: SitemeshWriter
    
    Taken from Writer
    
    Specified by:
    
    write in interface SitemeshWriter
    
    Overrides:
    
    write in class java.io.PrintWriter
    
    Parameters:
    
    buf - the characters to write
    
    off - the offset to write from
    
    len - the length to write
  - write
```
public void write(int c)
```
    Description copied from interface: SitemeshWriter
    
    Taken from Writer
    
    Specified by:
    
    write in interface SitemeshWriter
    
    Overrides:
    
    write in class java.io.PrintWriter
    
    Parameters:
    
    c - the character to write
  - checkError
```
public boolean checkError()
```
    Overrides:
    
    checkError in class java.io.PrintWriter
  - flush
```
public void flush()
```
    Description copied from interface: SitemeshWriter
    
    Taken from Writer
    
    Specified by:
    
    flush in interface SitemeshWriter
    
    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

Constructor Detail

RoutablePrintWriter

Method Detail

updateDestination

getUnderlyingWriter

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