TwitterException (twitter4j-ads 5.0 API)

java.lang.Object
- java.lang.Throwable
- - java.lang.Exception
  - - twitter4jads.internal.models4j.TwitterException

All Implemented Interfaces:

java.io.Serializable, HttpResponseCode, TwitterResponse

Direct Known Subclasses:

TwitterInvalidParameterException
```
public class TwitterException
extends java.lang.Exception
implements TwitterResponse, HttpResponseCode
```
An exception class that will be thrown when TwitterAPI calls are failed.
In case the Twitter server returned HTTP error code, you can get the HTTP status code using getStatusCode() method.

See Also:

Serialized Form

Field Summary
- Fields inherited from interface twitter4jads.internal.models4j.TwitterResponse
  NONE, READ, READ_WRITE, READ_WRITE_DIRECTMESSAGES
- Fields inherited from interface twitter4jads.internal.http.HttpResponseCode
  BAD_GATEWAY, BAD_REQUEST, ENHANCE_YOUR_CLAIM, FORBIDDEN, FOUND, GATEWAY_TIMEOUT, INTERNAL_SERVER_ERROR, MULTIPLE_CHOICES, NOT_ACCEPTABLE, NOT_FOUND, NOT_MODIFIED, OK, RESUME_INCOMPLETE, SERVICE_UNAVAILABLE, TOO_MANY_REQUESTS, UNAUTHORIZED, UNPROCESSABLE_ENTITY

Constructor Summary

Constructors
Constructor and Description
`TwitterException(java.lang.Exception cause)`
`TwitterException(java.lang.String message)`
`TwitterException(java.lang.String message, java.lang.Exception cause, int statusCode)`
`TwitterException(java.lang.String message, HttpRequest req, HttpResponse res)`
`TwitterException(java.lang.String message, HttpResponse res)`
`TwitterException(java.lang.String message, java.lang.Throwable cause)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object o)`
`boolean`	`exceededRateLimitation()` Tests if the exception is caused by rate limitation exceed
`int`	`getAccessLevel()`
`java.lang.String`	`getActualDetailMessage()`
`int`	`getErrorCode()`
`java.lang.String`	`getErrorMessage()` Returns error message from the API if available.
`java.lang.String`	`getExceptionCode()` Returns a hexadecimal representation of this exception stacktrace. An exception code is a hexadecimal representation of the stacktrace which enables it easier to Google known issues. Format : XXXXXXXX:YYYYYYYY[ XX:YY] Where XX is a hash code of stacktrace without line number YY is a hash code of stacktrace excluding line number [-XX:YY] will appear when this instance a root cause
`java.lang.String`	`getMessage()`
`RateLimitStatus`	`getRateLimitStatus()` Returns the current rate limit status if available.
`HttpRequest`	`getRequest()`
`HttpResponse`	`getResponse()`
`java.lang.String`	`getResponseHeader(java.lang.String name)`
`int`	`getRetryAfter()` Returns int value of "Retry-After" response header (Search API) or seconds_until_reset (REST API).
`int`	`getStatusCode()`
`int`	`hashCode()`
`boolean`	`isCausedByNetworkIssue()` Tests if the exception is caused by network issue
`boolean`	`isErrorMessageAvailable()` Tests if error message from the API is available
`boolean`	`resourceNotFound()` Tests if the exception is caused by non-existing resource
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Throwable
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - TwitterException
```
public TwitterException(java.lang.String message,
                        java.lang.Throwable cause)
```
  - TwitterException
```
public TwitterException(java.lang.String message)
```
  - TwitterException
```
public TwitterException(java.lang.Exception cause)
```
  - TwitterException
```
public TwitterException(java.lang.String message,
                        HttpResponse res)
```
  - TwitterException
```
public TwitterException(java.lang.String message,
                        HttpRequest req,
                        HttpResponse res)
```
  - TwitterException
```
public TwitterException(java.lang.String message,
                        java.lang.Exception cause,
                        int statusCode)
```
- Method Detail
  - getMessage
```
public java.lang.String getMessage()
```
    Overrides:
    
    getMessage in class java.lang.Throwable
  - getStatusCode
```
public int getStatusCode()
```
  - getErrorCode
```
public int getErrorCode()
```
  - getResponseHeader
