com.firebase.jobdispatcher

Class DefaultJobValidator

java.lang.Object

com.firebase.jobdispatcher.DefaultJobValidator

All Implemented Interfaces:

JobValidator

public class DefaultJobValidator
extends java.lang.Object
implements JobValidator

Validates Jobs according to some safe standards.

Custom JobValidators should typically extend from this.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_EXTRAS_SIZE_BYTES The maximum size, in bytes, that the provided extras bundle can be.
static int	MAX_TAG_LENGTH The maximum length of a tag, in characters (i.e.

Constructor Summary

Constructors

Constructor and Description
DefaultJobValidator(android.content.Context context)

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	validate(JobParameters job) Attempts to validate the provided JobParameters.
java.util.List<java.lang.String>	validate(JobTrigger trigger) Attempts to validate the provided Trigger.
java.util.List<java.lang.String>	validate(RetryStrategy retryStrategy) Attempts to validate the provided RetryStrategy.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MAX_TAG_LENGTH

public static final int MAX_TAG_LENGTH

The maximum length of a tag, in characters (i.e. String.length()). Strings longer than this will cause validation to fail.

See Also:

Constant Field Values

MAX_EXTRAS_SIZE_BYTES

public static final int MAX_EXTRAS_SIZE_BYTES

The maximum size, in bytes, that the provided extras bundle can be. Corresponds to Parcel.dataSize().

See Also:

Constant Field Values

Constructor Detail

DefaultJobValidator

public DefaultJobValidator(android.content.Context context)

Method Detail

validate

public java.util.List<java.lang.String> validate(JobParameters job)

Attempts to validate the provided JobParameters. If the JobParameters is valid, null will be returned. If the JobParameters has errors, a list of those errors will be returned.

Specified by:

validate in interface JobValidator

validate

public java.util.List<java.lang.String> validate(JobTrigger trigger)

Attempts to validate the provided Trigger. If valid, null is returned. Otherwise a list of errors will be returned.

Note that a Trigger that passes validation here is not necessarily valid in all permutations of a JobParameters. For example, an Immediate is never valid for a recurring job.

Specified by:

validate in interface JobValidator

validate

public java.util.List<java.lang.String> validate(RetryStrategy retryStrategy)

Attempts to validate the provided RetryStrategy. If valid, null is returned. Otherwise a list of errors will be returned.

Specified by:

validate in interface JobValidator