Package org.apache.taglibs.standard.tag.common.fmt

Class BundleSupport

  • All Implemented Interfaces:
    jakarta.servlet.jsp.tagext.BodyTag, jakarta.servlet.jsp.tagext.IterationTag, jakarta.servlet.jsp.tagext.JspTag, jakarta.servlet.jsp.tagext.Tag, Serializable
    Direct Known Subclasses:
    BundleTag, BundleTag
    public abstract class BundleSupport
extends jakarta.servlet.jsp.tagext.BodyTagSupport
    Support for tag handlers for <bundle>, the resource bundle loading tag in JSTL 1.0.
    Author:
    Jan Luehe
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected String basename  
      protected String prefix  

      • Fields inherited from class jakarta.servlet.jsp.tagext.BodyTagSupport

        bodyContent

      • Fields inherited from class jakarta.servlet.jsp.tagext.TagSupport

        id, pageContext

      • Fields inherited from interface jakarta.servlet.jsp.tagext.BodyTag

        EVAL_BODY_BUFFERED, EVAL_BODY_TAG

      • Fields inherited from interface jakarta.servlet.jsp.tagext.IterationTag

        EVAL_BODY_AGAIN

      • Fields inherited from interface jakarta.servlet.jsp.tagext.Tag

        EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

    • Constructor Summary

      Constructors 
      Constructor Description
      BundleSupport()  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int doEndTag()  
      int doStartTag()  
      jakarta.servlet.jsp.jstl.fmt.LocalizationContext getLocalizationContext()  
      static jakarta.servlet.jsp.jstl.fmt.LocalizationContext getLocalizationContext​(jakarta.servlet.jsp.PageContext pc)
      Gets the default I18N localization context.
      static jakarta.servlet.jsp.jstl.fmt.LocalizationContext getLocalizationContext​(jakarta.servlet.jsp.PageContext pc, String basename)
      Gets the resource bundle with the given base name, whose locale is determined as follows: Check if a match exists between the ordered set of preferred locales and the available locales, for the given base name.
      String getPrefix()  
      void release()  

      • Methods inherited from class jakarta.servlet.jsp.tagext.BodyTagSupport

        doAfterBody, doInitBody, getBodyContent, getPreviousOut, setBodyContent

      • Methods inherited from class jakarta.servlet.jsp.tagext.TagSupport

        findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue

      • Methods inherited from interface jakarta.servlet.jsp.tagext.Tag

        getParent, setPageContext, setParent

    • Field Detail

      • basename

        protected String basename

      • prefix

        protected String prefix

    • Constructor Detail

      • BundleSupport

        public BundleSupport()

    • Method Detail

      • getLocalizationContext

        public jakarta.servlet.jsp.jstl.fmt.LocalizationContext getLocalizationContext()

      • getPrefix

        public String getPrefix()

      • doStartTag

        public int doStartTag()
               throws jakarta.servlet.jsp.JspException
        Specified by:
        doStartTag in interface jakarta.servlet.jsp.tagext.Tag
        Overrides:
        doStartTag in class jakarta.servlet.jsp.tagext.BodyTagSupport
        Throws:
        jakarta.servlet.jsp.JspException

      • doEndTag

        public int doEndTag()
             throws jakarta.servlet.jsp.JspException
        Specified by:
        doEndTag in interface jakarta.servlet.jsp.tagext.Tag
        Overrides:
        doEndTag in class jakarta.servlet.jsp.tagext.BodyTagSupport
        Throws:
        jakarta.servlet.jsp.JspException

      • release

        public void release()
        Specified by:
        release in interface jakarta.servlet.jsp.tagext.Tag
        Overrides:
        release in class jakarta.servlet.jsp.tagext.BodyTagSupport

      • getLocalizationContext

        public static jakarta.servlet.jsp.jstl.fmt.LocalizationContext getLocalizationContext​(jakarta.servlet.jsp.PageContext pc)
        Gets the default I18N localization context.
        Parameters:
        pc - Page in which to look up the default I18N localization context

      • getLocalizationContext

        public static jakarta.servlet.jsp.jstl.fmt.LocalizationContext getLocalizationContext​(jakarta.servlet.jsp.PageContext pc,
                                                                                      String basename)
        Gets the resource bundle with the given base name, whose locale is determined as follows: Check if a match exists between the ordered set of preferred locales and the available locales, for the given base name. The set of preferred locales consists of a single locale (if the jakarta.servlet.jsp.jstl.fmt.locale configuration setting is present) or is equal to the client's preferred locales determined from the client's browser settings.

        If no match was found in the previous step, check if a match exists between the fallback locale (given by the jakarta.servlet.jsp.jstl.fmt.fallbackLocale configuration setting) and the available locales, for the given base name.

        Parameters:
        pc - Page in which the resource bundle with the given base name is requested
        basename - Resource bundle base name
        Returns:
        Localization context containing the resource bundle with the given base name and the locale that led to the resource bundle match, or the empty localization context if no resource bundle match was found