added java doc

Author: DaudAhmadJF

src/main/java/io/ipgeolocation/api/Astronomy.java

@@ -5,6 +5,13 @@
 import java.math.BigDecimal;
 import java.util.Objects;
 
+/**
+ * The Astronomy class represents astronomical data for a specific date and location, including information
+ * about sunrise, sunset, moonrise, moonset, sun and moon positions, and other related details.
+ *
+ * <p>The Astronomy class provides methods to access the information stored in the {@code Astronomy} object,
+ * For Example, you can get the sunrise time by calling {@link Astronomy#getSunrise()}.
+ */
 public class Astronomy {
     private final String date;
     private final String currentTime;
@@ -26,6 +33,12 @@ public class Astronomy {
     private AstronomyLocation location;
     private final JSONObject json;
 
+    /**
+     * Constructs an Astronomy object based on the provided JSON data.
+     *
+     * @param json the JSON object containing astronomical data
+     * @throws IllegalArgumentException if the provided JSON object is null or empty
+     */
     Astronomy(JSONObject json) {
         if (Objects.isNull(json)) {
             throw new IllegalArgumentException("'json' must not be null");
@@ -59,78 +72,173 @@ public class Astronomy {
         this.json = json;
     }
 
+    /**
+     * Returns the date for which astronomical data is provided.
+     *
+     * @return The date as String.
+     */
     public String getDate() {
         return date;
     }
 
+    /**
+     * Returns the current time at the location in the format "HH:mm:ss".
+     *
+     * @return The current time as String.
+     */
     public String getCurrentTime() {
         return currentTime;
     }
 
+    /**
+     * Returns the time of sunrise in the format "HH:mm".
+     *
+     * @return The time of sunrise as String.
+     */
     public String getSunrise() {
         return sunrise;
     }
 
+    /**
+     * Returns the time of sunset in the format "HH:mm".
+     *
+     * @return The time of sunset as String.
+     */
     public String getSunset() {
         return sunset;
     }
 
+    /**
+     * Returns the status of sunrise and sunset as "-", if these values are not available.
+     *
+     * @return The status of the sun.
+     */
     public String getSunStatus() {
         return sunStatus;
     }
 
+    /**
+     * Returns the time of solar noon in the format "HH:mm".
+     *
+     * @return The time of solar noon as String.
+     */
     public String getSolarNoon() {
         return solarNoon;
     }
 
+    /**
+     * Returns the duration of daylight in the format "HH:mm".
+     *
+     * @return The duration of daylight.
+     */
     public String getDayLength() {
         return dayLength;
     }
 
+    /**
+     * Returns the altitude of the sun.
+     *
+     * @return The altitude of the sun in degrees.
+     */
     public BigDecimal getSunAltitude() {
         return sunAltitude;
     }
 
+    /**
+     * Returns the distance to the sun.
+     *
+     * @return The distance to the sun in km.
+     */
     public BigDecimal getSunDistance() {
         return sunDistance;
     }
 
+    /**
+     * Returns the azimuth of the sun.
+     *
+     * @return The azimuth of the sun in degrees.
+     */
     public BigDecimal getSunAzimuth() {
         return sunAzimuth;
     }
 
+    /**
+     * Returns the time of moonrise in the format "HH:mm".
+     *
+     * @return The time of moonrise.
+     */
     public String getMoonrise() {
         return moonrise;
     }
 
+    /**
+     * Returns the time of moonset in the format "HH:mm".
+     *
+     * @return The time of moonset.
+     */
     public String getMoonset() {
         return moonset;
     }
 
+    /**
+     * Returns the status of moon rise and moon set as "-", if these values are not available.
+     *
+     * @return The status of the moon.
+     */
     public String getMoonStatus() {
         return moonStatus;
     }
 
+    /**
+     * Returns the altitude of the moon.
+     *
+     * @return The altitude of the moon in degrees.
+     */
     public BigDecimal getMoonAltitude() {
         return moonAltitude;
     }
 
+    /**
+     * Returns the distance to the moon.
+     *
+     * @return The distance to the moon in km.
+     */
     public BigDecimal getMoonDistance() {
         return moonDistance;
     }
 
+    /**
+     * Returns the azimuth of the moon.
+     *
+     * @return The azimuth of the moon in degrees.
+     */
     public BigDecimal getMoonAzimuth() {
         return moonAzimuth;
     }
 
+    /**
+     * Returns the parallactic angle of the moon.
+     *
+     * @return The parallactic angle of the moon in degrees.
+     */
     public BigDecimal getMoonParallacticAngle() {
         return moonParallacticAngle;
     }
 
+    /**
+     * Returns the location associated with the astronomical data.
+     *
+     * @return The {@code AstronomyLocation} object.
+     */
     public AstronomyLocation getLocation() {
         return location;
     }
 
+    /**
+     * Returns a string representation of the Astronomy object, in JSON format.
+     *
+     * @return A JSON string representing the astronomical data.
+     */
     @Override
     public String toString() {
         return json.toString(2);

src/main/java/io/ipgeolocation/api/AstronomyLocation.java

@@ -5,6 +5,14 @@
 import java.math.BigDecimal;
 import java.util.Objects;
 
+/**
+ * The AstronomyLocation class represents geographic location data associated with astronomical information,
+ * including latitude, longitude, country, state/province, city, and other details.
+ *
+ * <p>The AstronomyLocation class provides methods to access the information about the {@code AstronomyLocation} object.
+ * For example, you can get the city name using the {@link AstronomyLocation#getCity()} method.
+ *
+ */
 public class AstronomyLocation {
     private final String location;
     private final BigDecimal latitude;
@@ -21,6 +29,12 @@ public class AstronomyLocation {
     private final String city;
     private final JSONObject json;
 
+    /**
+     * Constructs an AstronomyLocation object based on the provided JSON data.
+     *
+     * @param json the JSON object containing location data
+     * @throws IllegalArgumentException if the provided JSON object is null or empty
+     */
     AstronomyLocation(JSONObject json) {
         if (Objects.isNull(json)) {
             throw new IllegalArgumentException("'json' must not be null");
@@ -46,58 +60,128 @@ public class AstronomyLocation {
         this.json = json;
     }
 
+    /**
+     * Returns the location name (i.e., city, country) for which astronomy information queried.
+     *
+     * @return The location name as String.
+     */
     public String getLocation() {
         return location;
     }
 
+    /**
+     * Returns the latitude coordinate.
+     *
+     * @return The latitude coordinate as BigDecimal.
+     */
     public BigDecimal getLatitude() {
         return latitude;
     }
 
+    /**
+     * Returns the longitude coordinate.
+     *
+     * @return The longitude coordinate as BigDecimal.
+     */
     public BigDecimal getLongitude() {
         return longitude;
     }
 
+    /**
+     * Returns the postal code/Zip code.
+     *
+     * @return The postal code/Zip code as String.
+     */
     public String getZipcode() {
         return zipcode;
     }
 
+    /**
+     * Returns the ISO 3166-1 alpha-2 country code. e.g., 'PK' for Pakistan.
+     *
+     * @return The ISO 3166-1 alpha-2 country code as String.
+     */
     public String getCountryCode2() {
         return countryCode2;
     }
 
+    /**
+     * Returns the ISO 3166-1 alpha-3 country code. e.g., 'PAK' for Pakistan.
+     *
+     * @return The ISO 3166-1 alpha-3 country code as String.
+     */
     public String getCountryCode3() {
         return countryCode3;
     }
 
+    /**
+     * Returns the general country name.
+     *
+     * @return The country name as String.
+     */
     public String getCountryName() {
         return countryName;
     }
 
+    /**
+     * Returns the official country name.
+     *
+     * @return The official country name as String.
+     */
     public String getCountryNameOfficial() {
         return countryNameOfficial;
     }
 
+    /**
+     * Returns the state or province or region name.
+     *
+     * @return The state or province name as String.
+     */
     public String getStateProv() {
         return stateProv;
     }
 
+    /**
+     * Returns the state or province code. e.g., 'PK-PB'
+     *
+     * @return The state or province code as String.
+     */
     public String getStateCode() {
         return stateCode;
     }
 
+    /**
+     * Returns the district name.
+     *
+     * @return The district name.
+     */
     public String getDistrict() {
         return district;
     }
 
+    /**
+     * Returns the locality.
+     *
+     * @return The locality as String.
+     */
     public String getLocality() {
         return locality;
     }
 
+    /**
+     * Returns the city.
+     *
+     * @return The city as String.
+     */
     public String getCity() {
         return city;
     }
 
+    /**
+     * Returns a string representation of the {@code AstronomyLocation} object, in JSON format.
+     *
+     * @return A JSON string representing the location data.
+     */
     @Override
     public String toString() {
         return json.toString(2);