Module com.github.robtimus.servlet

Package com.github.robtimus.servlet

Class ServletUtils

java.lang.Object

com.github.robtimus.servlet.ServletUtils

public final class ServletUtils
extends Object

A utility class for servlets.

Author:

Rob Spoor

Method Summary

Modifier and Type	Method	Description
static ServletInputStream	transform(ServletInputStream input, com.github.robtimus.io.function.IOFunction<? super ServletInputStream,? extends InputStream> transformation)	Transforms a ServletInputStream into a different ServletInputStream.
static ServletOutputStream	transform(ServletOutputStream output, com.github.robtimus.io.function.IOFunction<? super ServletOutputStream,? extends OutputStream> transformation)	Transforms a ServletOutputStream into a different ServletOutputStream.
static BufferedReader	transform(BufferedReader input, com.github.robtimus.io.function.IOFunction<? super BufferedReader,? extends Reader> transformation)	Transforms a BufferedReader into a different BufferedReader.
static PrintWriter	transform(PrintWriter output, com.github.robtimus.io.function.IOFunction<? super PrintWriter,? extends Writer> transformation)	Transforms a PrintWriter into a different PrintWriter.

Methods inherited from class java.lang.Object

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

Method Detail

transform

public static ServletInputStream transform(ServletInputStream input,
                                           com.github.robtimus.io.function.IOFunction<? super ServletInputStream,? extends InputStream> transformation)
                                    throws IOException

Transforms a ServletInputStream into a different ServletInputStream.

The given transformation does not necessarily need to return a ServletInputStream. If it returns an InputStream that is not a ServletInputStream, it will be wrapped automatically in a new ServletInputStream.

Parameters:

input - The ServletInputStream to transform.

transformation - The transformation to apply.

Returns:

A ServletInputStream that is the result of applying the given transformation to the given ServletInputStream.

Throws:

NullPointerException - If the given ServletInputStream or transformation is null.

IOException - If an I/O error occurred during the transformation.

transform

public static BufferedReader transform(BufferedReader input,
                                       com.github.robtimus.io.function.IOFunction<? super BufferedReader,? extends Reader> transformation)
                                throws IOException

Transforms a BufferedReader into a different BufferedReader.

The given transformation does not necessarily need to return a BufferedReader. If it returns a Reader that is not a BufferedReader, it will be wrapped automatically in a new BufferedReader.

Parameters:

input - The BufferedReader to transform.

transformation - The transformation to apply.

Returns:

A BufferedReader that is the result of applying the given transformation to the given BufferedReader.

Throws:

NullPointerException - If the given BufferedReader or transformation is null.

IOException - If an I/O error occurred during the transformation.

transform

public static ServletOutputStream transform(ServletOutputStream output,
                                            com.github.robtimus.io.function.IOFunction<? super ServletOutputStream,? extends OutputStream> transformation)
                                     throws IOException

Transforms a ServletOutputStream into a different ServletOutputStream.

The given transformation does not necessarily need to return a ServletOutputStream. If it returns an OutputStream that is not a ServletOutputStream, it will be wrapped automatically in a new ServletOutputStream.

Parameters:

output - The ServletOutputStream to transform.

transformation - The transformation to apply.

Returns:

A ServletOutputStream that is the result of applying the given transformation to the given ServletOutputStream.

Throws:

NullPointerException - If the given ServletOutputStream or transformation is null.

IOException - If an I/O error occurred during the transformation.

transform

public static PrintWriter transform(PrintWriter output,
                                    com.github.robtimus.io.function.IOFunction<? super PrintWriter,? extends Writer> transformation)
                             throws IOException

Transforms a PrintWriter into a different PrintWriter.

The given transformation does not necessarily need to return a PrintWriter. If it returns a Writer that is not a PrintWriter, it will be wrapped automatically in a new PrintWriter.

Parameters:

output - The PrintWriter to transform.

transformation - The transformation to apply.

Returns:

A PrintWriter that is the result of applying the given transformation to the given PrintWriter.

Throws:

NullPointerException - If the given PrintWriter or transformation is null.

IOException - If an I/O error occurred during the transformation.