PropertyDescriptor
Inheritance: java.lang.Object
All Implemented Interfaces: com.aspose.ms.System.IEquatable
public abstract class PropertyDescriptor implements System.IEquatable<PropertyDescriptor>
Class contains property description information.
Methods
| Method | Description |
|---|---|
| equals(PropertyDescriptor other) | Indicates whether the current object is equal to another object of the same type. |
| equals(Object arg0) | |
| getCanonicalName() | The name used to refer to the property in the documentation. |
| getClass() | |
| getDataType() | The property value type, as described in [MS-OXCDATA], that specifies the type of values allowed for the property. |
| getInstance(MapiProperty property) | Retrieves PropertyDescriptor object from MAPI property |
| getInstance(int id, int dataType) | Retrieves PidTagPropertyDescriptor object |
| getInstance(String name, int dataType, UUID propertySet) | Retrieves PidNamePropertyDescriptor object |
| getInstance(long tag) | Retrieves PidTagPropertyDescriptor object |
| getInstance(long lid, int dataType, UUID propertySet) | Retrieves PidLidPropertyDescriptor object |
| getMultipleValuesDataType() | Indicates if data type contains of multiple values |
| getName() | Gets string that, identifies a property. |
| getUse8BitStringAsUnicode() | Specifies if PropertyDataType.String8 has to be interpreted as PropertyDataType.String |
| hashCode() | |
| notify() | |
| notifyAll() | |
| op_Equality(PropertyDescriptor pd1, PropertyDescriptor pd2) | Determines whether the specified objects are equal to each another. |
| op_Inequality(PropertyDescriptor pd1, PropertyDescriptor pd2) | Determines whether the specified objects are not equal to each another. |
| parse(String data) | Initializes a new instance of the PropertyDescriptor class |
| setUse8BitStringAsUnicode(boolean value) | Specifies if PropertyDataType.String8 has to be interpreted as PropertyDataType.String |
| toString() | |
| wait() | |
| wait(long arg0) | |
| wait(long arg0, int arg1) |
equals(PropertyDescriptor other)
public abstract boolean equals(PropertyDescriptor other)
Indicates whether the current object is equal to another object of the same type.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| other | PropertyDescriptor | An object to compare with this object. |
Returns: boolean - true if the current object is equal to the other parameter; otherwise, false.
equals(Object arg0)
public boolean equals(Object arg0)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | java.lang.Object |
Returns: boolean
getCanonicalName()
public final String getCanonicalName()
The name used to refer to the property in the documentation. The prefix of the canonical name identifies the basic characteristics of a property to the implementer. The canonical naming structure uses three categories that are denoted by the following prefixes to the canonical property name: * PidLid prefix: Properties identified by an unsigned 32-bit quantity along with a property set. * PidName prefix: Properties identified by a string name along with a property set. * PidTag prefix: Properties identified by an unsigned 16-bit quantity.
Returns: java.lang.String
getClass()
public final native Class<?> getClass()
Returns: java.lang.Class
getDataType()
public final int getDataType()
The property value type, as described in [MS-OXCDATA], that specifies the type of values allowed for the property.
Returns: int
getInstance(MapiProperty property)
public static PropertyDescriptor getInstance(MapiProperty property)
Retrieves PropertyDescriptor object from MAPI property
Parameters:
| Parameter | Type | Description |
|---|---|---|
| property | MapiProperty | MapiProperty object |
Returns: PropertyDescriptor
getInstance(int id, int dataType)
public static PidTagPropertyDescriptor getInstance(int id, int dataType)
Retrieves PidTagPropertyDescriptor object
Parameters:
| Parameter | Type | Description |
|---|---|---|
| id | int | Id of a property |
| dataType | int | Data type of a property |
Returns: PidTagPropertyDescriptor - PidTagPropertyDescriptor object
getInstance(String name, int dataType, UUID propertySet)
public static PidNamePropertyDescriptor getInstance(String name, int dataType, UUID propertySet)
Retrieves PidNamePropertyDescriptor object
Parameters:
| Parameter | Type | Description |
|---|---|---|
| name | java.lang.String | Name of a property |
| dataType | int | Data type of a property |
| propertySet | java.util.UUID | PropertySet of a property |
Returns: PidNamePropertyDescriptor - PidNamePropertyDescriptor object
getInstance(long tag)
public static PidTagPropertyDescriptor getInstance(long tag)
Retrieves PidTagPropertyDescriptor object
Parameters:
| Parameter | Type | Description |
|---|---|---|
| tag | long | Tag of a property |
Returns: PidTagPropertyDescriptor - PidTagPropertyDescriptor object
getInstance(long lid, int dataType, UUID propertySet)
public static PidLidPropertyDescriptor getInstance(long lid, int dataType, UUID propertySet)
Retrieves PidLidPropertyDescriptor object
Parameters:
| Parameter | Type | Description |
|---|---|---|
| lid | long | Long id of a property |
| dataType | int | Data type of a property |
| propertySet | java.util.UUID | PropertySet of a property |
Returns: PidLidPropertyDescriptor - PidLidPropertyDescriptor object
getMultipleValuesDataType()
public final boolean getMultipleValuesDataType()
Indicates if data type contains of multiple values
Returns: boolean
getName()
public final String getName()
Gets string that, identifies a property.
Returns: java.lang.String
getUse8BitStringAsUnicode()
public static boolean getUse8BitStringAsUnicode()
Specifies if PropertyDataType.String8 has to be interpreted as PropertyDataType.String
Returns: boolean
hashCode()
public native int hashCode()
Returns: int
notify()
public final native void notify()
notifyAll()
public final native void notifyAll()
op_Equality(PropertyDescriptor pd1, PropertyDescriptor pd2)
public static boolean op_Equality(PropertyDescriptor pd1, PropertyDescriptor pd2)
Determines whether the specified objects are equal to each another.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| pd1 | PropertyDescriptor | The object to compare with another object. |
| pd2 | PropertyDescriptor | The object to compare with another object. |
Returns: boolean - true if the specified PropertyDescriptor is equal to the another PropertyDescriptor; otherwise, false.
op_Inequality(PropertyDescriptor pd1, PropertyDescriptor pd2)
public static boolean op_Inequality(PropertyDescriptor pd1, PropertyDescriptor pd2)
Determines whether the specified objects are not equal to each another.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| pd1 | PropertyDescriptor | The object to compare with another object. |
| pd2 | PropertyDescriptor | The object to compare with another object. |
Returns: boolean - true if the specified PropertyDescriptor is not equal to the another PropertyDescriptor; otherwise, false.
parse(String data)
public static PropertyDescriptor parse(String data)
Initializes a new instance of the PropertyDescriptor class
Parameters:
| Parameter | Type | Description |
|---|---|---|
| data | java.lang.String | A string that represents the property description. |
Returns: PropertyDescriptor
setUse8BitStringAsUnicode(boolean value)
public static void setUse8BitStringAsUnicode(boolean value)
Specifies if PropertyDataType.String8 has to be interpreted as PropertyDataType.String
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
toString()
public String toString()
Returns: java.lang.String
wait()
public final void wait()
wait(long arg0)
public final native void wait(long arg0)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | long |
wait(long arg0, int arg1)
public final void wait(long arg0, int arg1)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | long | |
| arg1 | int |