Class Interpreter

java.lang.Object
org.zkoss.web.servlet.dsp.Interpreter

public class Interpreter extends Object
The interpreter of the DSP file.

Note: we recognize only <%, <\%, %>, %\>, ${ and $\{. Unlike JSP, we don't recognize \${ or \$\{.

Author:
tomyeh
  • Constructor Summary

    Constructors
    Constructor
    Description
    Constructor.
  • Method Summary

    Modifier and Type
    Method
    Description
    static final String
    Returns the content type by specifying a path, or null if no content type is available or path is null.
    final void
    interpret(jakarta.servlet.ServletContext ctx, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, Writer out, String content, String ctype, org.zkoss.util.resource.Locator locator)
    Interprets the specified content based on the HTTP request.
    final void
    interpret(jakarta.servlet.ServletContext ctx, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, String content, String ctype, org.zkoss.util.resource.Locator locator)
    Interprets the specified content based on the HTTP request.
    final void
    interpret(DspContext dc, String content, String ctype, org.zkoss.xel.XelContext xelc)
    Interprets the specified content and generates the result to the output specified in DspContext.
    parse(String content, String ctype, org.zkoss.xel.XelContext xelc, org.zkoss.util.resource.Locator loc)
    Parses a content to a meta format called Interpretation.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Constructor Details

    • Interpreter

      public Interpreter()
      Constructor.
  • Method Details

    • getContentType

      public static final String getContentType(String path)
      Returns the content type by specifying a path, or null if no content type is available or path is null.

      It determines the content type by looking the extension. Note: it considers the extension of "a.css.dsp" as "css".

    • parse

      public final Interpretation parse(String content, String ctype, org.zkoss.xel.XelContext xelc, org.zkoss.util.resource.Locator loc) throws DspException, IOException, org.zkoss.xel.XelException
      Parses a content to a meta format called Interpretation.
      Parameters:
      xelc - the context formation for evaluating ZUL expressions. It can be null, in which case no additional functions and variable resolvers are initialized at the beginning.
      ctype - the content type. Optional. It is used only if no page action at all. If it is not specified and not page action, "text/html" is assumed.
      Throws:
      DspException
      IOException
      org.zkoss.xel.XelException
      Since:
      3.0.0
    • interpret

      public final void interpret(DspContext dc, String content, String ctype, org.zkoss.xel.XelContext xelc) throws DspException, IOException, org.zkoss.xel.XelException
      Interprets the specified content and generates the result to the output specified in DspContext.
      Parameters:
      dc - the interpreter context; never null.
      content - the content of DSP to interpret
      ctype - the content type. Optional. It is used only if no page action at all. If it is not specified and not page action, "text/html" is assumed.
      Throws:
      DspException
      IOException
      org.zkoss.xel.XelException
      Since:
      3.0.0
    • interpret

      public final void interpret(jakarta.servlet.ServletContext ctx, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, String content, String ctype, org.zkoss.util.resource.Locator locator) throws DspException, IOException, org.zkoss.xel.XelException
      Interprets the specified content based on the HTTP request. It actually wraps the HTTP request into DspContext and then invoke interpret(DspContext, String, String, XelContext).
      Parameters:
      locator - used to locate resources, such as taglib. If null is specified, the locator for the specified servlet context is used. (In other words, we use ServletContextLocator if locator is null).
      ctype - the content type. Optional. It is used only if no page action at all. If it is not specified and not page action, "text/html" is assumed.
      Throws:
      DspException
      IOException
      org.zkoss.xel.XelException
    • interpret

      public final void interpret(jakarta.servlet.ServletContext ctx, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, Writer out, String content, String ctype, org.zkoss.util.resource.Locator locator) throws DspException, IOException, org.zkoss.xel.XelException
      Interprets the specified content based on the HTTP request. It actually wraps the HTTP request into DspContext and then invoke interpret(DspContext, String, String, XelContext).
      Parameters:
      locator - used to locate resources, such as taglib. If null is specified, the locator for the specified servlet context is used. (In other words, we use ServletContextLocator if locator is null).
      ctype - the content type. Optional. It is used only if no page action at all. If it is not specified and not page action, "text/html" is assumed.
      out - the output to generate the result. If null, it is the same as interpret(ServletContext,HttpServletRequest,HttpServletResponse,String,String,Locator) In other words, response.getWriter() is used.
      Throws:
      DspException
      IOException
      org.zkoss.xel.XelException
      Since:
      2.4.1