vSphere Client SDK API Documentation : version 5.5.0.1300321

com.vmware.vise.search
Interface PropertyUnmarshaller

All Known Implementing Classes:
JaxbPropertyUnmarshaller, PassthroughPropertyUnmarshaller

public interface PropertyUnmarshaller

Unmarshaller of property values from an xml stream reader.


Method Summary
 ValueEx<Object> getValue(PropertyInfo propertyInfo, XMLStreamReader reader)
          Unmarshal and return the value of the property described by propertyInfo from the reader.
 

Method Detail

getValue

ValueEx<Object> getValue(PropertyInfo propertyInfo,
                         XMLStreamReader reader)
                         throws XMLStreamException
Unmarshal and return the value of the property described by propertyInfo from the reader.

Parameters:
propertyInfo - Metadata on the property to be unmarshalled from the reader.
reader - An xml stream reader.
exceptions - If an exception occurred while getting the value, and if the unmarshaller chose not to propagate the exception but to swallow it for some reason, it can add the exception to this collection to indicate to the caller that something went wrong, but the unmarshaller did not consider it fatal. The caller is free to decide what to do with the information, e.g. it may log it. If this collection is null, then, of course, no attempt should be made to add the exception to it.
Returns:
A ValueEx instance containing the value of the property as well as any non-fatal exceptions (that may have occurred while getting the value) which the unmarshaller chose not to propagate but to swallow for whatever reason. By using the ValueEx instance, the unmarshaller can still report the exception(s) that occurred, thus indicating to the caller that something went wrong but not fatally. The caller is free to decide what to do with the information, e.g. it may log it. This value should never be null.
Throws:
XMLStreamException - if any XML stream specific issues are encountered while deserializing.

vSphere Client SDK API Documentation : version 5.5.0.1300321

Copyright @ 2012 VMware, Inc. All rights reserved.