Interface WebXml

All Known Implementing Classes:
WebXmlImpl

public interface WebXml
This interface offers methods to obtain information from web.xml.
  • Method Summary

    Modifier and Type
    Method
    Description
    getContextParam(String paramName, jakarta.faces.context.FacesContext context, String defaultValue)
    Obtains the param-value for the context-param given by param-name via the given FacesContext instance.
    default String
    getContextParam(String paramName, String defaultValue)
    Obtains the param-value for the context-param given by param-name via the current FacesContext instance.
    default boolean
    Parses the param-value for the context-param given by param-name via the current FacesContext instance and returns true if the param-value is equal, ignoring case, to the string "true".
    default boolean
    isContextParamTrue(String paramName, jakarta.faces.context.FacesContext context)
    Parses the param-value for the context-param given by param-name via the given FacesContext instance and returns true if the param-value is equal, ignoring case, to the string "true".
  • Method Details

    • getContextParam

      String getContextParam(String paramName, jakarta.faces.context.FacesContext context, String defaultValue)
      Obtains the param-value for the context-param given by param-name via the given FacesContext instance.
      Parameters:
      paramName - param-name of the context-param element in web.xml
      context - FacesContext instance
      defaultValue - default value to return if the context-param does not exist
      Returns:
      param-value or defaultValue
    • getContextParam

      default String getContextParam(String paramName, String defaultValue)
      Obtains the param-value for the context-param given by param-name via the current FacesContext instance.
      Parameters:
      paramName - param-name of the context-param element in web.xml
      defaultValue - default value to return if the context-param does not exist
      Returns:
      param-value or defaultValue
    • isContextParamTrue

      default boolean isContextParamTrue(String paramName, jakarta.faces.context.FacesContext context)
      Parses the param-value for the context-param given by param-name via the given FacesContext instance and returns true if the param-value is equal, ignoring case, to the string "true".
      Parameters:
      paramName - param-name of the context-param element in web.xml
      context - FacesContext instance
      Returns:
      true if the context-param's value is true
    • isContextParamTrue

      default boolean isContextParamTrue(String paramName)
      Parses the param-value for the context-param given by param-name via the current FacesContext instance and returns true if the param-value is equal, ignoring case, to the string "true".
      Parameters:
      paramName - param-name of the context-param element in web.xml
      Returns:
      true if the context-param's value is true