org.inria.ns.reflex.modules.web
Class XResponse

java.lang.Object
  extended by org.inria.ns.reflex.xml.XComponent
      extended by org.inria.ns.reflex.modules.web.XResponse
All Implemented Interfaces:
NamedType, ChildItem, Renamable, Unwrappable, XOperable

public final class XResponse
extends XComponent
implements Unwrappable

XResponse (#web:x-response) wraps an HttpServletResponse and exposes it as an XComponent.

Author:
Philippe Poulard
See Also:
HttpServletResponse

Nested Class Summary
 
Nested classes/interfaces inherited from interface org.inria.ns.reflex.structures.Unwrappable
Unwrappable.Unwrapper
 
Field Summary
 
Fields inherited from interface org.inria.ns.reflex.structures.Unwrappable
UNWRAPPER
 
Constructor Summary
XResponse(HttpServletResponse response)
          Create an XComponent that wraps an HttpServletResponse.
 
Method Summary
 EntryMap getAttributes()
           
 List getChildren()
           
 Object getParent()
          Return the parent of this child.
 QName getQName()
           
 QName getTypeName()
          Return #web:x-response.
 XOperator getXOperator()
          Return the XOperator of this object.
 void rename(QName newName)
          Rename this object.
 void setAttributes(EntryMap attributes)
           
 void setTypeName(QName typeName)
          Set the type of this component.
 Object unwrap()
          Return the HTTP response.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

XResponse

public XResponse(HttpServletResponse response)
Create an XComponent that wraps an HttpServletResponse.

Parameters:
response - The HTTP response to wrap.
See Also:
HttpServletResponse
Method Detail

getTypeName

public QName getTypeName()
Return #web:x-response.

Specified by:
getTypeName in interface NamedType
Returns:
web:x-response

unwrap

public Object unwrap()
Return the HTTP response. May be cast safely to HttpServletResponse.

Specified by:
unwrap in interface Unwrappable
Returns:
The HTTP response.
See Also:
Unwrappable.unwrap(), HttpServletResponse

getXOperator

public XOperator getXOperator()
Return the XOperator of this object.

Specified by:
getXOperator in interface XOperable
Returns:
The XOperator of this object.
See Also:
XOperable.getXOperator()

setAttributes

public void setAttributes(EntryMap attributes)
See Also:
Configurable.setAttributes(java.util.Map)

getAttributes

public EntryMap getAttributes()
See Also:
Configurable.getAttributes()

getChildren

public List getChildren()

rename

public void rename(QName newName)
Description copied from interface: Renamable
Rename this object.

Specified by:
rename in interface Renamable
Parameters:
newName - The new name of the object.

getQName

public QName getQName()

setTypeName

public void setTypeName(QName typeName)
Set the type of this component.

Parameters:
typeName - The name of the type.
Throws:
IllegalStateException - When the type has been already set.

getParent

public Object getParent()
Description copied from interface: ChildItem
Return the parent of this child.

Specified by:
getParent in interface ChildItem
Returns:
Its parent, that may be null for an orphan.