SmapGenerator (Apache Tomcat 8.5.55 API Documentation)

org.apache.jasper.compiler

## Class SmapGenerator

- java.lang.Object
- - org.apache.jasper.compiler.SmapGenerator

-     public class SmapGenerator
      extends Object

  Represents a source map (SMAP), which serves to associate lines of the input JSP file(s) to lines in the generated servlet in the final .class file, according to the JSR-045 spec.
  Author:
    Shawn Bayern

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `SmapGenerator()`

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `addSmap(String smap, String stratumName)` Deprecated. Unused. This will be removed in Tomcat 9.0.x
    `void` | `addStratum(SmapStratum stratum, boolean defaultStratum)` Deprecated. Use `setStratum(SmapStratum)`
    `String` | `getString()`
    `static void` | `main(String[] args)`
    `void` | `setDoEmbedded(boolean status)` Deprecated. Unused. Will be removed in Tomcat 9.0.x
    `void` | `setOutputFileName(String x)` Sets the filename (without path information) for the generated source file.
    `void` | `setStratum(SmapStratum stratum)` Sets the default and only stratum for the smap.
    `String` | `toString()`

    - ### Methods inherited from class java.lang.Object

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

- - ### Constructor Detail

    - #### SmapGenerator

          public SmapGenerator()

  - ### Method Detail

    - #### setOutputFileName

          public void setOutputFileName(String x)

      Sets the filename (without path information) for the generated source file. E.g., "foo$jsp.java".
      Parameters:
        `x` - The file name

    - #### setStratum

          public void setStratum(SmapStratum stratum)

      Sets the default and only stratum for the smap.
      Parameters:
        `stratum` - the SmapStratum object to add

    - #### addStratum

          @Deprecated
          public void addStratum(SmapStratum stratum,
                                   boolean defaultStratum)

      Deprecated. Use `setStratum(SmapStratum)`
      Adds the given SmapStratum object, representing a Stratum with logically associated FileSection and LineSection blocks, to the current SmapGenerator. If `defaultStartum` is true, this stratum is made the default stratum, overriding any previously set default.
      Parameters:
        `stratum` - the SmapStratum object to add
        `defaultStratum` - if `true`, this SmapStratum is considered to represent the default SMAP stratum unless overwritten

    - #### addSmap

          @Deprecated
          public void addSmap(String smap,
                                String stratumName)

      Deprecated. Unused. This will be removed in Tomcat 9.0.x
      Adds the given string as an embedded SMAP with the given stratum name.
      Parameters:
        `smap` - the SMAP to embed
        `stratumName` - the name of the stratum output by the compilation that produced the `smap` to be embedded

    - #### setDoEmbedded

          @Deprecated
          public void setDoEmbedded(boolean status)

      Deprecated. Unused. Will be removed in Tomcat 9.0.x
      Instructs the SmapGenerator whether to actually print any embedded SMAPs or not. Intended for situations without an SMAP resolver.
      Parameters:
        `status` - If `false`, ignore any embedded SMAPs.

    - #### getString

          public String getString()

    - #### toString

          public String toString()

      Overrides:
        `toString` in class `Object`

    - #### main

          public static void main(String[] args)

Copyright © 2000-2020 Apache Software Foundation. All Rights Reserved.