```
public java.lang.String getResponseHeader(java.lang.String name)
```
  - getRateLimitStatus
```
public RateLimitStatus getRateLimitStatus()
```
    Returns the current rate limit status if available.
    
    Specified by:
    
    getRateLimitStatus in interface TwitterResponse
    
    Returns:
    
    current rate limit status
    
    Since:
    
    Twitter4J 2.1.2
  - getAccessLevel
```
public int getAccessLevel()
```
    Specified by:
    
    getAccessLevel in interface TwitterResponse
    
    Returns:
    
    application permission model
    
    See Also:
    
    Application Permission Model FAQ - How do we know what the access level of a user token is?
  - getRetryAfter
```
public int getRetryAfter()
```
    Returns int value of "Retry-After" response header (Search API) or seconds_until_reset (REST API). An application that exceeds the rate limitations of the Search API will receive HTTP 420 response codes to requests. It is a best practice to watch for this error condition and honor the Retry-After header that instructs the application when it is safe to continue. The Retry-After header's value is the number of seconds your application should wait before submitting another query (for example: Retry-After: 67).
    Check if getStatusCode() == 503 before calling this method to ensure that you are actually exceeding rate limitation with query apis.
    
    Returns:
    
    instructs the application when it is safe to continue in seconds
    
    Since:
    
    Twitter4J 2.1.0
    
    See Also:
    
    Rate Limiting | Twitter Developers
  - isCausedByNetworkIssue
```
public boolean isCausedByNetworkIssue()
```
    Tests if the exception is caused by network issue
    
    Returns:
    
    if the exception is caused by network issue
    
    Since:
    
    Twitter4J 2.1.2
  - exceededRateLimitation
```
public boolean exceededRateLimitation()
```
    Tests if the exception is caused by rate limitation exceed
    
    Returns:
    
    if the exception is caused by rate limitation exceed
    
    Since:
    
    Twitter4J 2.1.2
    
    See Also:
    
    Rate Limiting | Twitter Developers
  - resourceNotFound
```
public boolean resourceNotFound()
```
    Tests if the exception is caused by non-existing resource
    
    Returns:
    
    if the exception is caused by non-existing resource
    
    Since:
    
    Twitter4J 2.1.2
  - getExceptionCode
```
public java.lang.String getExceptionCode()
```
    Returns a hexadecimal representation of this exception stacktrace.
    An exception code is a hexadecimal representation of the stacktrace which enables it easier to Google known issues.
    Format : XXXXXXXX:YYYYYYYY[ XX:YY]
    Where XX is a hash code of stacktrace without line number
    YY is a hash code of stacktrace excluding line number
    [-XX:YY] will appear when this instance a root cause
    
    Returns:
    
    a hexadecimal representation of this exception stacktrace
  - getErrorMessage
```
public java.lang.String getErrorMessage()
```
    Returns error message from the API if available.
    
    Returns:
    
    error message from the API
    
    Since:
    
    Twitter4J 2.2.3
  - isErrorMessageAvailable
```
public boolean isErrorMessageAvailable()
```
    Tests if error message from the API is available
    
    Returns:
    
    true if error message from the API is available
    
    Since:
    
    Twitter4J 2.2.3
  - getActualDetailMessage
```
public java.lang.String getActualDetailMessage()
```
  - getRequest
```
public HttpRequest getRequest()
```
  - getResponse
```
public HttpResponse getResponse()
```
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Throwable

Class TwitterException

Field Summary

Fields inherited from interface twitter4jads.internal.models4j.TwitterResponse

Fields inherited from interface twitter4jads.internal.http.HttpResponseCode

Constructor Summary

Method Summary

Methods inherited from class java.lang.Throwable

Methods inherited from class java.lang.Object

Constructor Detail

TwitterException

TwitterException

TwitterException

TwitterException

TwitterException

TwitterException

Method Detail

getMessage

getStatusCode

getErrorCode

getResponseHeader

getRateLimitStatus

getAccessLevel

getRetryAfter

isCausedByNetworkIssue

exceededRateLimitation

resourceNotFound

getExceptionCode

getErrorMessage

isErrorMessageAvailable

getActualDetailMessage

getRequest

getResponse

equals

hashCode

toString