PageMixer API - 3.1

jp.ne.dti.lares.foozy.pagemixer.servlet
Class ResHeaderKey

java.lang.Object
  |
  +--jp.ne.dti.lares.foozy.pagemixer.servlet.ResHeaderKey
All Implemented Interfaces:
ServletConsumerContext.KeyCommand

public class ResHeaderKey
extends java.lang.Object
implements ServletConsumerContext.KeyCommand

Key to identify value in "Servlet response header" storage class.

Since:
PageMixer 3.1

Constructor Summary
ResHeaderKey(java.lang.String name)
          Construct key named as specified name.
 
Method Summary
 boolean equals(java.lang.Object object)
           
 java.lang.Object getValue(javax.servlet.http.HttpServlet servlet, javax.servlet.ServletContext context, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          This is not supported.
 int hashCode()
           
 void setValue(javax.servlet.http.HttpServletResponse response, java.lang.Object value)
          Set value by HttpServletResponse#setHeader.
 void setValue(javax.servlet.http.HttpServlet servlet, javax.servlet.ServletContext context, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.lang.Object value)
          Set value by HttpServletResponse#setHeader.
 java.lang.String toString()
           
 void unsetValue(javax.servlet.http.HttpServlet servlet, javax.servlet.ServletContext context, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          This is not supported.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ResHeaderKey

public ResHeaderKey(java.lang.String name)
Construct key named as specified name.
Parameters:
name - of attribute of context to access
Method Detail

setValue

public final void setValue(javax.servlet.http.HttpServletResponse response,
                           java.lang.Object value)
Set value by HttpServletResponse#setHeader.
Parameters:
response - on which consumer context depends.
value - value to be set

getValue

public java.lang.Object getValue(javax.servlet.http.HttpServlet servlet,
                                 javax.servlet.ServletContext context,
                                 javax.servlet.http.HttpServletRequest request,
                                 javax.servlet.http.HttpServletResponse response)
This is not supported.
Specified by:
getValue in interface ServletConsumerContext.KeyCommand
Parameters:
servlet - on which consumer context depends.
context - on which consumer context depends.
request - on which consumer context depends.
response - on which consumer context depends.
Returns:
value identified by this(may be null)

setValue

public void setValue(javax.servlet.http.HttpServlet servlet,
                     javax.servlet.ServletContext context,
                     javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response,
                     java.lang.Object value)
Set value by HttpServletResponse#setHeader.

This is equivalent to setValue(response, value)

Specified by:
setValue in interface ServletConsumerContext.KeyCommand
Parameters:
servlet - on which consumer context depends.
context - on which consumer context depends.
request - on which consumer context depends.
response - on which consumer context depends.
value - value to be set

unsetValue

public void unsetValue(javax.servlet.http.HttpServlet servlet,
                       javax.servlet.ServletContext context,
                       javax.servlet.http.HttpServletRequest request,
                       javax.servlet.http.HttpServletResponse response)
This is not supported.
Specified by:
unsetValue in interface ServletConsumerContext.KeyCommand
Parameters:
servlet - on which consumer context depends.
context - on which consumer context depends.
request - on which consumer context depends.
response - on which consumer context depends.
Throws:
UnsupportedOperationException - always

equals

public boolean equals(java.lang.Object object)
Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

PageMixer API - 3.1