| org.apache.axis2.jaxws.message.Block
All known Subclasses: org.apache.axis2.jaxws.message.impl.BlockImpl,
| Block | | public interface Block extends OMDataSource(Code) | | Block A Block represents an xml element and associated sub-tree. The name of the element must be
defined by a root element in a schema. All prefixes within the subtree must correspond to
namespace declarations defined within the tree. Many specifications refer to this as a "embedded
document" or "xml block". I chose the term, block, for simplicity.
The block can be exposed as: * BusinessObject * StAX object
Note that the whole Message can also be thought of as a Block. Thus a Message can be createFrom
a Block and written as a Block.
In addition, each of the accessors has a consume parameter. If consume is true, the Block is no
longer valid after the message is called. (i.e. the implementation does not need to cache the
information)
|
| getBlockFactory | | public BlockFactory getBlockFactory()(Code) | | Get BlockFactory
BlockFactory that created the Block |
| getBusinessContext | | public Object getBusinessContext()(Code) | | GetBusinesContext Some business objects have an associated context object (i.e. JAXBContext)
Context Object or null |
| getParent | | public Message getParent()(Code) | | Get the Message associated with this block
Message |
| getQName | | public QName getQName() throws WebServiceException(Code) | | Get the QName (namespace, localpart) of the Block. Do not depend on prefix being set correctly.
Asking for the QName can cause a performant hit.
QName of the block
See Also: isQNameAvailable |
| isConsumed | | public boolean isConsumed()(Code) | | isConsumed Return true if the block is consumed. Once consumed, the information in the block
is no longer available.
true if the block is consumed (a method was called with consume=true) |
| isElementData | | public boolean isElementData()(Code) | | true if data is always an element; false if possibly mixed content or multipleelements |
| isQNameAvailable | | public boolean isQNameAvailable()(Code) | | If QName is available without doing an expensive parse of the business object, thenreturn true Otherwise return false Note: This method should be used in situations whereit would be nice to know the qname (like logging or a special check) but we don't wantto cause an ill-performant parse. |
| setParent | | public void setParent(Message parent)(Code) | | Set the Message associated with this block (This method is intended to be called by the
Message Implementation only)
Parameters:
parent - |
| traceString | | public String traceString(String indent)(Code) | | Get a traceString...the trace string dumps the contents of the Block without forcing an
underlying ill-performant transformation of the message.
String containing trace information |
|
|