What is the difference between PrintWriter and…

PrintWriter is a high-level class in the java.io package designed for writing formatted text data. It automatically handles character encoding and provides methods to print various data types (numbers, strings, objects). Buffering is implemented, which can improve performance.

ServletOutputStream is an abstract class in the javax.servlet.ServletOutputStream package used for sending binary data to the client in servlet-based web applications. It provides low-level access to the output stream and allows writing byte arrays. Character encoding is not automatically handled; data must be converted to bytes manually, typically using getBytes(charset).

Key differences:

Data type: PrintWriter works with text data (characters), ServletOutputStream with binary data (bytes).
Purpose: PrintWriter is convenient for sending HTML, XML, JSON, and other formatted text. ServletOutputStream is used for images, files, binary streams.
Encoding: PrintWriter automatically handles encoding, ServletOutputStream requires manual conversion to bytes considering encoding.
Methods: PrintWriter has print(), println(), printf(). ServletOutputStream has write().

Example of using PrintWriter:

// import java.io.IOException;
// import java.io.PrintWriter;
// import javax.servlet.ServletException;
// import javax.servlet.http.HttpServlet;
// import javax.servlet.http.HttpServletRequest;
// import javax.servlet.http.HttpServletResponse;

// public class TextServlet extends HttpServlet {
//     @Override
//     protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
//         response.setContentType("text/html;charset=UTF-8"); // Set content type and encoding
//         PrintWriter out = response.getWriter();
//         out.println("<html><body>");
//         out.println("<h1>Hello, world!</h1>");
//         out.println("</body></html>");
//         out.close();
//     }
// }

Example of using ServletOutputStream:

// import java.io.IOException;
// import javax.servlet.ServletException;
// import javax.servlet.ServletOutputStream;
// import javax.servlet.http.HttpServlet;
// import javax.servlet.http.HttpServletRequest;
// import javax.servlet.http.HttpServletResponse;

// public class ImageServlet extends HttpServlet {
//     @Override
//     protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
//         response.setContentType("image/png"); // Set content type
//
//         // Assume we have image bytes
//         byte[] imageData = getImageBytes(); // Method to get image bytes
//
//         ServletOutputStream out = response.getOutputStream();
//         out.write(imageData);
//         out.flush(); // Force write data
//     }
//
//     private byte[] getImageBytes() {
//         // Logic to get image bytes
//         return new byte[]{/*image bytes*/};
//     }
// }

Important: do not use getWriter() and getOutputStream() together in the same servlet response. Calling one after the other causes IllegalStateException.

What is the difference between PrintWriter and ServletOutputStream in Java?