Class NoOpFlash

    • Constructor Detail

      • NoOpFlash

        public NoOpFlash()
    • Method Detail

      • doPostPhaseActions

        public void doPostPhaseActions​(FacesContext ctx)
        Description copied from class: Flash

        Called after the execution of every lifecycle phase, this method allows implementations to take the necessary actions to provide the Flash scope contract as it applies to the request procesing lifecycle.

        Specified by:
        doPostPhaseActions in class Flash
        Parameters:
        ctx - the FacesContext for this request.
      • doPrePhaseActions

        public void doPrePhaseActions​(FacesContext ctx)
        Description copied from class: Flash

        Called before the execution of every lifecycle phase, this method allows implementations to take the necessary actions to provide the Flash scope contract as it applies to the request procesing lifecycle.

        Specified by:
        doPrePhaseActions in class Flash
        Parameters:
        ctx - the FacesContext for this request.
      • isKeepMessages

        public boolean isKeepMessages()
        Description copied from class: Flash

        Return the value of this JavaBeans property for the flash for this session. This value determines whether or not any FacesMessage instances queued in the current FacesContext must be preserved so they are accessible on the next traversal of the lifecycle on this session, regardless of the request being a redirect after post, or a normal postback. Map accesses for the special key “keepMessages” must return the value of this JavaBeans property.

        Jakarta Expression Language Usage Example

        First page

         
            <html xmlns="http://www.w3.org/1999/xhtml"
                  xmlns:c="jakarta.tags.core">
            <!-- extra code removed -->
              <c:set target="#{flash}" property="keepMessages" value="true" />
        
            
         

        Next page

         
            <html xmlns="http://www.w3.org/1999/xhtml"
                  xmlns:h="jakarta.faces.html">
            <!-- extra code removed -->
              <h:messages /> Any messages present on the first page must be displayed on
              this page.
        
            
         
        Specified by:
        isKeepMessages in class Flash
        Returns:
        the boolean flag whether keeping messages or not.
      • isRedirect

        public boolean isRedirect()
        Description copied from class: Flash

        Return the value of this property for the flash for this session. This must be false unless:

        • Flash.setRedirect(boolean) was called for the current lifecycle traversal with true as the argument.

        • The current lifecycle traversal for this session is in the “execute” phase and the previous traversal had Flash.setRedirect(boolean) called with true as the argument.

        Specified by:
        isRedirect in class Flash
        Returns:
        the value of this property for the flash for this session.
      • keep

        public void keep​(String key)
        Description copied from class: Flash

        Causes a value stored with a previous call to Flash.putNow(java.lang.String, java.lang.Object), its Jakarta Expression Language equivalent, or to the request Map, to be promoted to the flash so that is available on the next traversal through the lifecycle on this session.

        Specified by:
        keep in class Flash
        Parameters:
        key - if argument key is the name of an entry previously stored to the flash on this traversal through the lifecycle via a call to Flash.putNow(java.lang.String, java.lang.Object), or to a set to the EL expression #{flash.now.<key>}, or to the request Map, to be promoted to the flash as if a call to put() or a set to the expression #{flash.<key>} was being called.
      • putNow

        public void putNow​(String key,
                           Object value)
        Description copied from class: Flash

        Puts a value in the flash so that it can be accessed on this traversal of the lifecycle, rather than on the next traversal. This is simply an alias for putting a value in the request map.

        Jakarta Expression Language Usage Example

         
            <html xmlns="http://www.w3.org/1999/xhtml"
                  xmlns:c="jakarta.tags.core">
            <!-- extra code removed -->
              <c:set target="#{flash.now}" property="bar" value="barValue" />
        
              <p>Value of \#{flash.now.bar}, should be barValue.</p>
        
              <h:outputText value="#{flash.now.bar}" />
        
            
         
        Specified by:
        putNow in class Flash
        Parameters:
        key - the key for this entry
        value - the value for this entry
      • setKeepMessages

        public void setKeepMessages​(boolean newValue)
        Description copied from class: Flash

        Setter for keepMessages JavaBeans property. See Flash.isKeepMessages().

        Specified by:
        setKeepMessages in class Flash
        Parameters:
        newValue - the new value for this property on this session.
      • setRedirect

        public void setRedirect​(boolean newValue)
        Description copied from class: Flash

        Setting this property to true indicates that the next request on this session will be a redirect. Recall that on a redirect, the server sends a special response to the client instructing it to issue a new request to a specific URI. The implementation must insure that reading the value of this property on that request will return true.

        Jakarta Expression Language Usage Example

         
            <html xmlns="http://www.w3.org/1999/xhtml"
                  xmlns:c="jakarta.tags.core">
            <!-- extra code removed -->
              <c:set target="#{flash}" property="redirect" value="true" />
        
            
         
        Specified by:
        setRedirect in class Flash
        Parameters:
        newValue - the new value for this property on this session.
      • clear

        public void clear()
      • containsKey

        public boolean containsKey​(Object key)
      • containsValue

        public boolean containsValue​(Object value)
      • isEmpty

        public boolean isEmpty()
      • putAll

        public void putAll​(Map<? extends String,​? extends Object> m)
      • size

        public int size()