minor javadoc changes

Author: Marco

src/com/brein/api/BreinActivity.java

@@ -52,6 +52,7 @@ public String getBreinActivityType() {
      * Sets activity type
      *
      * @param breinActivityType to set
+     * @return self
      */
     public BreinActivity setBreinActivityType(final String breinActivityType) {
         this.breinActivityType = breinActivityType;
@@ -76,6 +77,7 @@ public String getBreinCategoryType() {
      * sets brein category
      *
      * @param breinCategoryType object
+     * @return self
      */
     public BreinActivity setBreinCategoryType(final String breinCategoryType) {
         this.breinCategoryType = breinCategoryType;
@@ -95,6 +97,7 @@ public String getDescription() {
      * sets the description
      *
      * @param description string to set as description
+     * @return self
      */
     public BreinActivity setDescription(final String description) {
         this.description = description;
@@ -153,6 +156,7 @@ public BreinActivity set(final Map<String, Object> dataActivityMap) {
     /**
      * sets the activity map
      *
+     * @param key contains the key
      * @param dataActivityMap containing additional values
      * @return self
      */

src/com/brein/api/BreinBase.java

@@ -51,7 +51,7 @@ public class BreinBase implements ISecretStrategy {
     /**
      * returns the map for the base section
      *
-     * @return map <String, Object>
+     * @return map
      */
     public Map<String, Object> getBase() {
         return baseMap;
@@ -79,6 +79,7 @@ public BreinConfig getConfig() {
      * sets the brein config
      *
      * @param breinConfig object
+     * @return self
      */
     public BreinBase setConfig(final BreinConfig breinConfig) {
         this.breinConfig = breinConfig;
@@ -96,9 +97,9 @@ public BreinUser getBreinUser() {
 
     /**
      * sets the brein user
-     * ~
      *
      * @param breinUser user data
+     * @return self
      */
     public BreinBase setBreinUser(final BreinUser breinUser) {
         this.breinUser = breinUser;
@@ -136,6 +137,7 @@ public long getUnixTimestamp() {
      * sets the timestamp
      *
      * @param unixTimestamp value from 1.1.1970
+     * @return self
      */
     public BreinBase setUnixTimestamp(final long unixTimestamp) {
         this.unixTimestamp = unixTimestamp;
@@ -192,6 +194,7 @@ public Function<String, Void> getErrorCallback() {
      * sets the error callback function
      *
      * @param errorCallback function to callback
+     * @return self
      */
     public BreinBase setErrorCallback(final Function<String, Void> errorCallback) {
         this.errorCallback = errorCallback;
@@ -210,10 +213,12 @@ public Gson getGson() {
     /**
      * sets an map for the base section
      *
-     * @param baseMap map of <String, Object></String,>
+     * @param baseMap map of String, Object
+     * @return self
      */
-    public void setBase(final Map<String, Object> baseMap) {
+    public BreinBase setBase(final Map<String, Object> baseMap) {
         this.baseMap = baseMap;
+        return this;
     }
 
     /**

src/com/brein/api/BreinLookup.java

@@ -30,6 +30,7 @@ public BreinDimension getBreinDimension() {
      * sets the breindimension object - will be used for lookup
      *
      * @param breinDimension object to set
+     * @return self
      */
     public BreinLookup setBreinDimension(final BreinDimension breinDimension) {
         this.breinDimension = breinDimension;

src/com/brein/api/Breinify.java

@@ -8,7 +8,7 @@
 
 import java.util.function.Function;
 
-/**
+/*
  * Static Implementation of Breinify activity & lookup calls
  */
 public class Breinify {
@@ -168,7 +168,6 @@ public static void activity(final BreinUser user,
      * // invoke this method
      * Breinify.activity();
      * <p>
-     * <p>
      * This request is asynchronous.
      */
     public static void activity() {
@@ -307,19 +306,20 @@ public static BreinResult temporalData(final BreinTemporalData breinTemporalData
      * Sends a recommendation request to the engine utilizing the API. The call is done synchronously as a POST request. It is
      * important that a valid API-key is configured prior to using this function.
      *
-     * @param breinRecommenationPara contains the brein recommendation object
+     * @param breinRecommendationPara contains the brein recommendation object
+     * @return BreinResult object
      */
-    public static BreinResult recommendation(final BreinRecommendation breinRecommenationPara) {
+    public static BreinResult recommendation(final BreinRecommendation breinRecommendationPara) {
 
-        if (breinRecommenationPara == null) {
+        if (breinRecommendationPara == null) {
             throw new BreinException("BreinRecommendation is null");
         }
 
         // apply the current configuration
-        breinRecommenationPara.setConfig(getBreinRecommendation().getConfig());
+        breinRecommendationPara.setConfig(getBreinRecommendation().getConfig());
 
         // create a clone in order to prevent concurrency issues
-        final BreinRecommendation newBreinRecommendation = BreinRecommendation.clone(breinRecommenationPara);
+        final BreinRecommendation newBreinRecommendation = BreinRecommendation.clone(breinRecommendationPara);
         return newBreinRecommendation.getBreinEngine().invokeRecommendation(newBreinRecommendation);
     }
 

src/com/brein/api/BreinifyExecutor.java

@@ -7,9 +7,7 @@
 
 import java.util.function.Function;
 
-/**
- * Static Implementation of Breinify activity & lookup calls
- */
+// Static Implementation of Breinify activity & lookup calls
 public class BreinifyExecutor {
 
     /**

src/com/brein/domain/BreinConfig.java

@@ -149,6 +149,7 @@ public BreinConfig() {
 
     /**
      * initializes the rest client
+     * @return self
      */
     public BreinConfig initEngine() {
         BreinEngineType engine = getRestEngineType();
@@ -299,6 +300,7 @@ public long getConnectionTimeout() {
      * set the connection timeout
      *
      * @param connectionTimeout value
+     * @return self
      */
     public BreinConfig setConnectionTimeout(final long connectionTimeout) {
         this.connectionTimeout = connectionTimeout;
@@ -318,6 +320,7 @@ public long getSocketTimeout() {
      * set the socket timeout
      *
      * @param socketTimeout value
+     * @return self
      */
     public BreinConfig setSocketTimeout(final long socketTimeout) {
         this.socketTimeout = socketTimeout;
@@ -415,6 +418,7 @@ public String getSecret() {
      * set the secret
      *
      * @param secret raw secret
+     * @return self
      */
     public BreinConfig setSecret(final String secret) {
         this.secret = secret;
@@ -434,6 +438,7 @@ public String getDefaultCategory() {
      * sets the default category
      *
      * @param defaultCategory default to set
+     * @return self
      */
     public BreinConfig setDefaultCategory(final String defaultCategory) {
         this.defaultCategory = defaultCategory;

src/com/brein/domain/BreinDimension.java

@@ -32,6 +32,7 @@ public String[] getDimensionFields() {
      * sets dimension array
      *
      * @param dimensionFields data of dimensions
+     * @return self
      */
     public BreinDimension setDimensionFields(final String... dimensionFields) {
         this.dimensionFields = dimensionFields;

src/com/brein/domain/BreinResult.java

@@ -57,7 +57,7 @@ public boolean has(final String key) {
     /**
      * provides the map containing the results
      *
-     * @return map of <String, Object>
+     * @return map of String, Object
      */
     public Map<String, Object> getMap() {
         return map;
@@ -72,10 +72,18 @@ public String getMessage() {
         return null;
     }
 
+    /**
+     * returns the http request status
+     * @return valus like 200, 403...
+     */
     public int getStatus() {
         return status;
     }
 
+    /**
+     * sets the http request status
+     * @param status contains the value
+     */
     public void setStatus(final int status) {
         this.status = status;
     }

src/com/brein/domain/BreinUser.java

@@ -100,7 +100,8 @@ public BreinUser() {
     }
 
     /**
-     * setter & getter of the properties
+     * get the email of the user
+     * @return email
      */
     public String getEmail() {
         return email;
@@ -110,7 +111,7 @@ public String getEmail() {
      * sets the email of the user
      *
      * @param email to set (will not be checked)
-     * @return this -> allows chaining
+     * @return this
      */
     public BreinUser setEmail(final String email) {
         this.email = email;
@@ -130,7 +131,7 @@ public String getFirstName() {
      * set the first name of the user
      *
      * @param firstName name to set
-     * @return this -> allows chaining
+     * @return this
      */
     public BreinUser setFirstName(final String firstName) {
         this.firstName = firstName;
@@ -150,7 +151,7 @@ public String getLastName() {
      * set the last name of the user
      *
      * @param lastName last name
-     * @return thi -> allows chaining
+     * @return thi
      */
     public BreinUser setLastName(final String lastName) {
         this.lastName = lastName;
@@ -170,6 +171,7 @@ public String getSessionId() {
      * sets the sessionId
      *
      * @param sessionId value of the sessionId
+     * @return self
      */
     public BreinUser setSessionId(final String sessionId) {
         this.sessionId = sessionId;
@@ -189,6 +191,7 @@ public String getUserAgent() {
      * sets the additional user agent value
      *
      * @param userAgent value
+     * @return self
      */
     public BreinUser setUserAgent(final String userAgent) {
         this.userAgent = userAgent;
@@ -208,6 +211,7 @@ public String getIpAddress() {
      * sets the ipAddress
      *
      * @param ipAddress value
+     * @return self
      */
     public BreinUser setIpAddress(final String ipAddress) {
         this.ipAddress = ipAddress;
@@ -227,6 +231,7 @@ public String getReferrer() {
      * sets the additional referrer value
      *
      * @param referrer value
+     * @return self
      */
     public BreinUser setReferrer(final String referrer) {
         this.referrer = referrer;
@@ -292,6 +297,7 @@ public BreinUser setDateOfBirth(final int month, final int day, final int year)
      * Sets the value of dateOfBirth as String. This is only used internally.
      *
      * @param dateOfBirthString contains the date of birth string
+     * @return self
      */
     private BreinUser setDateOfBirthString(final String dateOfBirthString) {
         this.dateOfBirth = dateOfBirthString;
@@ -398,6 +404,7 @@ public Map<String, Object> get() {
      * sets the user map
      *
      * @param userMap map
+     * @return self
      */
     public BreinUser set(final Map<String, Object> userMap) {
         if (userMap == null) {
@@ -415,6 +422,7 @@ public BreinUser set(final Map<String, Object> userMap) {
      *
      * @param key     contains the key for the nested map
      * @param userMap map of fields
+     * @return self
      */
     public BreinUser set(final String key, final Map<String, Object> userMap) {
         if (userMap == null) {
@@ -436,6 +444,7 @@ public Map<String, Object> getAdditional() {
      * sets the user additional map
      *
      * @param additional map
+     * @return self
      */
     public BreinUser setAdditional(final Map<String, Object> additional) {
         if (additional == null) {
@@ -454,6 +463,7 @@ public BreinUser setAdditional(final Map<String, Object> additional) {
      *
      * @param key        contains the key for the nested map
      * @param additional map of fields
+     * @return self
      */
     public BreinUser setAdditional(final String key, final Map<String, Object> additional) {
         if (additional == null) {
@@ -564,7 +574,6 @@ public void prepareAdditionalFields(final BreinUser breinUser, final Map<String,
         if (BreinUtil.containsValue(breinUser.getTimezone())) {
             jsonObject.put("timezone", breinUser.getTimezone());
         }
-
     }
 
     /**

src/com/brein/engine/IRestEngine.java

@@ -91,7 +91,7 @@ static boolean isUrlValid(final String url) {
     }
 
     /**
-     * checks if the url is valid -> if not an exception will be thrown
+     * checks if the url is valid. If not an exception will be thrown
      *
      * @param fullyQualifiedUrl url with endpoint
      */