Module com.aoapps.encoding.taglib

Package com.aoapps.encoding.taglib

Class EncodingNullTag

java.lang.Object

jakarta.servlet.jsp.tagext.SimpleTagSupport

com.aoapps.encoding.taglib.EncodingNullTag

All Implemented Interfaces:

JspTag, SimpleTag

Direct Known Subclasses:

OutTag

public abstract class EncodingNullTag
extends SimpleTagSupport

Automatically encodes its output based on tag context while discarding all content. When the direct output of the body will not be used, this will increase efficiency by discarding all write operations immediately.

Author:

AO Industries, Inc.

Constructor Summary

Constructors

Constructor	Description
EncodingNullTag()

Method Summary

Modifier and Type	Method	Description
void	doTag()	Deprecated. You should probably be implementing in doTag(java.io.Writer)
protected void	doTag(Writer out)	Once the out JspWriter has been replaced to output the proper content type, this version of doTag() is called.
abstract MediaType	getOutputType()	Gets the output type of this tag.
protected void	invoke(JspFragment body)	Invokes the body.
protected void	setMediaEncoderOptions(MediaEncoder mediaEncoder)	Sets the media encoder options.
protected void	writeEncoderPrefix(MediaEncoder mediaEncoder, Writer out)
protected void	writeEncoderSuffix(MediaEncoder mediaEncoder, Writer out, boolean trim)
protected void	writePrefix(MediaType containerType, Writer out)	Writes any prefix in the container's media type.
protected void	writeSuffix(MediaType containerType, Writer out)	Writes any suffix in the container's media type.

Methods inherited from class jakarta.servlet.jsp.tagext.SimpleTagSupport

findAncestorWithClass, getJspBody, getJspContext, getParent, setJspBody, setJspContext, setParent

Methods inherited from class java.lang.Object

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

Constructor Details

EncodingNullTag

public EncodingNullTag()

Method Details

getOutputType

public abstract MediaType getOutputType()

Gets the output type of this tag. This is used to determine the correct encoder. If the tag never has any output this should return null. When null is returned, any output will result in an error.

doTag

@Deprecated
public void doTag()
           throws JspException,
IOException

Deprecated.

You should probably be implementing in doTag(java.io.Writer)

Specified by:

doTag in interface SimpleTag

Overrides:

doTag in class SimpleTagSupport

Throws:

JspException

IOException

See Also:

• doTag(java.io.Writer)

invoke

protected void invoke(JspFragment body)
               throws JspException,
IOException

Invokes the body. This is only called when a body exists. Subclasses may override this to perform actions before and/or after invoking the body. Any overriding implementation should call super.invoke(JspFragment) to invoke the body, unless it wants to suppress the body invocation.

The RequestEncodingContext has been set to RequestEncodingContext.DISCARD because no validation of the content is necessary as the output is discarded. This means nested tags that attempt to produce valid output will not be limited by the parent encoding context of this tag.

This implementation invokes JspFragment.invoke(java.io.Writer) while discarding all nested output.

Throws:

JspException

IOException

writePrefix

protected void writePrefix(MediaType containerType,
 Writer out)
                    throws JspException,
IOException

Writes any prefix in the container's media type. The output must be valid for the provided type. This will not be called when the output type is null.

This default implementation prints nothing.

Parameters:

out - Validates all characters against the container media type. Already optimized via Coercion.optimize(java.io.Writer, com.aoapps.lang.io.Encoder).

Throws:

JspException

IOException

See Also:

• getOutputType()

setMediaEncoderOptions

protected void setMediaEncoderOptions(MediaEncoder mediaEncoder)

Sets the media encoder options. This is how subclass tag attributes can effect the encoding.

writeEncoderPrefix

protected void writeEncoderPrefix(MediaEncoder mediaEncoder,
 Writer out)
                           throws JspException,
IOException

Parameters:

out - Validates all characters against the container media type. Already optimized via Coercion.optimize(java.io.Writer, com.aoapps.lang.io.Encoder).

Throws:

JspException

IOException

doTag

protected void doTag(Writer out)
              throws JspException,
IOException

Once the out JspWriter has been replaced to output the proper content type, this version of doTag() is called.

The body, if present, has already been invoked with any output discarded.

This default implementation does nothing.

Parameters:

out - When the output type is null, will throw an exception if anything written, otherwise validates all characters against the output type. Already optimized via Coercion.optimize(java.io.Writer, com.aoapps.lang.io.Encoder).

Throws:

JspException

IOException

writeEncoderSuffix

protected void writeEncoderSuffix(MediaEncoder mediaEncoder,
 Writer out,
 boolean trim)
                           throws JspException,
IOException

Parameters:

out - Validates all characters against the container media type. Already optimized via Coercion.optimize(java.io.Writer, com.aoapps.lang.io.Encoder).

Throws:

JspException

IOException

writeSuffix

protected void writeSuffix(MediaType containerType,
 Writer out)
                    throws JspException,
IOException

Writes any suffix in the container's media type. The output must be valid for the provided type. This will not be called when the output type is null.

This default implementation prints nothing.

Parameters:

out - Validates all characters against the container media type. Already optimized via Coercion.optimize(java.io.Writer, com.aoapps.lang.io.Encoder).

Throws:

JspException

IOException

See Also:

• getOutputType()