vanitasvitae/Smack
1
0
Fork 0
mirror of https://github.com/vanitasvitae/Smack.git synced 2025-12-12 14:01:08 +01:00
Code Issues Releases Wiki Activity

Fix javadoc issues in some packages

Browse source
This commit is contained in:
Paul Schaub 2017-12-23 20:21:19 +01:00
parent cb18056613
commit 52398b535f
Signed by: vanitasvitae
GPG key ID: 62BEE9264BF17311
50 changed files with 255 additions and 56 deletions
Download patch file Download diff file Expand all files Collapse all files

6
smack-extensions/src/main/java/org/jivesoftware/smackx/vcardtemp/VCardManager.java
View file

@ -92,6 +92,8 @@ public final class VCardManager extends Manager {
* Save this vCard for the user connected by 'connection'. XMPPConnection should be authenticated
* and not anonymous.
*
* @param vcard VCard.
*
* @throws XMPPErrorException thrown if there was an issue setting the VCard in the server.
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
@ -110,6 +112,7 @@ public final class VCardManager extends Manager {
/**
* Load the VCard of the current user.
*
* @return VCard.
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
@ -122,6 +125,9 @@ public final class VCardManager extends Manager {
/**
* Load VCard information for a given user.
*
* @param bareJid bareJid of the user.
*
* @return VCard.
* @throws XMPPErrorException
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException

17
smack-extensions/src/main/java/org/jivesoftware/smackx/vcardtemp/packet/VCard.java
View file

@ -135,10 +135,11 @@ public class VCard extends IQ {
}
/**
* Set generic VCard field.
* Get the content of a generic VCard field.
*
* @param field value of field. Possible values: NICKNAME, PHOTO, BDAY, JABBERID, MAILER, TZ,
* GEO, TITLE, ROLE, LOGO, NOTE, PRODID, REV, SORT-STRING, SOUND, UID, URL, DESC.
* @return content of field.
*/
public String getField(String field) {
return otherSimpleFields.get(field);
@ -273,6 +274,7 @@ public class VCard extends IQ {
*
* @param addrField one of POSTAL, PARCEL, (DOM | INTL), PREF, POBOX, EXTADR, STREET,
* LOCALITY, REGION, PCODE, CTRY
* @return content of home address field.
*/
public String getAddressFieldHome(String addrField) {
return homeAddr.get(addrField);
@ -283,6 +285,7 @@ public class VCard extends IQ {
*
* @param addrField one of POSTAL, PARCEL, (DOM | INTL), PREF, POBOX, EXTADR, STREET,
* LOCALITY, REGION, PCODE, CTRY
* @param value new value for the field.
*/
public void setAddressFieldHome(String addrField, String value) {
homeAddr.put(addrField, value);
@ -293,6 +296,7 @@ public class VCard extends IQ {
*
* @param addrField one of POSTAL, PARCEL, (DOM | INTL), PREF, POBOX, EXTADR, STREET,
* LOCALITY, REGION, PCODE, CTRY
* @return content of work address field.
*/
public String getAddressFieldWork(String addrField) {
return workAddr.get(addrField);
@ -303,6 +307,7 @@ public class VCard extends IQ {
*
* @param addrField one of POSTAL, PARCEL, (DOM | INTL), PREF, POBOX, EXTADR, STREET,
* LOCALITY, REGION, PCODE, CTRY
* @param value new value for the field.
*/
public void setAddressFieldWork(String addrField, String value) {
workAddr.put(addrField, value);
@ -323,6 +328,7 @@ public class VCard extends IQ {
* Get home phone number.
*
* @param phoneType one of VOICE, FAX, PAGER, MSG, CELL, VIDEO, BBS, MODEM, ISDN, PCS, PREF
* @return content of home phone number.
*/
public String getPhoneHome(String phoneType) {
return homePhones.get(phoneType);
@ -342,6 +348,7 @@ public class VCard extends IQ {
* Get work phone number.
*
* @param phoneType one of VOICE, FAX, PAGER, MSG, CELL, VIDEO, BBS, MODEM, ISDN, PCS, PREF
* @return content of work phone number.
*/
public String getPhoneWork(String phoneType) {
return workPhones.get(phoneType);
@ -470,6 +477,8 @@ public class VCard extends IQ {
* Common code for getting the bytes of a url.
*
* @param url the url to read.
* @return bytes of the file pointed to by URL.
* @throws IOException if an IOException occurs while reading the file.
*/
public static byte[] getBytes(URL url) throws IOException {
final String path = url.getPath();
@ -557,6 +566,8 @@ public class VCard extends IQ {
/**
* Load VCard information for a connected user. XMPPConnection should be authenticated
* and not anonymous.
*
* @param connection connection.
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
@ -570,6 +581,10 @@ public class VCard extends IQ {
/**
* Load VCard information for a given user. XMPPConnection should be authenticated and not anonymous.
*
* @param connection connection.
* @param user user whos information we want to load.
*
* @throws XMPPErrorException
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException