| java.lang.Object
 org.apache.axis2.jaxws.message.impl.BlockImpl
All known Subclasses: org.apache.axis2.jaxws.message.databinding.impl.XMLStringBlockImpl, org.apache.axis2.jaxws.message.databinding.impl.SourceBlockImpl, org.apache.axis2.jaxws.message.databinding.impl.OMBlockImpl, org.apache.axis2.jaxws.message.databinding.impl.JAXBBlockImpl, org.apache.axis2.jaxws.message.databinding.impl.SOAPEnvelopeBlockImpl,
| BlockImpl | | abstract public class BlockImpl implements Block(Code) | | BlockImpl Abstract Base class for various Block Implementations.
The base class takes care of controlling the transformations between BusinessObject,
XMLStreamReader and SOAPElement A derived class must minimally define the following:
_getBOFromReader _getReaderFromBO _outputFromBO
In addtion, the derived class may want to override the following: _getBOFromBO ...if the
BusinessObject is consumed when read (i.e. it is an InputSource)
The derived classes don't have direct access to the instance data. This ensures that BlockImpl
controls the transformations.
|
| Method Summary | |
| protected Object | _getBOFromBO(Object busObject, Object busContext, boolean consume)
The default implementation is to return the business object. | | abstract protected Object | _getBOFromReader(XMLStreamReader reader, Object busContext)
| | abstract protected XMLStreamReader | _getReaderFromBO(Object busObj, Object busContext)
| | abstract protected void | _outputFromBO(Object busObject, Object busContext, XMLStreamWriter writer)
Output BusinessObject contents to a Writer. | | protected void | _outputFromReader(XMLStreamReader reader, XMLStreamWriter writer)
Output Reader contents to a Writer. | | protected XMLStreamReader | _postPivot_getXMLStreamReader()
Called if we have passed the pivot point but someone wants to output the block. | | protected void | _postPivot_outputTo(XMLStreamWriter writer)
Called if we have passed the pivot point but someone wants to output the block. | | public BlockFactory | getBlockFactory()
| | public Object | getBusinessContext()
| | public Object | getBusinessObject(boolean consume)
| | public OMElement | getOMElement()
| | public Message | getParent()
| | public QName | getQName()
| | public XMLStreamReader | getReader()
| | public XMLStreamReader | getXMLStreamReader(boolean consume)
| | protected boolean | isBusinessObject()
true if the representation of the block is currently a business object. | | public boolean | isConsumed()
| | public boolean | isQNameAvailable()
| | public void | outputTo(XMLStreamWriter writer, boolean consume)
| | public void | serialize(OutputStream output, OMOutputFormat format)
| | public void | serialize(Writer writerTarget, OMOutputFormat format)
| | public void | serialize(XMLStreamWriter writer)
| | public void | setConsumed(boolean consume)
| | public void | setParent(Message p)
| | protected void | setQName(QName qName)
| | public String | traceString(String indent)
|
| consumed | | protected boolean consumed(Code) | | |
| omElement | | protected OMElement omElement(Code) | | |
| BlockImpl | | protected BlockImpl(Object busObject, Object busContext, QName qName, BlockFactory factory)(Code) | | A Block has the following components
Parameters:
busObject -
Parameters:
busContext - or null
Parameters:
qName - or null if unknown
Parameters:
factory - that creates the Block |
| BlockImpl | | protected BlockImpl(OMElement omElement, Object busContext, QName qName, BlockFactory factory)(Code) | | A Block has the following components
Parameters:
reader -
Parameters:
busContext - or null
Parameters:
qName - or null if unknown
Parameters:
factory - that creates the Block |
| _getBOFromBO | | protected Object _getBOFromBO(Object busObject, Object busContext, boolean consume)(Code) | | The default implementation is to return the business object. A derived block may want to
override this class if the business object is consumed when read (thus the dervived block may
want to make a buffered copy) (An example use case for overriding this method is the
businessObject is an InputSource)
Parameters:
busObject -
Parameters:
busContext -
Parameters:
consume - |
| isBusinessObject | | protected boolean isBusinessObject()(Code) | | true if the representation of the block is currently a business object. Derived classesmay use this information to get information in a performant way. |
| isConsumed | | public boolean isConsumed()(Code) | | |
| isQNameAvailable | | public boolean isQNameAvailable()(Code) | | |
| setConsumed | | public void setConsumed(boolean consume)(Code) | | Once consumed, all instance data objects are nullified to prevent subsequent access
Parameters:
consume - |
| setQName | | protected void setQName(QName qName)(Code) | | This method is intended for derived objects to set the qName
Parameters:
qName - |
|
|