microsoft.exchange.webservices.data.property.definition
Class PropertyDefinitionBase

java.lang.Object
  microsoft.exchange.webservices.data.property.definition.PropertyDefinitionBase

Direct Known Subclasses:

ExtendedPropertyDefinition, ServiceObjectPropertyDefinition

public abstract class PropertyDefinitionBase
extends Object

Represents the base class for all property definitions.

Constructor Summary

protected

PropertyDefinitionBase() Initializes a new instance.

Method Summary

abstract String	getPrintableName() Gets the property definition's printable name.
abstract Class<?>	getType() Gets the type of the property.
abstract ExchangeVersion	getVersion() Gets the minimum Exchange version that supports this property.
protected abstract String	getXmlElementName() Gets the name of the XML element.
String	toString()
static boolean	tryLoadFromXml(EwsServiceXmlReader reader, OutParam<PropertyDefinitionBase> propertyDefinition) Tries to load from XML.
protected abstract void	writeAttributesToXml(EwsServiceXmlWriter writer) Writes the attribute to XML.
void	writeToXml(EwsServiceXmlWriter writer) Writes to XML.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PropertyDefinitionBase

protected PropertyDefinitionBase()

Initializes a new instance.

Method Detail

tryLoadFromXml

public static boolean tryLoadFromXml(EwsServiceXmlReader reader,
                                     OutParam<PropertyDefinitionBase> propertyDefinition)
                              throws Exception

Tries to load from XML.

Parameters:

reader - The reader.

propertyDefinition - The property definition.

Returns:

True if property was loaded.

Throws:

Exception - the exception

getXmlElementName

protected abstract String getXmlElementName()

Gets the name of the XML element.

Returns:

XML element name.

writeAttributesToXml

protected abstract void writeAttributesToXml(EwsServiceXmlWriter writer)
                                      throws ServiceXmlSerializationException

Writes the attribute to XML.

Parameters:

writer - The writer.

Throws:

ServiceXmlSerializationException - the service xml serialization exception

getVersion

public abstract ExchangeVersion getVersion()

Gets the minimum Exchange version that supports this property.

Returns:

The version.

getPrintableName

public abstract String getPrintableName()

Gets the property definition's printable name.

Returns:

The property definition's printable name.

getType

public abstract Class<?> getType()

Gets the type of the property.

writeToXml

public void writeToXml(EwsServiceXmlWriter writer)
                throws XMLStreamException,
                       ServiceXmlSerializationException

Writes to XML.

Parameters:

writer - The writer.

Throws:

XMLStreamException - the XML stream exception

ServiceXmlSerializationException - the service xml serialization exception

toString

public String toString()

Overrides:

toString in class Object