diff --git a/web-sdk/.gitignore b/web-sdk/.gitignore index 2affbfa..56dcc1d 100644 --- a/web-sdk/.gitignore +++ b/web-sdk/.gitignore @@ -1,15 +1,48 @@ -.idea/ -out/ -output/ - +# Java *.class -# Mobile Tools for Java (J2ME) .mtj.tmp/ -# Package Files # *.war *.ear -# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml hs_err_pid* + +# Maven +target/ +pom.xml.tag +pom.xml.releaseBackup +pom.xml.versionsBackup +pom.xml.next +release.properties +dependency-reduced-pom.xml +buildNumber.properties +.mvn/timing.properties +.mvn/wrapper/maven-wrapper.jar +.mvn/wrapper/maven-wrapper.properties + +# Eclipse +.classpath +.project +.settings/ + +# IntelliJ IDEA +.idea/ +*.iml +*.iws +out/ +output/ + +# MacOS +.DS_Store + +# Logs +log/ +*.log + +# Temporary files +*~ +*.swp + +# Asc files (e.g., GPG signatures) +*.asc \ No newline at end of file diff --git a/web-sdk/pom.xml b/web-sdk/pom.xml index 56454eb..d6337d0 100644 --- a/web-sdk/pom.xml +++ b/web-sdk/pom.xml @@ -11,6 +11,38 @@ irext-remote-index Indexing API for IRext remote controller + + + MIT + https://opensource.irext.net/irext/index-api/-/blob/master/LICENSE + repo + + + + + Strawmanbobi + strawmanbobi@irext.net + IRext + https://site.irext.net + + + + scm:git:git://opensource.irext.net/irext/index-api + scm:git:ssh://opensource.irext.net/irext/index-api + https://opensource.irext.net/irext/index-api + + + + + ossrh + https://s01.oss.sonatype.org/content/repositories/snapshots + + + ossrh + https://s01.oss.sonatype.org/service/local/staging/deploy/maven2/ + + + 1.8 1.8 @@ -45,23 +77,47 @@ ${maven.compiler.target} - org.apache.maven.plugins - maven-shade-plugin - 3.5.1 - - package - - shade - - - ${project.build.directory}/${project.artifactId}-shaded.jar - - - + maven-source-plugin + 3.3.1 + + + attach-sources + + jar-no-fork + + + + + + org.apache.maven.plugins + maven-javadoc-plugin + 3.6.3 + + + attach-javadocs + + jar + + + + + + org.apache.maven.plugins + maven-gpg-plugin + 3.2.1 + + + sign-artifacts + verify + + sign + + + - + \ No newline at end of file diff --git a/web-sdk/src/main/java/net/irext/webapi/WebAPICallbacks.java b/web-sdk/src/main/java/net/irext/webapi/WebAPICallbacks.java index 0a1a52c..8ee2bc2 100644 --- a/web-sdk/src/main/java/net/irext/webapi/WebAPICallbacks.java +++ b/web-sdk/src/main/java/net/irext/webapi/WebAPICallbacks.java @@ -22,69 +22,251 @@ import java.util.List; */ public class WebAPICallbacks { + /** + * Default constructor for WebAPICallbacks. + */ + public WebAPICallbacks() { + } + + /** + * Callback interface for sign in operations. + */ public interface SignInCallback { + /** + * Called when sign in is successful. + * + * @param userApp the user application information + */ void onSignInSuccess(UserApp userApp); + + /** + * Called when sign in fails. + */ void onSignInFailed(); + + /** + * Called when an error occurs during sign in. + */ void onSignInError(); } + /** + * Callback interface for listing categories. + */ public interface ListCategoriesCallback { + /** + * Called when listing categories is successful. + * + * @param categories the list of categories + */ void onListCategoriesSuccess(List categories); + + /** + * Called when listing categories fails. + */ void onListCategoriesFailed(); + + /** + * Called when an error occurs during listing categories. + */ void onListCategoriesError(); } + /** + * Callback interface for listing brands. + */ public interface ListBrandsCallback { + /** + * Called when listing brands is successful. + * + * @param brands the list of brands + */ void onListBrandsSuccess(List brands); + + /** + * Called when listing brands fails. + */ void onListBrandsFailed(); + + /** + * Called when an error occurs during listing brands. + */ void onListBrandsError(); } + /** + * Callback interface for listing popular brands. + */ public interface ListPopularBrandsCallback { + /** + * Called when listing popular brands is successful. + * + * @param brands the list of popular brands + */ void onListPopularBrandsSuccess(List brands); + + /** + * Called when listing popular brands fails. + */ void onListPopularBrandsFailed(); + + /** + * Called when an error occurs during listing popular brands. + */ void onListPopularBrandsError(); } + /** + * Callback interface for listing popular cities. + */ public interface ListPopularCitiesCallback { + /** + * Called when listing popular cities is successful. + * + * @param cities the list of popular cities + */ void onListPopularCitiesSuccess(List cities); + + /** + * Called when listing popular cities fails. + */ void onListPopularCitiesFailed(); + + /** + * Called when an error occurs during listing popular cities. + */ void onListPopularCitiesError(); } + /** + * Callback interface for listing provinces. + */ public interface ListProvincesCallback { + /** + * Called when listing provinces is successful. + * + * @param provinces the list of provinces + */ void onListProvincesSuccess(List provinces); + + /** + * Called when listing provinces fails. + */ void onListProvincesFailed(); + + /** + * Called when an error occurs during listing provinces. + */ void onListProvincesError(); } + /** + * Callback interface for listing cities. + */ public interface ListCitiesCallback { + /** + * Called when listing cities is successful. + * + * @param cities the list of cities + */ void onListCitiesSuccess(List cities); + + /** + * Called when listing cities fails. + */ void onListCitiesFailed(); + + /** + * Called when an error occurs during listing cities. + */ void onListCitiesError(); } + /** + * Callback interface for listing areas. + */ public interface ListAreasCallback { + /** + * Called when listing areas is successful. + * + * @param cities the list of cities + */ void onListAreasSuccess(List cities); + + /** + * Called when listing areas fails. + */ void onListAreasFailed(); + + /** + * Called when an error occurs during listing areas. + */ void onListAreasError(); } + /** + * Callback interface for listing operators. + */ public interface ListOperatersCallback { + /** + * Called when listing operators is successful. + * + * @param operators the list of operators + */ void onListOperatorsSuccess(List operators); + + /** + * Called when listing operators fails. + */ void onListOperatorsFailed(); + + /** + * Called when an error occurs during listing operators. + */ void onListOperatorsError(); } + /** + * Callback interface for listing indexes. + */ public interface ListIndexesCallback { + /** + * Called when listing indexes is successful. + * + * @param indexes the list of remote indexes + */ void onListIndexesSuccess(List indexes); + + /** + * Called when listing indexes fails. + */ void onListIndexesFailed(); + + /** + * Called when an error occurs during listing indexes. + */ void onListIndexesError(); } + /** + * Callback interface for downloading binary files. + */ public interface DownloadBinCallback { + /** + * Called when downloading binary is successful. + * + * @param inputStream the input stream of the downloaded binary + */ void onDownloadBinSuccess(InputStream inputStream); + + /** + * Called when downloading binary fails. + */ void onDownloadBinFailed(); + + /** + * Called when an error occurs during downloading binary. + */ void onDownloadBinError(); } -} +} \ No newline at end of file diff --git a/web-sdk/src/main/java/net/irext/webapi/WebAPIs.java b/web-sdk/src/main/java/net/irext/webapi/WebAPIs.java index 0917837..8e55afe 100644 --- a/web-sdk/src/main/java/net/irext/webapi/WebAPIs.java +++ b/web-sdk/src/main/java/net/irext/webapi/WebAPIs.java @@ -54,6 +54,12 @@ public class WebAPIs { private final OkHttpClient mHttpClient; + /** + * Constructs a WebAPIs instance with the specified address and application name. + * + * @param address the server address + * @param appName the application name + */ private WebAPIs(String address, String appName) { if (null != address && null != appName) { URL_PREFIX = address + appName; @@ -61,10 +67,23 @@ public class WebAPIs { mHttpClient = new OkHttpClient(); } + /** + * Initializes the WebAPIs instance with the specified address and application name. + * + * @param address the server address + * @param appName the application name + */ private static void initializeInstance(String address, String appName) { mInstance = new WebAPIs(address, appName); } + /** + * Gets the WebAPIs instance, creating it if necessary. + * + * @param address the server address + * @param appName the application name + * @return the WebAPIs instance + */ @SuppressWarnings("unused") public static WebAPIs getInstance(String address, String appName) { if (null == mInstance) { @@ -73,6 +92,13 @@ public class WebAPIs { return mInstance; } + /** + * Gets a file byte stream from the specified URL. + * + * @param url the URL to get the file from + * @return the file byte stream + * @throws IOException if an I/O error occurs + */ private InputStream getFileByteStreamByURL(String url) throws IOException { Request request = new Request.Builder() .url(url) @@ -83,6 +109,14 @@ public class WebAPIs { return response.body().byteStream(); } + /** + * Posts data to the server at the specified URL. + * + * @param url the URL to post to + * @param json the JSON data to post + * @return the server response + * @throws IOException if an I/O error occurs + */ private String postToServer(String url, String json) throws IOException { MediaType JSON = MediaType.parse("application/json; charset=utf-8"); @@ -96,6 +130,14 @@ public class WebAPIs { return response.body().string(); } + /** + * Posts data to the server for octet stream response. + * + * @param url the URL to post to + * @param json the JSON data to post + * @return the input stream response + * @throws IOException if an I/O error occurs + */ private InputStream postToServerForOctets(String url, String json) throws IOException { MediaType JSON = MediaType.parse("application/json; charset=utf-8"); @@ -110,6 +152,13 @@ public class WebAPIs { return response.body().byteStream(); } + /** + * Signs in with the specified app key and secret. + * + * @param appKey the application key + * @param appSecret the application secret + * @param signInCallback the sign in callback + */ @SuppressWarnings("unused") public void signIn(String appKey, String appSecret, SignInCallback signInCallback) { String signInURL = URL_PREFIX + SERVICE_SIGN_IN; @@ -138,6 +187,13 @@ public class WebAPIs { } } + /** + * Lists categories with the specified parameters. + * + * @param from the starting index + * @param count the number of categories to list + * @param listCategoriesCallback the list categories callback + */ @SuppressWarnings("unused") public void listCategories(int from, int count, ListCategoriesCallback listCategoriesCallback) { String listCategoriesURL = URL_PREFIX + SERVICE_LIST_CATEGORIES; @@ -163,6 +219,14 @@ public class WebAPIs { } } + /** + * Lists brands with the specified parameters. + * + * @param categoryId the category ID + * @param from the starting index + * @param count the number of brands to list + * @param listBrandsCallback the list brands callback + */ @SuppressWarnings("unused") public void listBrands(int categoryId, int from, int count, ListBrandsCallback listBrandsCallback) { @@ -190,6 +254,11 @@ public class WebAPIs { } } + /** + * Lists provinces. + * + * @param listProvincesCallback the list provinces callback + */ @SuppressWarnings("unused") public void listProvinces(ListProvincesCallback listProvincesCallback) { String listProvincesURL = URL_PREFIX + SERVICE_LIST_PROVINCES; @@ -213,6 +282,12 @@ public class WebAPIs { } } + /** + * Lists cities with the specified prefix. + * + * @param prefix the province prefix + * @param listCitiesCallback the list cities callback + */ @SuppressWarnings("unused") public void listCities(String prefix, ListCitiesCallback listCitiesCallback) { String listCitiesURL = URL_PREFIX + SERVICE_LIST_CITIES; @@ -237,6 +312,12 @@ public class WebAPIs { } } + /** + * Lists operators for the specified city code. + * + * @param cityCode the city code + * @param listOperatersCallback the list operators callback + */ @SuppressWarnings("unused") public void listOperators(String cityCode, ListOperatersCallback listOperatersCallback) { @@ -264,6 +345,16 @@ public class WebAPIs { } } + /** + * Lists remote indexes with the specified parameters. + * + * @param categoryId the category ID + * @param brandId the brand ID + * @param cityCode the city code + * @param operatorId the operator ID + * @param withParaData the parameter data flag + * @param onListIndexCallback the list indexes callback + */ @SuppressWarnings("unused") public void listRemoteIndexes(int categoryId, int brandId, @@ -300,6 +391,13 @@ public class WebAPIs { } } + /** + * Downloads a binary file with the specified parameters. + * + * @param remoteMap the remote map + * @param indexId the index ID + * @param downloadBinCallback the download binary callback + */ @SuppressWarnings("unused") public void downloadBin(String remoteMap, int indexId, DownloadBinCallback downloadBinCallback) { @@ -327,6 +425,17 @@ public class WebAPIs { } } + /** + * Decodes IR data with the specified parameters. + * + * @param indexId the index ID + * @param acStatus the AC status + * @param keyCode the key code + * @param changeWindDir the change wind direction flag + * @param directDecode the direct decode flag + * @param paraData the parameter data + * @return the decoded IR data + */ @SuppressWarnings("unused") public int[] decodeIR(int indexId, ACStatus acStatus, int keyCode, int changeWindDir, Integer directDecode, Integer paraData) { @@ -359,6 +468,13 @@ public class WebAPIs { return null; } + /** + * Gets AC parameters with the specified parameters. + * + * @param indexId the index ID + * @param mode the mode + * @return the AC parameters + */ @SuppressWarnings("unused") public ACParameters getACParameters(int indexId, int mode) { String decodeURL = URL_PREFIX + SERVICE_GET_AC_PARAMETERS; @@ -384,4 +500,4 @@ public class WebAPIs { } return null; } -} +} \ No newline at end of file diff --git a/web-sdk/src/main/java/net/irext/webapi/bean/ACStatus.java b/web-sdk/src/main/java/net/irext/webapi/bean/ACStatus.java index ca4c51d..a370020 100644 --- a/web-sdk/src/main/java/net/irext/webapi/bean/ACStatus.java +++ b/web-sdk/src/main/java/net/irext/webapi/bean/ACStatus.java @@ -23,9 +23,24 @@ public class ACStatus { private int acSleep; private int acTimer; + /** + * Default constructor for ACStatus. + */ public ACStatus() { } + /** + * Constructs an ACStatus with the specified parameters. + * + * @param acPower the power status + * @param acMode the mode setting + * @param acTemp the temperature setting + * @param acWindSpeed the wind speed setting + * @param acWindDir the wind direction setting + * @param acDisplay the display setting + * @param acSleep the sleep mode setting + * @param acTimer the timer setting + */ public ACStatus(int acPower, int acMode, int acTemp, int acWindSpeed, int acWindDir, int acDisplay, int acSleep, int acTimer) { this.acPower = acPower; @@ -38,67 +53,147 @@ public class ACStatus { this.acTimer = acTimer; } + /** + * Gets the air conditioner power status. + * + * @return the power status + */ public int getAcPower() { return acPower; } + /** + * Sets the air conditioner power status. + * + * @param acPower the power status to set + */ public void setAcPower(int acPower) { this.acPower = acPower; } + /** + * Gets the air conditioner temperature setting. + * + * @return the temperature setting + */ public int getAcTemp() { return acTemp; } + /** + * Sets the air conditioner temperature setting. + * + * @param acTemp the temperature setting to set + */ public void setAcTemp(int acTemp) { this.acTemp = acTemp; } + /** + * Gets the air conditioner mode setting. + * + * @return the mode setting + */ public int getAcMode() { return acMode; } + /** + * Sets the air conditioner mode setting. + * + * @param acMode the mode setting to set + */ public void setAcMode(int acMode) { this.acMode = acMode; } + /** + * Gets the air conditioner wind direction setting. + * + * @return the wind direction setting + */ public int getAcWindDir() { return acWindDir; } + /** + * Sets the air conditioner wind direction setting. + * + * @param acWindDir the wind direction setting to set + */ public void setAcWindDir(int acWindDir) { this.acWindDir = acWindDir; } + /** + * Gets the air conditioner wind speed setting. + * + * @return the wind speed setting + */ public int getAcWindSpeed() { return acWindSpeed; } + /** + * Sets the air conditioner wind speed setting. + * + * @param acWindSpeed the wind speed setting to set + */ public void setAcWindSpeed(int acWindSpeed) { this.acWindSpeed = acWindSpeed; } + /** + * Gets the air conditioner display setting. + * + * @return the display setting + */ public int getAcDisplay() { return acDisplay; } + /** + * Sets the air conditioner display setting. + * + * @param acDisplay the display setting to set + */ public void setAcDisplay(int acDisplay) { this.acDisplay = acDisplay; } + /** + * Gets the air conditioner sleep mode setting. + * + * @return the sleep mode setting + */ public int getAcSleep() { return acSleep; } + /** + * Sets the air conditioner sleep mode setting. + * + * @param acSleep the sleep mode setting to set + */ public void setAcSleep(int acSleep) { this.acSleep = acSleep; } + /** + * Gets the air conditioner timer setting. + * + * @return the timer setting + */ public int getAcTimer() { return acTimer; } + /** + * Sets the air conditioner timer setting. + * + * @param acTimer the timer setting to set + */ public void setAcTimer(int acTimer) { this.acTimer = acTimer; } -} +} \ No newline at end of file diff --git a/web-sdk/src/main/java/net/irext/webapi/bean/TemperatureRange.java b/web-sdk/src/main/java/net/irext/webapi/bean/TemperatureRange.java index 5e5106d..0e6ae90 100644 --- a/web-sdk/src/main/java/net/irext/webapi/bean/TemperatureRange.java +++ b/web-sdk/src/main/java/net/irext/webapi/bean/TemperatureRange.java @@ -17,27 +17,56 @@ public class TemperatureRange { private int tempMin; private int tempMax; + /** + * Default constructor for TemperatureRange. + */ public TemperatureRange() { } + /** + * Constructs a TemperatureRange with the specified minimum and maximum temperatures. + * + * @param tempMin the minimum temperature + * @param tempMax the maximum temperature + */ public TemperatureRange(int tempMin, int tempMax) { this.tempMin = tempMin; this.tempMax = tempMax; } + /** + * Gets the minimum temperature. + * + * @return the minimum temperature + */ public int getTempMin() { return tempMin; } + /** + * Sets the minimum temperature. + * + * @param tempMin the minimum temperature to set + */ public void setTempMin(int tempMin) { this.tempMin = tempMin; } + /** + * Gets the maximum temperature. + * + * @return the maximum temperature + */ public int getTempMax() { return tempMax; } + /** + * Sets the maximum temperature. + * + * @param tempMax the maximum temperature to set + */ public void setTempMax(int tempMax) { this.tempMax = tempMax; } -} +} \ No newline at end of file diff --git a/web-sdk/src/main/java/net/irext/webapi/model/ACParameters.java b/web-sdk/src/main/java/net/irext/webapi/model/ACParameters.java index 98ddd52..d672658 100644 --- a/web-sdk/src/main/java/net/irext/webapi/model/ACParameters.java +++ b/web-sdk/src/main/java/net/irext/webapi/model/ACParameters.java @@ -18,6 +18,16 @@ public class ACParameters { private int []supportedSwing; private int []supportedWindDirections; + /** + * Constructs an ACParameters object with specified parameters. + * + * @param tempMin the minimum temperature + * @param tempMax the maximum temperature + * @param supportedModes array of supported modes + * @param supportedWindSpeed array of supported wind speeds + * @param supportedSwing array of supported swing modes + * @param supportedWindDirections array of supported wind directions + */ public ACParameters(int tempMin, int tempMax, int[] supportedModes, int[] supportedWindSpeed, int[] supportedSwing, int[] supportedWindDirections) { @@ -29,55 +39,118 @@ public class ACParameters { this.supportedWindDirections = supportedWindDirections; } + /** + * Default constructor for ACParameters. + */ public ACParameters() { } + /** + * Gets the minimum temperature. + * + * @return the minimum temperature + */ public int getTempMin() { return tempMin; } + /** + * Sets the minimum temperature. + * + * @param tempMin the minimum temperature to set + */ public void setTempMin(int tempMin) { this.tempMin = tempMin; } + /** + * Gets the maximum temperature. + * + * @return the maximum temperature + */ public int getTempMax() { return tempMax; } + /** + * Sets the maximum temperature. + * + * @param tempMax the maximum temperature to set + */ public void setTempMax(int tempMax) { this.tempMax = tempMax; } + /** + * Gets the supported modes. + * + * @return array of supported modes + */ public int[] getSupportedModes() { return supportedModes; } + /** + * Sets the supported modes. + * + * @param supportedModes array of supported modes to set + */ public void setSupportedModes(int[] supportedModes) { this.supportedModes = supportedModes; } + /** + * Gets the supported wind speed settings. + * + * @return array of supported wind speeds + */ public int[] getSupportedWindSpeed() { return supportedWindSpeed; } + /** + * Sets the supported wind speed settings. + * + * @param supportedWindSpeed array of supported wind speeds to set + */ public void setSupportedWindSpeed(int[] supportedWindSpeed) { this.supportedWindSpeed = supportedWindSpeed; } + /** + * Gets the supported swing modes. + * + * @return array of supported swing modes + */ public int[] getSupportedSwing() { return supportedSwing; } + /** + * Sets the supported swing modes. + * + * @param supportedSwing array of supported swing modes to set + */ public void setSupportedSwing(int[] supportedSwing) { this.supportedSwing = supportedSwing; } + /** + * Gets the supported wind directions. + * + * @return array of supported wind directions + */ public int[] getSupportedWindDirections() { return supportedWindDirections; } + /** + * Sets the supported wind directions. + * + * @param supportedWindDirections array of supported wind directions to set + */ public void setSupportedWindDirections(int[] supportedWindDirections) { this.supportedWindDirections = supportedWindDirections; } -} +} \ No newline at end of file diff --git a/web-sdk/src/main/java/net/irext/webapi/model/Brand.java b/web-sdk/src/main/java/net/irext/webapi/model/Brand.java index d7fa2be..03c726c 100644 --- a/web-sdk/src/main/java/net/irext/webapi/model/Brand.java +++ b/web-sdk/src/main/java/net/irext/webapi/model/Brand.java @@ -23,6 +23,20 @@ public class Brand { private String nameTw; private String contributor; + /** + * Constructs a Brand with the specified parameters. + * + * @param id the brand ID + * @param name the brand name + * @param categoryId the category ID + * @param categoryName the category name + * @param status the status + * @param updateTime the update time + * @param priority the priority + * @param nameEn the English name + * @param nameTw the Traditional Chinese name + * @param contributor the contributor + */ public Brand(int id, String name, int categoryId, String categoryName, int status, String updateTime, int priority, String nameEn, String nameTw, String contributor) { @@ -38,87 +52,190 @@ public class Brand { this.contributor = contributor; } + /** + * Default constructor for Brand. + */ public Brand() { } + /** + * Gets the brand ID. + * + * @return the brand ID + */ public int getId() { return id; } + /** + * Sets the brand ID. + * + * @param id the brand ID to set + */ public void setId(int id) { this.id = id; } + /** + * Gets the brand name. + * + * @return the brand name + */ public String getName() { return name; } + /** + * Sets the brand name. + * + * @param name the brand name to set + */ public void setName(String name) { this.name = name; } + /** + * Gets the category ID. + * + * @return the category ID + */ public int getCategoryId() { return categoryId; } + /** + * Sets the category ID. + * + * @param categoryId the category ID to set + */ public void setCategoryId(int categoryId) { this.categoryId = categoryId; } + /** + * Gets the category name. + * + * @return the category name + */ public String getCategoryName() { return categoryName; } + /** + * Sets the category name. + * + * @param categoryName the category name to set + */ public void setCategoryName(String categoryName) { this.categoryName = categoryName; } + /** + * Gets the status. + * + * @return the status + */ public int getStatus() { return status; } + /** + * Sets the status. + * + * @param status the status to set + */ public void setStatus(int status) { this.status = status; } + /** + * Gets the update time. + * + * @return the update time + */ public String getUpdateTime() { return updateTime; } + /** + * Sets the update time. + * + * @param updateTime the update time to set + */ public void setUpdateTime(String updateTime) { this.updateTime = updateTime; } + /** + * Gets the priority. + * + * @return the priority + */ public int getPriority() { return priority; } + /** + * Sets the priority. + * + * @param priority the priority to set + */ public void setPriority(int priority) { this.priority = priority; } + /** + * Gets the English name. + * + * @return the English name + */ public String getNameEn() { return nameEn; } + /** + * Sets the English name. + * + * @param nameEn the English name to set + */ public void setNameEn(String nameEn) { this.nameEn = nameEn; } + /** + * Gets the Traditional Chinese name. + * + * @return the Traditional Chinese name + */ public String getNameTw() { return nameTw; } + /** + * Sets the Traditional Chinese name. + * + * @param nameTw the Traditional Chinese name to set + */ public void setNameTw(String nameTw) { this.nameTw = nameTw; } + /** + * Gets the contributor. + * + * @return the contributor + */ public String getContributor() { return contributor; } + /** + * Sets the contributor. + * + * @param contributor the contributor to set + */ public void setContributor(String contributor) { this.contributor = contributor; } -} +} \ No newline at end of file diff --git a/web-sdk/src/main/java/net/irext/webapi/model/Category.java b/web-sdk/src/main/java/net/irext/webapi/model/Category.java index 9e36e8a..3e3e7f6 100644 --- a/web-sdk/src/main/java/net/irext/webapi/model/Category.java +++ b/web-sdk/src/main/java/net/irext/webapi/model/Category.java @@ -20,6 +20,17 @@ public class Category { private String nameTw; private String contributor; + /** + * Constructs a Category with the specified parameters. + * + * @param id the category ID + * @param name the category name + * @param status the status + * @param updateTime the update time + * @param nameEn the English name + * @param nameTw the Traditional Chinese name + * @param contributor the contributor + */ public Category(int id, String name, int status, String updateTime, String nameEn, String nameTw, String contributor) { this.id = id; @@ -31,63 +42,136 @@ public class Category { this.contributor = contributor; } + /** + * Default constructor for Category. + */ public Category() { } + /** + * Gets the category ID. + * + * @return the category ID + */ public int getId() { return id; } + /** + * Sets the category ID. + * + * @param id the category ID to set + */ public void setId(int id) { this.id = id; } + /** + * Gets the category name. + * + * @return the category name + */ public String getName() { return name; } + /** + * Sets the category name. + * + * @param name the category name to set + */ public void setName(String name) { this.name = name; } + /** + * Gets the status. + * + * @return the status + */ public int getStatus() { return status; } + /** + * Sets the status. + * + * @param status the status to set + */ public void setStatus(int status) { this.status = status; } + /** + * Gets the update time. + * + * @return the update time + */ public String getUpdateTime() { return updateTime; } + /** + * Sets the update time. + * + * @param updateTime the update time to set + */ public void setUpdateTime(String updateTime) { this.updateTime = updateTime; } + /** + * Gets the English name. + * + * @return the English name + */ public String getNameEn() { return nameEn; } + /** + * Sets the English name. + * + * @param nameEn the English name to set + */ public void setNameEn(String nameEn) { this.nameEn = nameEn; } + /** + * Gets the Traditional Chinese name. + * + * @return the Traditional Chinese name + */ public String getNameTw() { return nameTw; } + /** + * Sets the Traditional Chinese name. + * + * @param nameTw the Traditional Chinese name to set + */ public void setNameTw(String nameTw) { this.nameTw = nameTw; } + /** + * Gets the contributor. + * + * @return the contributor + */ public String getContributor() { return contributor; } + /** + * Sets the contributor. + * + * @param contributor the contributor to set + */ public void setContributor(String contributor) { this.contributor = contributor; } -} +} \ No newline at end of file diff --git a/web-sdk/src/main/java/net/irext/webapi/model/City.java b/web-sdk/src/main/java/net/irext/webapi/model/City.java index 6105c34..9d5c5e0 100644 --- a/web-sdk/src/main/java/net/irext/webapi/model/City.java +++ b/web-sdk/src/main/java/net/irext/webapi/model/City.java @@ -20,6 +20,17 @@ public class City { private int status; private String nameTw; + /** + * Constructs a City with the specified parameters. + * + * @param id the city ID + * @param code the city code + * @param name the city name + * @param longitude the longitude + * @param latitude the latitude + * @param status the status + * @param nameTw the Traditional Chinese name + */ public City(int id, String code, String name, double longitude, double latitude, int status, String nameTw) { this.id = id; @@ -31,63 +42,136 @@ public class City { this.nameTw = nameTw; } + /** + * Default constructor for City. + */ public City() { } + /** + * Gets the city ID. + * + * @return the city ID + */ public int getId() { return id; } + /** + * Sets the city ID. + * + * @param id the city ID to set + */ public void setId(int id) { this.id = id; } + /** + * Gets the city code. + * + * @return the city code + */ public String getCode() { return code; } + /** + * Sets the city code. + * + * @param code the city code to set + */ public void setCode(String code) { this.code = code; } + /** + * Gets the city name. + * + * @return the city name + */ public String getName() { return name; } + /** + * Sets the city name. + * + * @param name the city name to set + */ public void setName(String name) { this.name = name; } + /** + * Gets the longitude. + * + * @return the longitude + */ public double getLongitude() { return longitude; } + /** + * Sets the longitude. + * + * @param longitude the longitude to set + */ public void setLongitude(double longitude) { this.longitude = longitude; } + /** + * Gets the latitude. + * + * @return the latitude + */ public double getLatitude() { return latitude; } + /** + * Sets the latitude. + * + * @param latitude the latitude to set + */ public void setLatitude(double latitude) { this.latitude = latitude; } + /** + * Gets the status. + * + * @return the status + */ public int getStatus() { return status; } + /** + * Sets the status. + * + * @param status the status to set + */ public void setStatus(int status) { this.status = status; } + /** + * Gets the Traditional Chinese name. + * + * @return the Traditional Chinese name + */ public String getNameTw() { return nameTw; } + /** + * Sets the Traditional Chinese name. + * + * @param nameTw the Traditional Chinese name to set + */ public void setNameTw(String nameTw) { this.nameTw = nameTw; } -} +} \ No newline at end of file diff --git a/web-sdk/src/main/java/net/irext/webapi/model/RemoteIndex.java b/web-sdk/src/main/java/net/irext/webapi/model/RemoteIndex.java index 57e7314..551d9fe 100644 --- a/web-sdk/src/main/java/net/irext/webapi/model/RemoteIndex.java +++ b/web-sdk/src/main/java/net/irext/webapi/model/RemoteIndex.java @@ -36,6 +36,33 @@ public class RemoteIndex { private String contributor; private String updateTime; + /** + * Constructs a RemoteIndex with the specified parameters. + * + * @param id the ID + * @param categoryId the category ID + * @param categoryName the category name + * @param brandId the brand ID + * @param brandName the brand name + * @param cityCode the city code + * @param cityName the city name + * @param operatorId the operator ID + * @param operatorName the operator name + * @param protocol the protocol + * @param remote the remote + * @param remoteMap the remote map + * @param status the status + * @param subCate the sub category + * @param priority the priority + * @param remoteNumber the remote number + * @param categoryNameTw the category name in Traditional Chinese + * @param brandNameTw the brand name in Traditional Chinese + * @param cityNameTw the city name in Traditional Chinese + * @param operatorNameTw the operator name in Traditional Chinese + * @param binaryMd5 the binary MD5 + * @param contributor the contributor + * @param updateTime the update time + */ public RemoteIndex(int id, int categoryId, String categoryName, int brandId, String brandName, String cityCode, String cityName, String operatorId, String operatorName, @@ -69,191 +96,424 @@ public class RemoteIndex { this.updateTime = updateTime; } + /** + * Default constructor for RemoteIndex. + */ public RemoteIndex() { } + /** + * Gets the ID. + * + * @return the ID + */ public int getId() { return id; } + /** + * Sets the ID. + * + * @param id the ID to set + */ public void setId(int id) { this.id = id; } + /** + * Gets the category ID. + * + * @return the category ID + */ public int getCategoryId() { return categoryId; } + /** + * Sets the category ID. + * + * @param categoryId the category ID to set + */ public void setCategoryId(int categoryId) { this.categoryId = categoryId; } + /** + * Gets the category name. + * + * @return the category name + */ public String getCategoryName() { return categoryName; } + /** + * Sets the category name. + * + * @param categoryName the category name to set + */ public void setCategoryName(String categoryName) { this.categoryName = categoryName; } + /** + * Gets the brand ID. + * + * @return the brand ID + */ public int getBrandId() { return brandId; } + /** + * Sets the brand ID. + * + * @param brandId the brand ID to set + */ public void setBrandId(int brandId) { this.brandId = brandId; } + /** + * Gets the brand name. + * + * @return the brand name + */ public String getBrandName() { return brandName; } + /** + * Sets the brand name. + * + * @param brandName the brand name to set + */ public void setBrandName(String brandName) { this.brandName = brandName; } + /** + * Gets the city code. + * + * @return the city code + */ public String getCityCode() { return cityCode; } + /** + * Sets the city code. + * + * @param cityCode the city code to set + */ public void setCityCode(String cityCode) { this.cityCode = cityCode; } + /** + * Gets the city name. + * + * @return the city name + */ public String getCityName() { return cityName; } + /** + * Sets the city name. + * + * @param cityName the city name to set + */ public void setCityName(String cityName) { this.cityName = cityName; } + /** + * Gets the operator ID. + * + * @return the operator ID + */ public String getOperatorId() { return operatorId; } + /** + * Sets the operator ID. + * + * @param operatorId the operator ID to set + */ public void setOperatorId(String operatorId) { this.operatorId = operatorId; } + /** + * Gets the operator name. + * + * @return the operator name + */ public String getOperatorName() { return operatorName; } + /** + * Sets the operator name. + * + * @param operatorName the operator name to set + */ public void setOperatorName(String operatorName) { this.operatorName = operatorName; } + /** + * Gets the protocol. + * + * @return the protocol + */ public String getProtocol() { return protocol; } + /** + * Sets the protocol. + * + * @param protocol the protocol to set + */ public void setProtocol(String protocol) { this.protocol = protocol; } + /** + * Gets the remote. + * + * @return the remote + */ public String getRemote() { return remote; } + /** + * Sets the remote. + * + * @param remote the remote to set + */ public void setRemote(String remote) { this.remote = remote; } + /** + * Gets the remote map. + * + * @return the remote map + */ public String getRemoteMap() { return remoteMap; } + /** + * Sets the remote map. + * + * @param remoteMap the remote map to set + */ public void setRemoteMap(String remoteMap) { this.remoteMap = remoteMap; } + /** + * Gets the status. + * + * @return the status + */ public int getStatus() { return status; } + /** + * Sets the status. + * + * @param status the status to set + */ public void setStatus(int status) { this.status = status; } + /** + * Gets the sub category. + * + * @return the sub category + */ public int getSubCate() { return subCate; } + /** + * Sets the sub category. + * + * @param subCate the sub category to set + */ public void setSubCate(int subCate) { this.subCate = subCate; } + /** + * Gets the priority. + * + * @return the priority + */ public int getPriority() { return priority; } + /** + * Sets the priority. + * + * @param priority the priority to set + */ public void setPriority(int priority) { this.priority = priority; } + /** + * Gets the remote number. + * + * @return the remote number + */ public String getRemoteNumber() { return remoteNumber; } + /** + * Sets the remote number. + * + * @param remoteNumber the remote number to set + */ public void setRemoteNumber(String remoteNumber) { this.remoteNumber = remoteNumber; } + /** + * Gets the category name in Traditional Chinese. + * + * @return the category name in Traditional Chinese + */ public String getCategoryNameTw() { return categoryNameTw; } + /** + * Sets the category name in Traditional Chinese. + * + * @param categoryNameTw the category name in Traditional Chinese to set + */ public void setCategoryNameTw(String categoryNameTw) { this.categoryNameTw = categoryNameTw; } + /** + * Gets the brand name in Traditional Chinese. + * + * @return the brand name in Traditional Chinese + */ public String getBrandNameTw() { return brandNameTw; } + /** + * Sets the brand name in Traditional Chinese. + * + * @param brandNameTw the brand name in Traditional Chinese to set + */ public void setBrandNameTw(String brandNameTw) { this.brandNameTw = brandNameTw; } + /** + * Gets the city name in Traditional Chinese. + * + * @return the city name in Traditional Chinese + */ public String getCityNameTw() { return cityNameTw; } + /** + * Sets the city name in Traditional Chinese. + * + * @param cityNameTw the city name in Traditional Chinese to set + */ public void setCityNameTw(String cityNameTw) { this.cityNameTw = cityNameTw; } + /** + * Gets the operator name in Traditional Chinese. + * + * @return the operator name in Traditional Chinese + */ public String getOperatorNameTw() { return operatorNameTw; } + /** + * Sets the operator name in Traditional Chinese. + * + * @param operatorNameTw the operator name in Traditional Chinese to set + */ public void setOperatorNameTw(String operatorNameTw) { this.operatorNameTw = operatorNameTw; } + /** + * Gets the binary MD5. + * + * @return the binary MD5 + */ public String getBinaryMd5() { return binaryMd5; } + /** + * Sets the binary MD5. + * + * @param binaryMd5 the binary MD5 to set + */ public void setBinaryMd5(String binaryMd5) { this.binaryMd5 = binaryMd5; } + /** + * Gets the contributor. + * + * @return the contributor + */ public String getContributor() { return contributor; } + /** + * Sets the contributor. + * + * @param contributor the contributor to set + */ public void setContributor(String contributor) { this.contributor = contributor; } + /** + * Gets the update time. + * + * @return the update time + */ public String getUpdateTime() { return updateTime; } + /** + * Sets the update time. + * + * @param updateTime the update time to set + */ public void setUpdateTime(String updateTime) { this.updateTime = updateTime; } -} +} \ No newline at end of file diff --git a/web-sdk/src/main/java/net/irext/webapi/model/StbOperator.java b/web-sdk/src/main/java/net/irext/webapi/model/StbOperator.java index 167d938..cc638b0 100644 --- a/web-sdk/src/main/java/net/irext/webapi/model/StbOperator.java +++ b/web-sdk/src/main/java/net/irext/webapi/model/StbOperator.java @@ -20,6 +20,17 @@ public class StbOperator { private int status; private String operatorNameTw; + /** + * Constructs a StbOperator with the specified parameters. + * + * @param id the ID + * @param operatorId the operator ID + * @param operatorName the operator name + * @param cityCode the city code + * @param cityName the city name + * @param status the status + * @param operatorNameTw the operator name in Traditional Chinese + */ public StbOperator(int id, String operatorId, String operatorName, String cityCode, String cityName, int status, String operatorNameTw) { this.id = id; @@ -31,63 +42,136 @@ public class StbOperator { this.operatorNameTw = operatorNameTw; } + /** + * Default constructor for StbOperator. + */ public StbOperator() { } + /** + * Gets the ID. + * + * @return the ID + */ public int getId() { return id; } + /** + * Sets the ID. + * + * @param id the ID to set + */ public void setId(int id) { this.id = id; } + /** + * Gets the operator ID. + * + * @return the operator ID + */ public String getOperatorId() { return operatorId; } + /** + * Sets the operator ID. + * + * @param operatorId the operator ID to set + */ public void setOperatorId(String operatorId) { this.operatorId = operatorId; } + /** + * Gets the operator name. + * + * @return the operator name + */ public String getOperatorName() { return operatorName; } + /** + * Sets the operator name. + * + * @param operatorName the operator name to set + */ public void setOperatorName(String operatorName) { this.operatorName = operatorName; } + /** + * Gets the city code. + * + * @return the city code + */ public String getCityCode() { return cityCode; } + /** + * Sets the city code. + * + * @param cityCode the city code to set + */ public void setCityCode(String cityCode) { this.cityCode = cityCode; } + /** + * Gets the city name. + * + * @return the city name + */ public String getCityName() { return cityName; } + /** + * Sets the city name. + * + * @param cityName the city name to set + */ public void setCityName(String cityName) { this.cityName = cityName; } + /** + * Gets the status. + * + * @return the status + */ public int getStatus() { return status; } + /** + * Sets the status. + * + * @param status the status to set + */ public void setStatus(int status) { this.status = status; } + /** + * Gets the operator name in Traditional Chinese. + * + * @return the operator name in Traditional Chinese + */ public String getOperatorNameTw() { return operatorNameTw; } + /** + * Sets the operator name in Traditional Chinese. + * + * @param operatorNameTw the operator name in Traditional Chinese to set + */ public void setOperatorNameTw(String operatorNameTw) { this.operatorNameTw = operatorNameTw; } -} +} \ No newline at end of file diff --git a/web-sdk/src/main/java/net/irext/webapi/model/UserApp.java b/web-sdk/src/main/java/net/irext/webapi/model/UserApp.java index e16c502..5f40c10 100644 --- a/web-sdk/src/main/java/net/irext/webapi/model/UserApp.java +++ b/web-sdk/src/main/java/net/irext/webapi/model/UserApp.java @@ -1,109 +1,92 @@ package net.irext.webapi.model; +/** + * User application information. + */ public class UserApp { /** * This field was generated by MyBatis Generator. * This field corresponds to the database column user_app.id - * - * @mbggenerated Fri May 26 19:47:48 CST 2017 */ private Integer id; /** * This field was generated by MyBatis Generator. * This field corresponds to the database column user_app.app_name - * - * @mbggenerated Fri May 26 19:47:48 CST 2017 */ private String appName; /** * This field was generated by MyBatis Generator. * This field corresponds to the database column user_app.admin_id - * - * @mbggenerated Fri May 26 19:47:48 CST 2017 */ private Integer adminId; /** * This field was generated by MyBatis Generator. * This field corresponds to the database column user_app.admin_name - * - * @mbggenerated Fri May 26 19:47:48 CST 2017 */ private String adminName; /** * This field was generated by MyBatis Generator. * This field corresponds to the database column user_app.app_type - * - * @mbggenerated Fri May 26 19:47:48 CST 2017 */ private Byte appType; /** * This field was generated by MyBatis Generator. * This field corresponds to the database column user_app.android_package_name - * - * @mbggenerated Fri May 26 19:47:48 CST 2017 */ private String androidPackageName; /** * This field was generated by MyBatis Generator. * This field corresponds to the database column user_app.android_signature - * - * @mbggenerated Fri May 26 19:47:48 CST 2017 */ private String androidSignature; /** * This field was generated by MyBatis Generator. * This field corresponds to the database column user_app.ios_identity - * - * @mbggenerated Fri May 26 19:47:48 CST 2017 */ private String iosIdentity; /** * This field was generated by MyBatis Generator. * This field corresponds to the database column user_app.is_debug - * - * @mbggenerated Fri May 26 19:47:48 CST 2017 */ private Byte isDebug; /** * This field was generated by MyBatis Generator. * This field corresponds to the database column user_app.app_key - * - * @mbggenerated Fri May 26 19:47:48 CST 2017 */ private String appKey; /** * This field was generated by MyBatis Generator. * This field corresponds to the database column user_app.app_secret - * - * @mbggenerated Fri May 26 19:47:48 CST 2017 */ private String appSecret; /** * This field was generated by MyBatis Generator. * This field corresponds to the database column user_app.update_time - * - * @mbggenerated Fri May 26 19:47:48 CST 2017 */ private String updateTime; + /** + * Default constructor for UserApp. + */ + public UserApp() { + } + /** * This method was generated by MyBatis Generator. * This method returns the value of the database column user_app.id * * @return the value of user_app.id - * - * @mbggenerated Fri May 26 19:47:48 CST 2017 */ public Integer getId() { return id; @@ -114,8 +97,6 @@ public class UserApp { * This method sets the value of the database column user_app.id * * @param id the value for user_app.id - * - * @mbggenerated Fri May 26 19:47:48 CST 2017 */ public void setId(Integer id) { this.id = id; @@ -126,8 +107,6 @@ public class UserApp { * This method returns the value of the database column user_app.app_name * * @return the value of user_app.app_name - * - * @mbggenerated Fri May 26 19:47:48 CST 2017 */ public String getAppName() { return appName; @@ -138,8 +117,6 @@ public class UserApp { * This method sets the value of the database column user_app.app_name * * @param appName the value for user_app.app_name - * - * @mbggenerated Fri May 26 19:47:48 CST 2017 */ public void setAppName(String appName) { this.appName = appName; @@ -150,8 +127,6 @@ public class UserApp { * This method returns the value of the database column user_app.admin_id * * @return the value of user_app.admin_id - * - * @mbggenerated Fri May 26 19:47:48 CST 2017 */ public Integer getAdminId() { return adminId; @@ -162,8 +137,6 @@ public class UserApp { * This method sets the value of the database column user_app.admin_id * * @param adminId the value for user_app.admin_id - * - * @mbggenerated Fri May 26 19:47:48 CST 2017 */ public void setAdminId(Integer adminId) { this.adminId = adminId; @@ -174,8 +147,6 @@ public class UserApp { * This method returns the value of the database column user_app.admin_name * * @return the value of user_app.admin_name - * - * @mbggenerated Fri May 26 19:47:48 CST 2017 */ public String getAdminName() { return adminName; @@ -186,8 +157,6 @@ public class UserApp { * This method sets the value of the database column user_app.admin_name * * @param adminName the value for user_app.admin_name - * - * @mbggenerated Fri May 26 19:47:48 CST 2017 */ public void setAdminName(String adminName) { this.adminName = adminName; @@ -198,8 +167,6 @@ public class UserApp { * This method returns the value of the database column user_app.app_type * * @return the value of user_app.app_type - * - * @mbggenerated Fri May 26 19:47:48 CST 2017 */ public Byte getAppType() { return appType; @@ -210,8 +177,6 @@ public class UserApp { * This method sets the value of the database column user_app.app_type * * @param appType the value for user_app.app_type - * - * @mbggenerated Fri May 26 19:47:48 CST 2017 */ public void setAppType(Byte appType) { this.appType = appType; @@ -222,8 +187,6 @@ public class UserApp { * This method returns the value of the database column user_app.android_package_name * * @return the value of user_app.android_package_name - * - * @mbggenerated Fri May 26 19:47:48 CST 2017 */ public String getAndroidPackageName() { return androidPackageName; @@ -234,8 +197,6 @@ public class UserApp { * This method sets the value of the database column user_app.android_package_name * * @param androidPackageName the value for user_app.android_package_name - * - * @mbggenerated Fri May 26 19:47:48 CST 2017 */ public void setAndroidPackageName(String androidPackageName) { this.androidPackageName = androidPackageName; @@ -246,8 +207,6 @@ public class UserApp { * This method returns the value of the database column user_app.android_signature * * @return the value of user_app.android_signature - * - * @mbggenerated Fri May 26 19:47:48 CST 2017 */ public String getAndroidSignature() { return androidSignature; @@ -258,8 +217,6 @@ public class UserApp { * This method sets the value of the database column user_app.android_signature * * @param androidSignature the value for user_app.android_signature - * - * @mbggenerated Fri May 26 19:47:48 CST 2017 */ public void setAndroidSignature(String androidSignature) { this.androidSignature = androidSignature; @@ -270,8 +227,6 @@ public class UserApp { * This method returns the value of the database column user_app.ios_identity * * @return the value of user_app.ios_identity - * - * @mbggenerated Fri May 26 19:47:48 CST 2017 */ public String getIosIdentity() { return iosIdentity; @@ -282,8 +237,6 @@ public class UserApp { * This method sets the value of the database column user_app.ios_identity * * @param iosIdentity the value for user_app.ios_identity - * - * @mbggenerated Fri May 26 19:47:48 CST 2017 */ public void setIosIdentity(String iosIdentity) { this.iosIdentity = iosIdentity; @@ -294,8 +247,6 @@ public class UserApp { * This method returns the value of the database column user_app.is_debug * * @return the value of user_app.is_debug - * - * @mbggenerated Fri May 26 19:47:48 CST 2017 */ public Byte getIsDebug() { return isDebug; @@ -306,8 +257,6 @@ public class UserApp { * This method sets the value of the database column user_app.is_debug * * @param isDebug the value for user_app.is_debug - * - * @mbggenerated Fri May 26 19:47:48 CST 2017 */ public void setIsDebug(Byte isDebug) { this.isDebug = isDebug; @@ -318,8 +267,6 @@ public class UserApp { * This method returns the value of the database column user_app.app_key * * @return the value of user_app.app_key - * - * @mbggenerated Fri May 26 19:47:48 CST 2017 */ public String getAppKey() { return appKey; @@ -330,8 +277,6 @@ public class UserApp { * This method sets the value of the database column user_app.app_key * * @param appKey the value for user_app.app_key - * - * @mbggenerated Fri May 26 19:47:48 CST 2017 */ public void setAppKey(String appKey) { this.appKey = appKey; @@ -342,8 +287,6 @@ public class UserApp { * This method returns the value of the database column user_app.app_secret * * @return the value of user_app.app_secret - * - * @mbggenerated Fri May 26 19:47:48 CST 2017 */ public String getAppSecret() { return appSecret; @@ -354,8 +297,6 @@ public class UserApp { * This method sets the value of the database column user_app.app_secret * * @param appSecret the value for user_app.app_secret - * - * @mbggenerated Fri May 26 19:47:48 CST 2017 */ public void setAppSecret(String appSecret) { this.appSecret = appSecret; @@ -366,8 +307,6 @@ public class UserApp { * This method returns the value of the database column user_app.update_time * * @return the value of user_app.update_time - * - * @mbggenerated Fri May 26 19:47:48 CST 2017 */ public String getUpdateTime() { return updateTime; @@ -378,8 +317,6 @@ public class UserApp { * This method sets the value of the database column user_app.update_time * * @param updateTime the value for user_app.update_time - * - * @mbggenerated Fri May 26 19:47:48 CST 2017 */ public void setUpdateTime(String updateTime) { this.updateTime = updateTime; @@ -387,10 +324,20 @@ public class UserApp { private String token; + /** + * Gets the authentication token. + * + * @return the authentication token + */ public String getToken() { return token; } + /** + * Sets the authentication token. + * + * @param token the authentication token to set + */ public void setToken(String token) { this.token = token; } diff --git a/web-sdk/src/main/java/net/irext/webapi/request/AppSignInRequest.java b/web-sdk/src/main/java/net/irext/webapi/request/AppSignInRequest.java index 7cb3bc8..64901c4 100644 --- a/web-sdk/src/main/java/net/irext/webapi/request/AppSignInRequest.java +++ b/web-sdk/src/main/java/net/irext/webapi/request/AppSignInRequest.java @@ -19,6 +19,16 @@ public class AppSignInRequest extends BaseRequest { private String androidPackageName; private String androidSignature; + /** + * Constructs an AppSignInRequest with the specified parameters. + * + * @param appKey the application key + * @param appSecret the application secret + * @param appType the application type + * @param iOSID the iOS identifier + * @param androidPackageName the Android package name + * @param androidSignature the Android signature + */ public AppSignInRequest(String appKey, String appSecret, int appType, String iOSID, String androidPackageName, String androidSignature) { this.appKey = appKey; @@ -29,55 +39,118 @@ public class AppSignInRequest extends BaseRequest { this.androidSignature = androidSignature; } + /** + * Default constructor for AppSignInRequest. + */ public AppSignInRequest() { } + /** + * Gets the application key. + * + * @return the application key + */ public String getAppKey() { return appKey; } + /** + * Sets the application key. + * + * @param appKey the application key to set + */ public void setAppKey(String appKey) { this.appKey = appKey; } + /** + * Gets the application secret. + * + * @return the application secret + */ public String getAppSecret() { return appSecret; } + /** + * Sets the application secret. + * + * @param appSecret the application secret to set + */ public void setAppSecret(String appSecret) { this.appSecret = appSecret; } + /** + * Gets the application type. + * + * @return the application type + */ public int getAppType() { return appType; } + /** + * Sets the application type. + * + * @param appType the application type to set + */ public void setAppType(int appType) { this.appType = appType; } + /** + * Gets the iOS identifier. + * + * @return the iOS identifier + */ public String getiOSID() { return iOSID; } + /** + * Sets the iOS identifier. + * + * @param iOSID the iOS identifier to set + */ public void setiOSID(String iOSID) { this.iOSID = iOSID; } + /** + * Gets the Android package name. + * + * @return the Android package name + */ public String getAndroidPackageName() { return androidPackageName; } + /** + * Sets the Android package name. + * + * @param androidPackageName the Android package name to set + */ public void setAndroidPackageName(String androidPackageName) { this.androidPackageName = androidPackageName; } + /** + * Gets the Android signature. + * + * @return the Android signature + */ public String getAndroidSignature() { return androidSignature; } + /** + * Sets the Android signature. + * + * @param androidSignature the Android signature to set + */ public void setAndroidSignature(String androidSignature) { this.androidSignature = androidSignature; } -} +} \ No newline at end of file diff --git a/web-sdk/src/main/java/net/irext/webapi/request/BaseRequest.java b/web-sdk/src/main/java/net/irext/webapi/request/BaseRequest.java index ef4ba78..ff66125 100644 --- a/web-sdk/src/main/java/net/irext/webapi/request/BaseRequest.java +++ b/web-sdk/src/main/java/net/irext/webapi/request/BaseRequest.java @@ -17,32 +17,66 @@ public class BaseRequest { private int id; private String token; + /** + * Constructs a BaseRequest with the specified id and token. + * + * @param id the identifier + * @param token the authentication token + */ public BaseRequest(int id, String token) { this.id = id; this.token = token; } + /** + * Default constructor for BaseRequest. + */ BaseRequest() { } + /** + * Gets the identifier. + * + * @return the identifier + */ public int getId() { return id; } + /** + * Sets the identifier. + * + * @param id the identifier to set + */ public void setId(int id) { this.id = id; } + /** + * Gets the authentication token. + * + * @return the authentication token + */ public String getToken() { return token; } + /** + * Sets the authentication token. + * + * @param token the authentication token to set + */ public void setToken(String token) { this.token = token; } + /** + * Converts this object to JSON format. + * + * @return the JSON representation of this object + */ public String toJson() { return new Gson().toJson(this, this.getClass()); } -} +} \ No newline at end of file diff --git a/web-sdk/src/main/java/net/irext/webapi/request/DecodeRequest.java b/web-sdk/src/main/java/net/irext/webapi/request/DecodeRequest.java index 9cfcfe3..897f0b1 100644 --- a/web-sdk/src/main/java/net/irext/webapi/request/DecodeRequest.java +++ b/web-sdk/src/main/java/net/irext/webapi/request/DecodeRequest.java @@ -21,6 +21,16 @@ public class DecodeRequest extends BaseRequest { private Integer directDecode; private Integer paraData; + /** + * Constructs a DecodeRequest with the specified parameters. + * + * @param indexId the index ID + * @param acStatus the AC status + * @param keyCode the key code + * @param changeWindDir the change wind direction flag + * @param directDecode the direct decode flag + * @param paraData the parameter data + */ public DecodeRequest(int indexId, ACStatus acStatus, int keyCode, int changeWindDir, Integer directDecode, Integer paraData) { this.indexId = indexId; @@ -31,55 +41,118 @@ public class DecodeRequest extends BaseRequest { this.paraData = paraData; } + /** + * Default constructor for DecodeRequest. + */ public DecodeRequest() { } + /** + * Gets the index ID. + * + * @return the index ID + */ public int getIndexId() { return indexId; } + /** + * Sets the index ID. + * + * @param indexId the index ID to set + */ public void setIndexId(int indexId) { this.indexId = indexId; } + /** + * Gets the AC status. + * + * @return the AC status + */ public ACStatus getAcStatus() { return acStatus; } + /** + * Sets the AC status. + * + * @param acStatus the AC status to set + */ public void setAcStatus(ACStatus acStatus) { this.acStatus = acStatus; } + /** + * Gets the key code. + * + * @return the key code + */ public int getKeyCode() { return keyCode; } + /** + * Sets the key code. + * + * @param keyCode the key code to set + */ public void setKeyCode(int keyCode) { this.keyCode = keyCode; } + /** + * Gets the change wind direction flag. + * + * @return the change wind direction flag + */ public int getChangeWindDir() { return changeWindDir; } + /** + * Sets the change wind direction flag. + * + * @param changeWindDir the change wind direction flag to set + */ public void setChangeWindDir(int changeWindDir) { this.changeWindDir = changeWindDir; } + /** + * Gets the direct decode flag. + * + * @return the direct decode flag + */ public Integer getDirectDecode() { return directDecode; } + /** + * Sets the direct decode flag. + * + * @param directDecode the direct decode flag to set + */ public void setDirectDecode(Integer directDecode) { this.directDecode = directDecode; } + /** + * Gets the parameter data. + * + * @return the parameter data + */ public Integer getParaData() { return paraData; } + /** + * Sets the parameter data. + * + * @param paraData the parameter data to set + */ public void setParaData(Integer paraData) { this.paraData = paraData; } -} +} \ No newline at end of file diff --git a/web-sdk/src/main/java/net/irext/webapi/request/DownloadBinaryRequest.java b/web-sdk/src/main/java/net/irext/webapi/request/DownloadBinaryRequest.java index 6a6d1fe..f7da4b4 100644 --- a/web-sdk/src/main/java/net/irext/webapi/request/DownloadBinaryRequest.java +++ b/web-sdk/src/main/java/net/irext/webapi/request/DownloadBinaryRequest.java @@ -12,19 +12,38 @@ package net.irext.webapi.request; */ public class DownloadBinaryRequest extends BaseRequest { private int indexId; + + /** + * Constructs a DownloadBinaryRequest with the specified index ID. + * + * @param indexId the index ID + */ public DownloadBinaryRequest(int indexId) { this.indexId = indexId; } + /** + * Default constructor for DownloadBinaryRequest. + */ public DownloadBinaryRequest() { } + /** + * Gets the index ID. + * + * @return the index ID + */ public int getIndexId() { return indexId; } + /** + * Sets the index ID. + * + * @param indexId the index ID to set + */ public void setIndexId(int indexId) { this.indexId = indexId; } -} +} \ No newline at end of file diff --git a/web-sdk/src/main/java/net/irext/webapi/request/GetACParametersRequest.java b/web-sdk/src/main/java/net/irext/webapi/request/GetACParametersRequest.java index e5f5174..c922339 100644 --- a/web-sdk/src/main/java/net/irext/webapi/request/GetACParametersRequest.java +++ b/web-sdk/src/main/java/net/irext/webapi/request/GetACParametersRequest.java @@ -14,28 +14,57 @@ public class GetACParametersRequest extends BaseRequest { private int indexId; private int mode; + /** + * Constructs a GetACParametersRequest with the specified index ID and mode. + * + * @param indexId the index ID + * @param mode the mode + */ public GetACParametersRequest(int indexId, int mode) { this.indexId = indexId; this.mode = mode; } + /** + * Default constructor for GetACParametersRequest. + */ public GetACParametersRequest() { } + /** + * Gets the index ID. + * + * @return the index ID + */ public int getIndexId() { return indexId; } + /** + * Sets the index ID. + * + * @param indexId the index ID to set + */ public void setIndexId(int indexId) { this.indexId = indexId; } + /** + * Gets the mode. + * + * @return the mode + */ public int getMode() { return mode; } + /** + * Sets the mode. + * + * @param mode the mode to set + */ public void setMode(int mode) { this.mode = mode; } -} +} \ No newline at end of file diff --git a/web-sdk/src/main/java/net/irext/webapi/request/ListBrandsRequest.java b/web-sdk/src/main/java/net/irext/webapi/request/ListBrandsRequest.java index 6dcd236..981dcbe 100644 --- a/web-sdk/src/main/java/net/irext/webapi/request/ListBrandsRequest.java +++ b/web-sdk/src/main/java/net/irext/webapi/request/ListBrandsRequest.java @@ -16,37 +16,77 @@ public class ListBrandsRequest extends BaseRequest { private int from; private int count; + /** + * Constructs a ListBrandsRequest with the specified category ID, from, and count. + * + * @param categoryId the category ID + * @param from the starting index + * @param count the number of items + */ public ListBrandsRequest(int categoryId, int from, int count) { this.categoryId = categoryId; this.from = from; this.count = count; } + /** + * Default constructor for ListBrandsRequest. + */ public ListBrandsRequest() { } + /** + * Gets the category ID. + * + * @return the category ID + */ public int getCategoryId() { return categoryId; } + /** + * Sets the category ID. + * + * @param categoryId the category ID to set + */ public void setCategoryId(int categoryId) { this.categoryId = categoryId; } + /** + * Gets the starting index. + * + * @return the starting index + */ public int getFrom() { return from; } + /** + * Sets the starting index. + * + * @param from the starting index to set + */ public void setFrom(int from) { this.from = from; } + /** + * Gets the number of items. + * + * @return the number of items + */ public int getCount() { return count; } + /** + * Sets the number of items. + * + * @param count the number of items to set + */ public void setCount(int count) { this.count = count; } -} +} \ No newline at end of file diff --git a/web-sdk/src/main/java/net/irext/webapi/request/ListCategoriesRequest.java b/web-sdk/src/main/java/net/irext/webapi/request/ListCategoriesRequest.java index 48760f3..c7d8ffd 100644 --- a/web-sdk/src/main/java/net/irext/webapi/request/ListCategoriesRequest.java +++ b/web-sdk/src/main/java/net/irext/webapi/request/ListCategoriesRequest.java @@ -15,28 +15,57 @@ public class ListCategoriesRequest extends BaseRequest { private int from; private int count; + /** + * Constructs a ListCategoriesRequest with the specified from and count. + * + * @param from the starting index + * @param count the number of items + */ public ListCategoriesRequest(int from, int count) { this.from = from; this.count = count; } + /** + * Default constructor for ListCategoriesRequest. + */ public ListCategoriesRequest() { } + /** + * Gets the starting index. + * + * @return the starting index + */ public int getFrom() { return from; } + /** + * Sets the starting index. + * + * @param from the starting index to set + */ public void setFrom(int from) { this.from = from; } + /** + * Gets the number of items. + * + * @return the number of items + */ public int getCount() { return count; } + /** + * Sets the number of items. + * + * @param count the number of items to set + */ public void setCount(int count) { this.count = count; } -} +} \ No newline at end of file diff --git a/web-sdk/src/main/java/net/irext/webapi/request/ListCitiesRequest.java b/web-sdk/src/main/java/net/irext/webapi/request/ListCitiesRequest.java index 6bd0cd9..c0d3683 100644 --- a/web-sdk/src/main/java/net/irext/webapi/request/ListCitiesRequest.java +++ b/web-sdk/src/main/java/net/irext/webapi/request/ListCitiesRequest.java @@ -14,19 +14,37 @@ public class ListCitiesRequest extends BaseRequest { private String provincePrefix; + /** + * Constructs a ListCitiesRequest with the specified province prefix. + * + * @param provincePrefix the province prefix + */ public ListCitiesRequest(String provincePrefix) { this.provincePrefix = provincePrefix; } + /** + * Default constructor for ListCitiesRequest. + */ public ListCitiesRequest() { } + /** + * Gets the province prefix. + * + * @return the province prefix + */ public String getProvincePrefix() { return provincePrefix; } + /** + * Sets the province prefix. + * + * @param provincePrefix the province prefix to set + */ public void setProvincePrefix(String provincePrefix) { this.provincePrefix = provincePrefix; } -} +} \ No newline at end of file diff --git a/web-sdk/src/main/java/net/irext/webapi/request/ListIndexesRequest.java b/web-sdk/src/main/java/net/irext/webapi/request/ListIndexesRequest.java index 99a823e..ecb06f2 100644 --- a/web-sdk/src/main/java/net/irext/webapi/request/ListIndexesRequest.java +++ b/web-sdk/src/main/java/net/irext/webapi/request/ListIndexesRequest.java @@ -22,6 +22,17 @@ public class ListIndexesRequest extends BaseRequest { // try index in IRIS with this flag set to 1 private int withParaData; + /** + * Constructs a ListIndexesRequest with the specified parameters. + * + * @param from the starting index + * @param count the number of items + * @param categoryId the category ID + * @param brandId the brand ID + * @param cityCode the city code + * @param operatorId the operator ID + * @param withParaData the parameter data flag + */ public ListIndexesRequest(int from, int count, int categoryId, int brandId, String cityCode, String operatorId, int withParaData) { this.from = from; @@ -33,63 +44,136 @@ public class ListIndexesRequest extends BaseRequest { this.withParaData = withParaData; } + /** + * Default constructor for ListIndexesRequest. + */ public ListIndexesRequest() { } + /** + * Gets the starting index. + * + * @return the starting index + */ public int getFrom() { return from; } + /** + * Sets the starting index. + * + * @param from the starting index to set + */ public void setFrom(int from) { this.from = from; } + /** + * Gets the number of items. + * + * @return the number of items + */ public int getCount() { return count; } + /** + * Sets the number of items. + * + * @param count the number of items to set + */ public void setCount(int count) { this.count = count; } + /** + * Gets the category ID. + * + * @return the category ID + */ public int getCategoryId() { return categoryId; } + /** + * Sets the category ID. + * + * @param categoryId the category ID to set + */ public void setCategoryId(int categoryId) { this.categoryId = categoryId; } + /** + * Gets the brand ID. + * + * @return the brand ID + */ public int getBrandId() { return brandId; } + /** + * Sets the brand ID. + * + * @param brandId the brand ID to set + */ public void setBrandId(int brandId) { this.brandId = brandId; } + /** + * Gets the city code. + * + * @return the city code + */ public String getCityCode() { return cityCode; } + /** + * Sets the city code. + * + * @param cityCode the city code to set + */ public void setCityCode(String cityCode) { this.cityCode = cityCode; } + /** + * Gets the operator ID. + * + * @return the operator ID + */ public String getOperatorId() { return operatorId; } + /** + * Sets the operator ID. + * + * @param operatorId the operator ID to set + */ public void setOperatorId(String operatorId) { this.operatorId = operatorId; } + /** + * Gets the parameter data flag. + * + * @return the parameter data flag + */ public int getWithParaData() { return withParaData; } + /** + * Sets the parameter data flag. + * + * @param withParaData the parameter data flag to set + */ public void setWithParaData(int withParaData) { this.withParaData = withParaData; } -} +} \ No newline at end of file diff --git a/web-sdk/src/main/java/net/irext/webapi/request/ListOperatorsRequest.java b/web-sdk/src/main/java/net/irext/webapi/request/ListOperatorsRequest.java index 264be93..e33370e 100644 --- a/web-sdk/src/main/java/net/irext/webapi/request/ListOperatorsRequest.java +++ b/web-sdk/src/main/java/net/irext/webapi/request/ListOperatorsRequest.java @@ -16,37 +16,77 @@ public class ListOperatorsRequest extends BaseRequest { private int count; private String cityCode; + /** + * Constructs a ListOperatorsRequest with the specified from, count, and city code. + * + * @param from the starting index + * @param count the number of items + * @param cityCode the city code + */ public ListOperatorsRequest(int from, int count, String cityCode) { this.from = from; this.count = count; this.cityCode = cityCode; } + /** + * Default constructor for ListOperatorsRequest. + */ public ListOperatorsRequest() { } + /** + * Gets the starting index. + * + * @return the starting index + */ public int getFrom() { return from; } + /** + * Sets the starting index. + * + * @param from the starting index to set + */ public void setFrom(int from) { this.from = from; } + /** + * Gets the number of items. + * + * @return the number of items + */ public int getCount() { return count; } + /** + * Sets the number of items. + * + * @param count the number of items to set + */ public void setCount(int count) { this.count = count; } + /** + * Gets the city code. + * + * @return the city code + */ public String getCityCode() { return cityCode; } + /** + * Sets the city code. + * + * @param cityCode the city code to set + */ public void setCityCode(String cityCode) { this.cityCode = cityCode; } -} +} \ No newline at end of file diff --git a/web-sdk/src/main/java/net/irext/webapi/response/ACParametersResponse.java b/web-sdk/src/main/java/net/irext/webapi/response/ACParametersResponse.java index 17f428c..eee7073 100644 --- a/web-sdk/src/main/java/net/irext/webapi/response/ACParametersResponse.java +++ b/web-sdk/src/main/java/net/irext/webapi/response/ACParametersResponse.java @@ -16,20 +16,39 @@ public class ACParametersResponse extends ServiceResponse { private ACParameters entity; + /** + * Constructs an ACParametersResponse with the specified status and entity. + * + * @param status the status of the response + * @param entity the AC parameters entity + */ public ACParametersResponse(Status status, ACParameters entity) { super(status); this.entity = entity; } + /** + * Default constructor for ACParametersResponse. + */ public ACParametersResponse() { super(new Status()); this.entity = null; } + /** + * Gets the AC parameters entity. + * + * @return the AC parameters entity + */ public ACParameters getEntity() { return entity; } + /** + * Sets the AC parameters entity. + * + * @param entity the AC parameters entity to set + */ public void setEntity(ACParameters entity) { this.entity = entity; } diff --git a/web-sdk/src/main/java/net/irext/webapi/response/BrandsResponse.java b/web-sdk/src/main/java/net/irext/webapi/response/BrandsResponse.java index 327227f..6629ba8 100644 --- a/web-sdk/src/main/java/net/irext/webapi/response/BrandsResponse.java +++ b/web-sdk/src/main/java/net/irext/webapi/response/BrandsResponse.java @@ -18,20 +18,39 @@ public class BrandsResponse extends ServiceResponse { private List entity; + /** + * Constructs a BrandsResponse with the specified status and brands list. + * + * @param status the response status + * @param brands the list of brands + */ public BrandsResponse(Status status, List brands) { super(status); this.entity = brands; } + /** + * Default constructor for BrandsResponse. + */ public BrandsResponse() { } + /** + * Gets the list of brands. + * + * @return the list of brands + */ public List getEntity() { return entity; } + /** + * Sets the list of brands. + * + * @param entity the list of brands to set + */ public void setEntity(List entity) { this.entity = entity; } -} +} \ No newline at end of file diff --git a/web-sdk/src/main/java/net/irext/webapi/response/CategoriesResponse.java b/web-sdk/src/main/java/net/irext/webapi/response/CategoriesResponse.java index 409f582..d2c47aa 100644 --- a/web-sdk/src/main/java/net/irext/webapi/response/CategoriesResponse.java +++ b/web-sdk/src/main/java/net/irext/webapi/response/CategoriesResponse.java @@ -18,20 +18,39 @@ public class CategoriesResponse extends ServiceResponse { private List entity; + /** + * Constructs a CategoriesResponse with the specified status and categories list. + * + * @param status the response status + * @param categories the list of categories + */ public CategoriesResponse(Status status, List categories) { super(status); this.entity = categories; } + /** + * Default constructor for CategoriesResponse. + */ public CategoriesResponse() { } + /** + * Gets the list of categories. + * + * @return the list of categories + */ public List getEntity() { return entity; } + /** + * Sets the list of categories. + * + * @param entity the list of categories to set + */ public void setEntity(List entity) { this.entity = entity; } -} +} \ No newline at end of file diff --git a/web-sdk/src/main/java/net/irext/webapi/response/CitiesResponse.java b/web-sdk/src/main/java/net/irext/webapi/response/CitiesResponse.java index a97a868..9bcb87a 100644 --- a/web-sdk/src/main/java/net/irext/webapi/response/CitiesResponse.java +++ b/web-sdk/src/main/java/net/irext/webapi/response/CitiesResponse.java @@ -18,20 +18,39 @@ public class CitiesResponse extends ServiceResponse { private List entity; + /** + * Constructs a CitiesResponse with the specified status and cities list. + * + * @param status the response status + * @param cities the list of cities + */ public CitiesResponse(Status status, List cities) { super(status); this.entity = cities; } + /** + * Default constructor for CitiesResponse. + */ public CitiesResponse() { } + /** + * Gets the list of cities. + * + * @return the list of cities + */ public List getEntity() { return entity; } + /** + * Sets the list of cities. + * + * @param entity the list of cities to set + */ public void setEntity(List entity) { this.entity = entity; } -} +} \ No newline at end of file diff --git a/web-sdk/src/main/java/net/irext/webapi/response/DecodeResponse.java b/web-sdk/src/main/java/net/irext/webapi/response/DecodeResponse.java index c221f4e..4429ca0 100644 --- a/web-sdk/src/main/java/net/irext/webapi/response/DecodeResponse.java +++ b/web-sdk/src/main/java/net/irext/webapi/response/DecodeResponse.java @@ -14,20 +14,39 @@ public class DecodeResponse extends ServiceResponse { private int[] entity; + /** + * Constructs a DecodeResponse with the specified status and entity. + * + * @param status the response status + * @param entity the entity data + */ public DecodeResponse(Status status, int[] entity) { super(status); this.entity = entity; } + /** + * Default constructor for DecodeResponse. + */ public DecodeResponse() { } + /** + * Gets the entity data. + * + * @return the entity data + */ public int[] getEntity() { return entity; } + /** + * Sets the entity data. + * + * @param entity the entity data to set + */ public void setEntity(int[] entity) { this.entity = entity; } -} +} \ No newline at end of file diff --git a/web-sdk/src/main/java/net/irext/webapi/response/IndexesResponse.java b/web-sdk/src/main/java/net/irext/webapi/response/IndexesResponse.java index 7b666a5..0491586 100644 --- a/web-sdk/src/main/java/net/irext/webapi/response/IndexesResponse.java +++ b/web-sdk/src/main/java/net/irext/webapi/response/IndexesResponse.java @@ -18,20 +18,39 @@ public class IndexesResponse extends ServiceResponse { private List entity; + /** + * Constructs an IndexesResponse with the specified status and indexes. + * + * @param status the response status + * @param indexes the list of remote indexes + */ public IndexesResponse(Status status, List indexes) { super(status); this.entity = indexes; } + /** + * Default constructor for IndexesResponse. + */ public IndexesResponse() { } + /** + * Gets the list of remote indexes. + * + * @return the list of remote indexes + */ public List getEntity() { return entity; } + /** + * Sets the list of remote indexes. + * + * @param entity the list of remote indexes to set + */ public void setEntity(List entity) { this.entity = entity; } -} +} \ No newline at end of file diff --git a/web-sdk/src/main/java/net/irext/webapi/response/LoginResponse.java b/web-sdk/src/main/java/net/irext/webapi/response/LoginResponse.java index d5e51d7..5ac6132 100644 --- a/web-sdk/src/main/java/net/irext/webapi/response/LoginResponse.java +++ b/web-sdk/src/main/java/net/irext/webapi/response/LoginResponse.java @@ -15,20 +15,39 @@ public class LoginResponse extends ServiceResponse { private UserApp entity; + /** + * Constructs a LoginResponse with the specified status and user app. + * + * @param status the response status + * @param userApp the user app + */ public LoginResponse(Status status, UserApp userApp) { super(status); this.entity = userApp; } + /** + * Default constructor for LoginResponse. + */ public LoginResponse() { } + /** + * Gets the user app entity. + * + * @return the user app entity + */ public UserApp getEntity() { return entity; } + /** + * Sets the user app entity. + * + * @param entity the user app entity to set + */ public void setEntity(UserApp entity) { this.entity = entity; } -} +} \ No newline at end of file diff --git a/web-sdk/src/main/java/net/irext/webapi/response/OperatorsResponse.java b/web-sdk/src/main/java/net/irext/webapi/response/OperatorsResponse.java index 4856989..5133ef3 100644 --- a/web-sdk/src/main/java/net/irext/webapi/response/OperatorsResponse.java +++ b/web-sdk/src/main/java/net/irext/webapi/response/OperatorsResponse.java @@ -18,20 +18,39 @@ public class OperatorsResponse extends ServiceResponse { private List entity; + /** + * Constructs an OperatorsResponse with the specified status and cities. + * + * @param status the response status + * @param cities the list of STB operators + */ public OperatorsResponse(Status status, List cities) { super(status); this.entity = cities; } + /** + * Default constructor for OperatorsResponse. + */ public OperatorsResponse() { } + /** + * Gets the list of STB operators. + * + * @return the list of STB operators + */ public List getEntity() { return entity; } + /** + * Sets the list of STB operators. + * + * @param entity the list of STB operators to set + */ public void setEntity(List entity) { this.entity = entity; } -} +} \ No newline at end of file diff --git a/web-sdk/src/main/java/net/irext/webapi/response/ServiceResponse.java b/web-sdk/src/main/java/net/irext/webapi/response/ServiceResponse.java index 8f8852f..749108a 100644 --- a/web-sdk/src/main/java/net/irext/webapi/response/ServiceResponse.java +++ b/web-sdk/src/main/java/net/irext/webapi/response/ServiceResponse.java @@ -14,19 +14,37 @@ public class ServiceResponse { private Status status; + /** + * Constructs a ServiceResponse with the specified status. + * + * @param status the response status + */ public ServiceResponse(Status status) { this.status = status; } + /** + * Default constructor for ServiceResponse. + */ public ServiceResponse() { } + /** + * Gets the response status. + * + * @return the response status + */ public Status getStatus() { return status; } + /** + * Sets the response status. + * + * @param status the response status to set + */ public void setStatus(Status status) { this.status = status; } -} +} \ No newline at end of file diff --git a/web-sdk/src/main/java/net/irext/webapi/response/Status.java b/web-sdk/src/main/java/net/irext/webapi/response/Status.java index 7c354d4..ab8b6de 100644 --- a/web-sdk/src/main/java/net/irext/webapi/response/Status.java +++ b/web-sdk/src/main/java/net/irext/webapi/response/Status.java @@ -15,28 +15,57 @@ public class Status { private int code; private String cause; + /** + * Constructs a Status with the specified code and cause. + * + * @param code the status code + * @param cause the cause message + */ public Status(int code, String cause) { this.code = code; this.cause = cause; } + /** + * Default constructor for Status. + */ public Status() { } + /** + * Gets the status code. + * + * @return the status code + */ public int getCode() { return code; } + /** + * Sets the status code. + * + * @param code the status code to set + */ public void setCode(int code) { this.code = code; } + /** + * Gets the cause message. + * + * @return the cause message + */ public String getCause() { return cause; } + /** + * Sets the cause message. + * + * @param cause the cause message to set + */ public void setCause(String cause) { this.cause = cause; } -} +} \ No newline at end of file diff --git a/web-sdk/src/main/java/net/irext/webapi/utils/Constants.java b/web-sdk/src/main/java/net/irext/webapi/utils/Constants.java index 3b0f335..121901a 100644 --- a/web-sdk/src/main/java/net/irext/webapi/utils/Constants.java +++ b/web-sdk/src/main/java/net/irext/webapi/utils/Constants.java @@ -12,165 +12,350 @@ package net.irext.webapi.utils; */ public class Constants { + /** + * Default constructor for Constants. + */ + public Constants() { + // Private constructor to prevent instantiation + } + + /** + * Error code indicating successful operation. + */ public static final int ERROR_CODE_SUCCESS = 0; + + /** + * Error code indicating network error. + */ public static final int ERROR_CODE_NETWORK_ERROR = -1; + + /** + * Error code indicating authentication failure. + */ public static final int ERROR_CODE_AUTH_FAILURE = 1; + + /** + * Error code indicating invalid category. + */ public static final int ERROR_CODE_INVALID_CATEGORY = 2; + + /** + * Error code indicating invalid brand. + */ public static final int ERROR_CODE_INVALID_BRAND = 3; + + /** + * Error code indicating invalid parameter. + */ public static final int ERROR_CODE_INVALID_PARAMETER = 4; + /** + * Enumeration of category IDs. + */ public enum CategoryID { + /** Air conditioner category ID. */ AIR_CONDITIONER(1), + /** TV category ID. */ TV(2), + /** Set-top box category ID. */ STB(3), + /** Network box category ID. */ NET_BOX(4), + /** IPTV category ID. */ IPTV(5), + /** DVD category ID. */ DVD(6), + /** Fan category ID. */ FAN(7), + /** Projector category ID. */ PROJECTOR(8), + /** Stereo category ID. */ STEREO(9), + /** Light category ID. */ LIGHT(10), + /** BSTB category ID. */ BSTB(11), + /** Cleaning robot category ID. */ CLEANING_ROBOT(12), + /** Air cleaner category ID. */ AIR_CLEANER(13), + /** Dyson category ID. */ DYSON(14); private final int id; + /** + * Constructs a CategoryID with the specified ID. + * + * @param id the category ID + */ CategoryID(int id) { this.id = id; } + /** + * Gets the category ID value. + * + * @return the category ID value + */ public int getValue() { return id; } } + /** + * Enumeration of binary types. + */ public enum BinaryType { + /** Binary type. */ TYPE_BINARY(0), + /** Hexadecimal type. */ TYPE_HEXDECIMAL(1); private final int type; + /** + * Constructs a BinaryType with the specified type. + * + * @param type the binary type + */ BinaryType(int type) { this.type = type; } + /** + * Gets the binary type value. + * + * @return the binary type value + */ public int getValue() { return type; } } + /** + * Enumeration of AC power states. + */ public enum ACPower { + /** AC power on state. */ POWER_ON(0), + /** AC power off state. */ POWER_OFF(1); private final int power; + /** + * Constructs an ACPower with the specified power state. + * + * @param power the power state + */ ACPower(int power) { this.power = power; } + /** + * Gets the power state value. + * + * @return the power state value + */ public int getValue() { return power; } } + /** + * Enumeration of AC modes. + */ public enum ACMode { + /** Cool mode. */ MODE_COOL(0), + /** Heat mode. */ MODE_HEAT(1), + /** Auto mode. */ MODE_AUTO(2), + /** Fan mode. */ MODE_FAN(3), + /** Dehumidify mode. */ MODE_DEHUMIDITY(4); private final int mode; + /** + * Constructs an ACMode with the specified mode. + * + * @param mode the AC mode + */ ACMode(int mode) { this.mode = mode; } + /** + * Gets the mode value. + * + * @return the mode value + */ public int getValue() { return mode; } } + /** + * Enumeration of AC temperatures. + */ public enum ACTemperature { + /** Temperature 16 degrees. */ TEMP_16(0), + /** Temperature 17 degrees. */ TEMP_17(1), + /** Temperature 18 degrees. */ TEMP_18(2), + /** Temperature 19 degrees. */ TEMP_19(3), + /** Temperature 20 degrees. */ TEMP_20(4), + /** Temperature 21 degrees. */ TEMP_21(5), + /** Temperature 22 degrees. */ TEMP_22(6), + /** Temperature 23 degrees. */ TEMP_23(7), + /** Temperature 24 degrees. */ TEMP_24(8), + /** Temperature 25 degrees. */ TEMP_25(9), + /** Temperature 26 degrees. */ TEMP_26(10), + /** Temperature 27 degrees. */ TEMP_27(11), + /** Temperature 28 degrees. */ TEMP_28(12), + /** Temperature 29 degrees. */ TEMP_29(13), + /** Temperature 30 degrees. */ TEMP_30(14); private final int temp; + /** + * Constructs an ACTemperature with the specified temperature. + * + * @param temp the temperature value + */ ACTemperature(int temp) { this.temp = temp; } + /** + * Gets the temperature value. + * + * @return the temperature value + */ public int getValue() { return temp; } } + /** + * Enumeration of AC wind speeds. + */ public enum ACWindSpeed { + /** Auto wind speed. */ SPEED_AUTO(0), + /** Low wind speed. */ SPEED_LOW(1), + /** Medium wind speed. */ SPEED_MEDIUM(2), + /** High wind speed. */ SPEED_HIGH(3); private final int speed; + /** + * Constructs an ACWindSpeed with the specified speed. + * + * @param speed the wind speed + */ ACWindSpeed(int speed) { this.speed = speed; } + /** + * Gets the wind speed value. + * + * @return the wind speed value + */ public int getValue() { return speed; } } + /** + * Enumeration of AC swing modes. + */ public enum ACSwing { + /** Swing on mode. */ SWING_ON(0), + /** Swing off mode. */ SWING_OFF(1); private final int swing; + /** + * Constructs an ACSwing with the specified swing mode. + * + * @param swing the swing mode + */ ACSwing(int swing) { this.swing = swing; } + /** + * Gets the swing mode value. + * + * @return the swing mode value + */ public int getValue() { return swing; } } + /** + * Enumeration of AC functions. + */ public enum ACFunction { + /** Function to switch power. */ FUNCTION_SWITCH_POWER(1), + /** Function to change mode. */ FUNCTION_CHANGE_MODE(2), + /** Function to increase temperature. */ FUNCTION_TEMPERATURE_UP(3), + /** Function to decrease temperature. */ FUNCTION_TEMPERATURE_DOWN(4), + /** Function to switch wind speed. */ FUNCTION_SWITCH_WIND_SPEED(5), + /** Function to switch wind direction. */ FUNCTION_SWITCH_WIND_DIR(6), + /** Function to switch swing mode. */ FUNCTION_SWITCH_SWING(7); private final int function; + /** + * Constructs an ACFunction with the specified function. + * + * @param function the function value + */ ACFunction(int function) { this.function = function; } + /** + * Gets the function value. + * + * @return the function value + */ public int getValue() { return function; } } -} +} \ No newline at end of file diff --git a/web-sdk/src/main/java/net/irext/webapi/utils/MD5Digest.java b/web-sdk/src/main/java/net/irext/webapi/utils/MD5Digest.java index 1c48710..e9fe7fb 100644 --- a/web-sdk/src/main/java/net/irext/webapi/utils/MD5Digest.java +++ b/web-sdk/src/main/java/net/irext/webapi/utils/MD5Digest.java @@ -14,6 +14,19 @@ import java.security.MessageDigest; */ public class MD5Digest { + /** + * Default constructor for MD5Digest. + */ + public MD5Digest() { + // Private constructor to prevent instantiation + } + + /** + * Generates an MD5 hash for the given content. + * + * @param content the content to hash + * @return the MD5 hash of the content + */ public static String MD5(String content) { String result = null; try { @@ -37,4 +50,4 @@ public class MD5Digest { } return result; } -} +} \ No newline at end of file diff --git a/web-sdk/target/irext-webapi-1.5.0.jar b/web-sdk/target/irext-webapi-1.5.0.jar index 5b9673a..f702d33 100644 Binary files a/web-sdk/target/irext-webapi-1.5.0.jar and b/web-sdk/target/irext-webapi-1.5.0.jar differ diff --git a/web-sdk/target/irext-webapi-shaded.jar b/web-sdk/target/irext-webapi-shaded.jar deleted file mode 100644 index f14f83d..0000000 Binary files a/web-sdk/target/irext-webapi-shaded.jar and /dev/null differ