Skip to content

Commit 7fd61d2

Browse files
committed
Added documentation for the Astronomy related classes
Added documentation for the classes 'AstronomyParams', 'AstronomyParams.AstronomyParamsBuilder', 'Astronomy' and AstronomyLocation'
1 parent 3541bd5 commit 7fd61d2

File tree

1 file changed

+63
-0
lines changed

1 file changed

+63
-0
lines changed

README.md

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -581,3 +581,66 @@ IP Geolocation API Java SDK has the following classes that you can use to fully
581581
| getType() | Returns user-agent's operating system type. | String |
582582
| getVersion() | Returns user-agent's operating system version. | String |
583583
| getVersionMajor() | Returns user-agent's operating system version major. | String |
584+
585+
### Class: io.ipgeolocation.api.AstronomyParams
586+
587+
| Method | Description | Return Type |
588+
|:------------------|:-------------------------------------------------------------------|:------------------------------|
589+
| getLocation() | Returns location parameter value to get astronomy information. | String |
590+
| getLatitude() | Returns latitude parameter value to get astronomy information. | BigDecimal |
591+
| getLongitude() | Returns longitude parameter value to get astronomy information. | BigDecimal |
592+
| getIpAddress() | Returns IP address parameter value to get astronomy information. | String |
593+
| getDate() | Returns date parameter value to get astronomy information. | String |
594+
| getLang() | Returns language set to get the astronomy information. | String |
595+
| builder() | Returns an instance of AstronomyParamsBuilder class. | static AstronomyParamsBuilder |
596+
597+
### Class: io.ipgeolocation.api.AstronomyParams.AstronomyParamsBuilder
598+
| Method | Description | Return Type |
599+
|:------------------|:--------------------------------------------------------------------------|:-------------------------|
600+
| withLocation() | Sets location to query astronomy information. | AstronomyParamsBuilder |
601+
| withCoordinates() | Sets latitude and longitude of a location to query astronomy information. | AstronomyParamsBuilder |
602+
| withIPAddress() | Sets IP address of which to query astronomy information. | AstronomyParamsBuilder |
603+
| withDate() | Sets date of which to query astronomy information. | AstronomyParamsBuilder |
604+
| withLang() | Sets language in which to query information. | AstronomyParamsBuilder |
605+
| build() | Returns an instance of AstronomyParams with the above specified value(s). | AstronomyParamsBuilder |
606+
607+
### Class: io.ipgeolocation.api.Astronomy
608+
| Method | Description | Return Type |
609+
|:--------------------------|:-----------------------------------------------------------------------------------------|:------------------|
610+
| getDate() | Returns the date of which the information is queried in "yyyy-MM-dd" format. | String |
611+
| getCurrentTime() | Returns the current time in the format "HH:mm:ss". | String |
612+
| getSunrise() | Returns the time at which sun rises in format "HH:mm". | String |
613+
| getSunset() | Returns the time at which sun sets in format "HH:mm". | String |
614+
| getSunStatus() | Returns the status of sunrise and sunset as "-", if these values are not available. | String |
615+
| getSolarNoon() | Returns the solar noon time in the format "HH:mm". | String |
616+
| getDayLength() | Returns the day length in the format "HH:mm". | String |
617+
| getSunAltitude() | Returns the altitude of the sun in degrees. | BigDecimal |
618+
| getSunDistance() | Returns the distance from the sun in km. | BidDecimal |
619+
| getSunAzimuth() | Returns the azimuth of the sun in degrees. | BigDecimal |
620+
| getMoonrise() | Returns the moon rise time in the format "HH:mm". | BigDecimal |
621+
| getMoonset() | Returns the moon set time in the format "HH:mm". | BigDecimal |
622+
| getMoonStatus() | Returns the status of moon rise and moon set as "-", if these values are not available. | BigDecimal |
623+
| getMoonAltitude() | Returns the altitude of the moon in degrees. | BigDecimal |
624+
| getMoonDistance() | Returns the distance from the moon in km. | BigDecimal |
625+
| getMoonAzimuth() | Returns the azimuth of the moon in degrees. | BigDecimal |
626+
| getMoonParallacticAngle() | Returns the Moon Parallactic angle of the moon in degrees. | BigDecimal |
627+
| getLocation() | Returns the instance of the AstronomyLocation related to astronomy information. | AstronomyLocation |
628+
| toString() | Returns the fetched JSON from the API in formatted way. | String |
629+
630+
### Class: io.ipgeolocation.api.AstronomyLocation
631+
| Method | Description | Return Type |
632+
|:--------------------------|:------------------------------------------------------------------------------------------|:------------|
633+
| getLocation() | Returns the input location i.e., street address. | String |
634+
| getLatitude() | Returns the latitude value for which the astronomy information was queried. | BigDecimal |
635+
| getLongitude() | Returns the longitude value for which the astronomy information was queried. | BigDecimal |
636+
| getZipcode() | Returns the zip code related to the queried astronomy information. | String |
637+
| getCountryCode2() | Returns the two letter country code for queried astronomy information. e.g. 'PK'. | String |
638+
| getCountryCode3() | Returns the three letter country code for the queried astronomy information. e.g., 'PAK'. | String |
639+
| getCountryName() | Returns the general country name of the queried astronomy information. | String |
640+
| getCountryNameOfficial() | Returns the official country name of the queried astronomy information. | String |
641+
| getStateProv() | Returns the State/Province of the queried astronomy information. | String |
642+
| getStateCode() | Returns the state code of the queried astronomy information. e.g., 'PK-PB' | String |
643+
| getDistrict() | Returns the district of the queried astronomy information. | String |
644+
| getLocality() | Returns the locality of the queried astronomy information. | String |
645+
| getCity() | Returns the city of the queried astronomy information. | String |
646+
| toString() | Returns the fetched JSON from the API in the formatted way. | String |

0 commit comments

Comments
 (0)