org.apache.tapestry.engine
Class NullWriter

java.lang.Object
  extended by org.apache.tapestry.engine.NullWriter
All Implemented Interfaces:
IMarkupWriter

public class NullWriter
extends Object
implements IMarkupWriter

A IMarkupWriter that does absolutely nothing; this is used during the rewind phase of the request cycle when output is discarded anyway.

Since:
0.2.9
Version:
$Id: NullWriter.java 243791 2004-02-19 17:38:13Z hlship $
Author:
Howard Lewis Ship, David Solis

Constructor Summary
NullWriter()
           
 
Method Summary
 void attribute(String name, boolean value)
          Writes a boolean attribute into the currently open tag.
 void attribute(String name, int value)
          Writes an integer attribute into the currently open tag.
 void attribute(String name, String value)
          Writes an attribute into the most recently opened tag.
 void attributeRaw(String name, String value)
          Similar to IMarkupWriter.attribute(String, String) but no escaping of invalid elements is done for the value.
 void begin(String name)
          Closes any existing tag then starts a new element.
 void beginEmpty(String name)
          Starts an element that will not later be matched with an end() call.
 boolean checkError()
          Always returns false.
 void close()
          Closes this IMarkupWriter.
 void closeTag()
          Closes the most recently opened element by writing the '>' that ends it.
 void comment(String value)
          Writes an XML/HTML comment.
 void end()
          Ends the element most recently started by IMarkupWriter.begin(String).
 void end(String name)
          Ends the most recently started element with the given name.
 void flush()
          Forwards flush() to this IMarkupWriter's PrintWriter.
 String getContentType()
          Returns the type of content generated by this response writer, as a MIME type.
 IMarkupWriter getNestedWriter()
          Returns this: since a NullWriter doesn't actually do anything, one is as good as another!.
static IMarkupWriter getSharedInstance()
           
 void print(char value)
          Prints a single character, or its equivalent entity.
 void print(char[] data, int offset, int length)
          The primary print() method, used by most other methods.
 void print(int value)
          Prints an integer.
 void print(String value)
          Invokes IMarkupWriter.print(char[], int, int) to print the string.
 void println()
          Closes the open tag (if any), then prints a line seperator to the output stream.
 void printRaw(char[] buffer, int offset, int length)
          Prints a portion of an output buffer to the stream.
 void printRaw(String value)
          Prints output to the stream.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

NullWriter

public NullWriter()
Method Detail

getSharedInstance

public static IMarkupWriter getSharedInstance()

printRaw

public void printRaw(char[] buffer,
                     int offset,
                     int length)
Description copied from interface: IMarkupWriter
Prints a portion of an output buffer to the stream. No escaping of invalid elements is done, which makes this more effecient than print(). Does nothing if buffer is null.

Closes any open tag.

Specified by:
printRaw in interface IMarkupWriter

printRaw

public void printRaw(String value)
Description copied from interface: IMarkupWriter
Prints output to the stream. No escaping of invalid elements is done, which makes this more effecient than print().

Does nothing if value is null.

Closes any open tag.

Specified by:
printRaw in interface IMarkupWriter

println

public void println()
Description copied from interface: IMarkupWriter
Closes the open tag (if any), then prints a line seperator to the output stream.

Specified by:
println in interface IMarkupWriter

print

public void print(char[] data,
                  int offset,
                  int length)
Description copied from interface: IMarkupWriter
The primary print() method, used by most other methods.

Prints the character array, first closing any open tag. Problematic characters ('<', '>' and '&') are converted to appropriate entities.

Does nothing if data is null.

Closes any open tag.

Specified by:
print in interface IMarkupWriter

print

public void print(char value)
Description copied from interface: IMarkupWriter
Prints a single character, or its equivalent entity.

Closes any open tag.

Specified by:
print in interface IMarkupWriter

print

public void print(int value)
Description copied from interface: IMarkupWriter
Prints an integer.

Closes any open tag.

Specified by:
print in interface IMarkupWriter

print

