vanitasvitae/Smack
1
0
Fork 0
mirror of https://github.com/vanitasvitae/Smack.git synced 2024-11-26 05:52:06 +01:00
Code Issues Releases Wiki Activity

Improved comments.

Browse source 
git-svn-id: http://svn.igniterealtime.org/svn/repos/smack/trunk@1792 b35dd754-fafc-0310-a699-88a17e54d16e
This commit is contained in:
Matt Tucker 2003-01-16 15:41:25 +00:00 committed by mtucker
parent 9ea5930d29
commit 15cb5768ae
1 changed files with 29 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

35
source/org/jivesoftware/smack/packet/IQ.java
View file

@ -53,7 +53,11 @@
package org.jivesoftware.smack.packet; package org.jivesoftware.smack.packet;
/** /**
* A generic IQ packet. * A generic IQ (Info/Query) packet. IQ packets are used to get and set information
* on the server, including authentication, roster operations, and creating
* accounts. Each IQ packet has a specific type that indicates what type of action
* is being taken: "get", "set", "result", or "error". The actual data of an IQ
* packet is normally enclosed in the query section with a specific namespace.
* *
* @author Matt Tucker * @author Matt Tucker
*/ */
@ -61,10 +65,20 @@ public class IQ extends Packet {
private Type type = Type.GET; private Type type = Type.GET;
/**
* Returns the type of the IQ packet.
*
* @return the type of the IQ packet.
*/
public Type getType() { public Type getType() {
return type; return type;
} }
/**
* Sets the type of the IQ packet.
*
* @param type the type of the IQ packet.
*/
public void setType(Type type) { public void setType(Type type) {
this.type = type; this.type = type;
} }
@ -107,10 +121,12 @@ public class IQ extends Packet {
} }
/** /**
* Implementations of this method should return the XML of the query section of * Returns the "query" XML section of the IQ packet, or <tt>null</tt> if there
* an IQ packet if that section should exist, or <tt>null</tt> otherwise. This lets * isn't one.<p>
* the majority of IQ XML writing be generic, with each sub-class providing just the *
* packet specific XML. * Generally, extensions of this class should override this method. This lets
* the majority of IQ XML writing be generic, with each sub-class providing just
* the packet-specific XML.
* *
* @return the query section of the IQ XML. * @return the query section of the IQ XML.
*/ */
@ -119,7 +135,7 @@ public class IQ extends Packet {
} }
/** /**
* A class to represent the type of the IQ packet. Valid types are: * A class to represent the type of the IQ packet. The types are:
* *
* <ul> * <ul>
* <li>IQ.Type.GET * <li>IQ.Type.GET
@ -135,6 +151,13 @@ public class IQ extends Packet {
public static final Type RESULT = new Type("result"); public static final Type RESULT = new Type("result");
public static final Type ERROR = new Type("error"); public static final Type ERROR = new Type("error");
/**
* Converts a String into the corresponding types. Valid String values
* that can be converted to types are: "get", "set", "result", and "error".
*
* @param type the String value to covert.
* @return the corresponding Type.
*/
public static Type fromString(String type) { public static Type fromString(String type) {
if (GET.toString().equals(type)) { if (GET.toString().equals(type)) {
return GET; return GET;