com.mopub.mobileads

Enum VastErrorCode

java.lang.Object

java.lang.Enum<VastErrorCode>

com.mopub.mobileads.VastErrorCode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<VastErrorCode>

public enum VastErrorCode
extends java.lang.Enum<VastErrorCode>

The various possible error codes for VAST that MoPub supports. See https://www.iab.net/media/file/VASTv3.0.pdf for more information about the error codes.

Enum Constant Summary

Enum Constants

Enum Constant and Description
GENERAL_COMPANION_AD_ERROR For any reason the companion ad failed to download or show.
GENERAL_LINEAR_AD_ERROR For any reason the linear video ad failed to download or play (or for errors during playback).
NO_ADS_VAST_RESPONSE When receiving a no ads VAST response after one or more Wrappers.
UNDEFINED_ERROR Any other error, or an unexpected error.
WRAPPER_TIMEOUT When following a wrapper redirect and the URI was either unavailable or reached a timeout as defined by the video player.
XML_PARSING_ERROR For any type of XML issue in the VAST document.

Method Summary

Methods

Modifier and Type	Method and Description
static VastErrorCode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static VastErrorCode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

XML_PARSING_ERROR

public static final VastErrorCode XML_PARSING_ERROR

For any type of XML issue in the VAST document. e.g. missing a matching tag, missing a square bracket, not using CDATA correctly, etc.

WRAPPER_TIMEOUT

public static final VastErrorCode WRAPPER_TIMEOUT

When following a wrapper redirect and the URI was either unavailable or reached a timeout as defined by the video player.

NO_ADS_VAST_RESPONSE

public static final VastErrorCode NO_ADS_VAST_RESPONSE

When receiving a no ads VAST response after one or more Wrappers. See section 2.4.2.4 in the Vast 3.0 spec for details.

GENERAL_LINEAR_AD_ERROR

public static final VastErrorCode GENERAL_LINEAR_AD_ERROR

For any reason the linear video ad failed to download or play (or for errors during playback).

GENERAL_COMPANION_AD_ERROR

public static final VastErrorCode GENERAL_COMPANION_AD_ERROR

For any reason the companion ad failed to download or show. MoPub still tries to show the linear ad regardless of the status of the companion ad.

UNDEFINED_ERROR

public static final VastErrorCode UNDEFINED_ERROR

Any other error, or an unexpected error.

Method Detail

values

public static VastErrorCode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (VastErrorCode c : VastErrorCode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static VastErrorCode valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null