public void print(String value)
Description copied from interface: IMarkupWriter
Invokes IMarkupWriter.print(char[], int, int) to print the string. Use IMarkupWriter.printRaw(String) if the character data is known to be safe.

Does nothing if value is null.

Closes any open tag.

Specified by:
print in interface IMarkupWriter
See Also:
IMarkupWriter.print(char[], int, int)

getNestedWriter

public IMarkupWriter getNestedWriter()
Returns this: since a NullWriter doesn't actually do anything, one is as good as another!.

Specified by:
getNestedWriter in interface IMarkupWriter

getContentType

public String getContentType()
Description copied from interface: IMarkupWriter
Returns the type of content generated by this response writer, as a MIME type.

Specified by:
getContentType in interface IMarkupWriter

flush

public void flush()
Description copied from interface: IMarkupWriter
Forwards flush() to this IMarkupWriter's PrintWriter.

Specified by:
flush in interface IMarkupWriter

end

public void end()
Description copied from interface: IMarkupWriter
Ends the element most recently started by IMarkupWriter.begin(String). The name of the tag is popped off of the active element stack and used to form an HTML close tag.

Specified by:
end in interface IMarkupWriter

end

public void end(String name)
Description copied from interface: IMarkupWriter
Ends the most recently started element with the given name. This will also end any other intermediate elements. This is very useful for easily ending a table or even an entire page.

Specified by:
end in interface IMarkupWriter

comment

public void comment(String value)
Description copied from interface: IMarkupWriter
Writes an XML/HTML comment. Any open tag is first closed. The method takes care of providing the <!-- and -->, and provides a blank line after the close of the comment.

Most characters are valid inside a comment, so no check of the contents is made (much like IMarkupWriter.printRaw(String).

Specified by:
comment in interface IMarkupWriter

closeTag

public void closeTag()
Description copied from interface: IMarkupWriter
Closes the most recently opened element by writing the '>' that ends it. Once this is invoked, the attribute() methods may not be used until a new element is opened with IMarkupWriter.begin(String) or or IMarkupWriter.beginEmpty(String).

Specified by:
closeTag in interface IMarkupWriter

close

public void close()
Description copied from interface: IMarkupWriter
Closes this IMarkupWriter. Close tags are written for any active elements. The PrintWriter is then sent close(). A nested writer will commit its buffer to its containing writer.

Specified by:
close in interface IMarkupWriter

checkError

public boolean checkError()
Always returns false.

Specified by:
checkError in interface IMarkupWriter

beginEmpty

public void beginEmpty(String name)
Description copied from interface: IMarkupWriter
Starts an element that will not later be matched with an end() call. This is useful for elements that do not need closing tags.

Specified by:
beginEmpty in interface IMarkupWriter

begin

public void begin(String name)
Description copied from interface: IMarkupWriter
Closes any existing tag then starts a new element. The new element is pushed onto the active element stack.

Specified by:
begin in interface IMarkupWriter

attribute

public void attribute(String name,
                      int value)
Description copied from interface: IMarkupWriter
Writes an integer attribute into the currently open tag.

Specified by:
attribute in interface IMarkupWriter

attribute

public void attribute(String name,
                      String value)
Description copied from interface: IMarkupWriter
Writes an attribute into the most recently opened tag. This must be called after IMarkupWriter.begin(String) and before any other kind of writing (which closes the tag).

The value may be null.

Specified by:
attribute in interface IMarkupWriter

attribute

public void attribute(String name,
                      boolean value)
Description copied from interface: IMarkupWriter
Writes a boolean attribute into the currently open tag.

Specified by:
attribute in interface IMarkupWriter
Since:
3.0
See Also:
IMarkupWriter.attribute(java.lang.String, boolean)

attributeRaw

public void attributeRaw(String name,
                         String value)
Description copied from interface: IMarkupWriter
Similar to IMarkupWriter.attribute(String, String) but no escaping of invalid elements is done for the value.

Specified by:
attributeRaw in interface IMarkupWriter
Since:
3.0
See Also:
IMarkupWriter.attributeRaw(java.lang.String, java.lang.String)