JspRuntimeLibrary (Apache Tomcat 11.0.22 API Documentation)
Description: declaration: package: org.apache.jasper.runtime, class: JspRuntimeLibrary

# Class JspRuntimeLibrary

java.lang.Object
org.apache.jasper.runtime.JspRuntimeLibrary

public class JspRuntimeLibrary extends Object
Bunch of util methods that are used by code generated for useBean, getProperty and setProperty.

- ## Field Summary

  Fields
  Modifier and Type
  Field
  Description
  `static final boolean`
  `GRAAL`

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `JspRuntimeLibrary()`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `static String`
  `capitalize(String name)`
  Reverse of Introspector.decapitalize.
  `static Object`
  `coerce(String s, Class<?> target)`
  `static boolean`
  `coerceToBoolean(String s)`
  `static byte`
  `coerceToByte(String s)`
  `static char`
  `coerceToChar(String s)`
  `static double`
  `coerceToDouble(String s)`
  `static float`
  `coerceToFloat(String s)`
  `static int`
  `coerceToInt(String s)`
  `static long`
  `coerceToLong(String s)`
  `static short`
  `coerceToShort(String s)`
  `static Object`
  `convert(String propertyName, String s, Class<?> t, Class<?> propertyEditorClass)`
  `static void`
  `createTypedArray(String propertyName, Object bean, Method method, String[] values, Class<?> t, Class<?> propertyEditorClass)`
  Create a typed array.
  `static String`
  `escapeQueryString(String unescString)`
  Escape special shell characters.
  `static String`
  `getContextRelativePath(ServletRequest request, String relativePath)`
  Convert a possibly relative resource path into a context-relative resource path that starts with a '/'.
  `static Method`
  `getReadMethod(Class<?> beanClass, String prop)`
  `static Throwable`
  `getThrowable(ServletRequest request)`
  Returns the value of the jakarta.servlet.error.exception request attribute value, if present, otherwise the value of the jakarta.servlet.jsp.jspException request attribute value.
  `static Object`
  `getValueFromBeanInfoPropertyEditor(Class<?> attrClass, String attrName, String attrValue, Class<?> propertyEditorClass)`
  `static Object`
  `getValueFromPropertyEditorManager(Class<?> attrClass, String attrName, String attrValue)`
  `static Method`
  `getWriteMethod(Class<?> beanClass, String prop)`
  `static Object`
  `handleGetProperty(Object o, String prop)`
  `static void`
  `handleSetProperty(Object bean, String prop, boolean value)`
  `static void`
  `handleSetProperty(Object bean, String prop, byte value)`
  `static void`
  `handleSetProperty(Object bean, String prop, char value)`
  `static void`
  `handleSetProperty(Object bean, String prop, double value)`
  `static void`
  `handleSetProperty(Object bean, String prop, float value)`
  `static void`
  `handleSetProperty(Object bean, String prop, int value)`
  `static void`
  `handleSetProperty(Object bean, String prop, long value)`
  `static void`
  `handleSetProperty(Object bean, String prop, short value)`
  `static void`
  `handleSetProperty(Object bean, String prop, Object value)`
  `static void`
  `handleSetPropertyExpression(Object bean, String prop, String expression, PageContext pageContext, ProtectedFunctionMapper functionMapper)`
  `static void`
  `include(ServletRequest request, ServletResponse response, String relativePath, JspWriter out, boolean flush)`
  Perform a RequestDispatcher.include() operation, with optional flushing of the response beforehand.
  `static void`
  `introspect(Object bean, ServletRequest request)`
  `static void`
  `introspecthelper(Object bean, String prop, String value, ServletRequest request, String param, boolean ignoreMethodNF)`
  `static void`
  `nonstandardSetTag(PageContext pageContext, String var, Object value, int scope)`
  This method parallels the logic of `SetSupport.doEndTag()`.
  `static void`
  `releaseTag(Tag tag, InstanceManager instanceManager)`
  `static JspWriter`
  `startBufferedBody(PageContext pageContext, BodyTag tag)`
  `static String`
  `toString(boolean b)`
  `static String`
  `toString(byte b)`
  `static String`
  `toString(char c)`
  `static String`
  `toString(double d)`
  `static String`
  `toString(float f)`
  `static String`
  `toString(int i)`
  `static String`
  `toString(long l)`
  `static String`
  `toString(short s)`
  `static String`
  `toString(Object o)`
  `static String`
  `URLEncode(String s, String enc)`
  URL encodes a string, based on the supplied character encoding.

  ### Methods inherited from class Object

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

