Package com.aerisweather.aeris.response

Class ThreatsResponse

  • public class ThreatsResponse
extends Object
    Object to make the Threats endpoint response more friendly to determine what parts of the AerisDataJSON have come back in the response.

    • Constructor Detail

      • ThreatsResponse

        public ThreatsResponse()

    • Method Detail

      • fromJSON

        public static ThreatsResponse fromJSON​(org.json.JSONObject jsonObject)

      • createWithError

        public static String createWithError​(String code,
                                     String description)
        Creates a JSON String for an ThreatsResponse with a specific Error code and description.
        Parameters:
        code - Code of the error
        description - description of the error
        Returns:
        String JSON object of an AerisResponse with the code and description

      • createObjectWithError

        public static ThreatsResponse createObjectWithError​(String code,
                                                    String description)
        Creates a JSON String for an ThreatsResponse with a specific Error code and description.
        Parameters:
        code - Code of the error
        description - description of the error
        Returns:
        String JSON object of an AerisResponse with the code and description

      • parseResponse

        public void parseResponse​(org.json.JSONObject object)
                   throws org.json.JSONException
        Throws:
        org.json.JSONException

      • getNumberOfResponses

        public int getNumberOfResponses()
        Returns the number of responses for this AerisResponse.
        Returns:
        Number of responses

      • getResponse

        public ThreatsDataJSON getResponse​(int index)
        Gets the data for the given index. Pass into a AerisFriendlyResponse
        Parameters:
        index - index to get the response at.
        Returns:
        AerisData at that index.

      • getFirstResponse

        public ThreatsDataJSON getFirstResponse()
        Gets the first index in the list of the responses.
        Returns:
        data for the first response.

      • getListOfResponse

        public List<ThreatsDataJSON> getListOfResponse()
        Gets the list of data responses
        Returns:
        The list of data responses.

      • isSuccessfulWithResponses

        public boolean isSuccessfulWithResponses()
        Gets the success of the response along with checking that there was no warning, and that the list of responses is not null.
        Returns:
        true if the response was successful with responses

      • isSuccessful

        public boolean isSuccessful()
        Gets the success of the response. Returns true if the response was successful or had a warning.
        Returns:
        true if the response was successful.

      • getError

        public AerisError getError()
        Gets the error from the response, if there is one.
        Returns:
        the error