1
0
Fork 0
mirror of https://codeberg.org/Mercury-IM/Smack synced 2024-11-22 14:22:05 +01:00

Improve IQ.Type javadoc

This commit is contained in:
Florian Schmaus 2015-01-21 23:48:46 +01:00
parent dc6af6dd99
commit e722018808

View file

@ -256,21 +256,30 @@ public abstract class IQ extends Packet {
} }
/** /**
* A enum to represent the type of the IQ packet. The types are: * A enum to represent the type of the IQ stanza.
*
* <ul>
* <li>IQ.Type.get
* <li>IQ.Type.set
* <li>IQ.Type.result
* <li>IQ.Type.error
* </ul>
*/ */
public enum Type { public enum Type {
/**
* The IQ stanza requests information, inquires about what data is needed in order to complete further operations, etc.
*/
get, get,
/**
* The IQ stanza provides data that is needed for an operation to be completed, sets new values, replaces existing values, etc.
*/
set, set,
/**
* The IQ stanza is a response to a successful get or set request.
*/
result, result,
error;
/**
* The IQ stanza reports an error that has occurred regarding processing or delivery of a get or set request.
*/
error,
;
/** /**
* Converts a String into the corresponding types. Valid String values * Converts a String into the corresponding types. Valid String values