- ## Field Details

  - ### GRAAL

    public static final boolean GRAAL

- ## Constructor Details

  - ### JspRuntimeLibrary

    public JspRuntimeLibrary()

- ## Method Details

  - ### getThrowable

    public static Throwable getThrowable(ServletRequest request)
    Returns the value of the jakarta.servlet.error.exception request attribute value, if present, otherwise the value of the jakarta.servlet.jsp.jspException request attribute value. This method is called at the beginning of the generated servlet code for a JSP error page, when the "exception" implicit scripting language variable is initialized.
    Parameters:
      `request` - The Servlet request
    Returns:
      the throwable in the error attribute if any

  - ### coerceToBoolean

    public static boolean coerceToBoolean(String s)

  - ### coerceToByte

    public static byte coerceToByte(String s)

  - ### coerceToChar

    public static char coerceToChar(String s)

  - ### coerceToDouble

    public static double coerceToDouble(String s)

  - ### coerceToFloat

    public static float coerceToFloat(String s)

  - ### coerceToInt

    public static int coerceToInt(String s)

  - ### coerceToShort

    public static short coerceToShort(String s)

  - ### coerceToLong

    public static long coerceToLong(String s)

  - ### coerce

    public static Object coerce(String s, Class<?> target)

  - ### convert

    public static Object convert(String propertyName, String s, Class<?> t, Class<?> propertyEditorClass) throws JasperException
    Throws:
      `JasperException`

  - ### introspect

    public static void introspect(Object bean, ServletRequest request) throws JasperException
    Throws:
      `JasperException`

  - ### introspecthelper

    public static void introspecthelper(Object bean, String prop, String value, ServletRequest request, String param, boolean ignoreMethodNF) throws JasperException
    Throws:
      `JasperException`

  - ### toString

    public static String toString(Object o)

  - ### toString

    public static String toString(byte b)

  - ### toString

    public static String toString(boolean b)

  - ### toString

    public static String toString(short s)

  - ### toString

    public static String toString(int i)

  - ### toString

    public static String toString(float f)

  - ### toString

    public static String toString(long l)

  - ### toString

    public static String toString(double d)

  - ### toString

    public static String toString(char c)

  - ### createTypedArray

    public static void createTypedArray(String propertyName, Object bean, Method method, String[] values, Class<?> t, Class<?> propertyEditorClass) throws JasperException
    Create a typed array. This is a special case where params are passed through the request and the property is indexed.
    Parameters:
      `propertyName` - The property name
      `bean` - The bean
      `method` - The method
      `values` - Array values
      `t` - The class
      `propertyEditorClass` - The editor for the property
    Throws:
      `JasperException` - An error occurred

  - ### escapeQueryString

    public static String escapeQueryString(String unescString)
    Escape special shell characters.
    Parameters:
      `unescString` - The string to shell-escape
    Returns:
      The escaped shell string.

  - ### handleGetProperty

    public static Object handleGetProperty(Object o, String prop) throws JasperException
    Throws:
      `JasperException`

  - ### handleSetPropertyExpression

    public static void handleSetPropertyExpression(Object bean, String prop, String expression, PageContext pageContext, ProtectedFunctionMapper functionMapper) throws JasperException
    Throws:
      `JasperException`

  - ### handleSetProperty

    public static void handleSetProperty(Object bean, String prop, Object value) throws JasperException
    Throws:
      `JasperException`

  - ### handleSetProperty

    public static void handleSetProperty(Object bean, String prop, int value) throws JasperException
    Throws:
      `JasperException`

  - ### handleSetProperty

    public static void handleSetProperty(Object bean, String prop, short value) throws JasperException
    Throws:
      `JasperException`

  - ### handleSetProperty

    public static void handleSetProperty(Object bean, String prop, long value) throws JasperException
    Throws:
      `JasperException`

  - ### handleSetProperty

    public static void handleSetProperty(Object bean, String prop, double value) throws JasperException
    Throws:
      `JasperException`

  - ### handleSetProperty

    public static void handleSetProperty(Object bean, String prop, float value) throws JasperException
    Throws:
      `JasperException`

  - ### handleSetProperty

    public static void handleSetProperty(Object bean, String prop, char value) throws JasperException
    Throws:
      `JasperException`

  - ### handleSetProperty

    public static void handleSetProperty(Object bean, String prop, byte value) throws JasperException
    Throws:
      `JasperException`

  - ### handleSetProperty

    public static void handleSetProperty(Object bean, String prop, boolean value) throws JasperException
    Throws:
      `JasperException`

  - ### capitalize

    public static String capitalize(String name)
    Reverse of Introspector.decapitalize.
    Parameters:
      `name` - The name
    Returns:
      the capitalized string

  - ### getWriteMethod

    public static Method getWriteMethod(Class<?> beanClass, String prop) throws JasperException
    Throws:
      `JasperException`

  - ### getReadMethod

    public static Method getReadMethod(Class<?> beanClass, String prop) throws JasperException
    Throws:
      `JasperException`

  - ### getValueFromBeanInfoPropertyEditor

    public static Object getValueFromBeanInfoPropertyEditor(Class<?> attrClass, String attrName, String attrValue, Class<?> propertyEditorClass) throws JasperException
    Throws:
      `JasperException`

  - ### getValueFromPropertyEditorManager

    public static Object getValueFromPropertyEditorManager(Class<?> attrClass, String attrName, String attrValue) throws JasperException
    Throws:
      `JasperException`

  - ### getContextRelativePath

    public static String getContextRelativePath(ServletRequest request, String relativePath)
    Convert a possibly relative resource path into a context-relative resource path that starts with a '/'.
    Parameters:
      `request` - The servlet request we are processing
      `relativePath` - The possibly relative resource path
    Returns:
      an absolute path

  - ### include

    public static void include(ServletRequest request, ServletResponse response, String relativePath, JspWriter out, boolean flush) throws IOException, ServletException
    Perform a RequestDispatcher.include() operation, with optional flushing of the response beforehand.
    Parameters:
      `request` - The servlet request we are processing
      `response` - The servlet response we are processing
      `relativePath` - The relative path of the resource to be included
      `out` - The Writer to whom we are currently writing
      `flush` - Should we flush before the include is processed?
    Throws:
      `IOException` - if thrown by the included servlet
      `ServletException` - if thrown by the included servlet

  - ### URLEncode

    public static String URLEncode(String s, String enc)
    URL encodes a string, based on the supplied character encoding.
    Parameters:
      `s` - The String to be URL encoded.
      `enc` - The character encoding
    Returns:
      The URL encoded String

  - ### startBufferedBody

    public static JspWriter startBufferedBody(PageContext pageContext, BodyTag tag) throws JspException
    Throws:
      `JspException`

  - ### releaseTag

    public static void releaseTag(Tag tag, InstanceManager instanceManager)

  - ### nonstandardSetTag

    public static void nonstandardSetTag(PageContext pageContext, String var, Object value, int scope)
    This method parallels the logic of `SetSupport.doEndTag()`.
    Parameters:
      `pageContext` - pageContext
      `var` - name of the variable
      `value` - value to store
      `scope` - scope