com.firebase.jobdispatcher

Class ValidationEnforcer

java.lang.Object

com.firebase.jobdispatcher.ValidationEnforcer

All Implemented Interfaces:

JobValidator

public class ValidationEnforcer
extends java.lang.Object
implements JobValidator

Wraps a JobValidator and provides helpful validation utilities.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ValidationEnforcer.ValidationException An Exception thrown when a validation error is encountered.

Constructor Summary

Constructors

Constructor and Description
ValidationEnforcer(JobValidator validator)

Method Summary

Modifier and Type	Method and Description
void	ensureValid(JobParameters job) Throws a RuntimeException if the provided JobParameters is invalid.
void	ensureValid(JobTrigger trigger) Throws a RuntimeException if the provided JobTrigger is invalid.
void	ensureValid(RetryStrategy retryStrategy) Throws a RuntimeException if the provided RetryStrategy is invalid.
boolean	isValid(JobParameters job) Indicates whether the provided JobParameters is valid.
boolean	isValid(JobTrigger trigger) Indicates whether the provided JobTrigger is valid.
boolean	isValid(RetryStrategy retryStrategy) Indicates whether the provided RetryStrategy is valid.
java.util.List<java.lang.String>	validate(JobParameters job) Returns a List of error messages, or null if the JobParameters is valid.
java.util.List<java.lang.String>	validate(JobTrigger trigger) Returns a List of error messages, or null if the Trigger is valid.
java.util.List<java.lang.String>	validate(RetryStrategy retryStrategy) Returns a List of error messages, or null if the RetryStrategy is valid.

Methods inherited from class java.lang.Object

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

Constructor Detail

ValidationEnforcer

public ValidationEnforcer(JobValidator validator)

Method Detail

validate

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

Returns a List of error messages, or null if the JobParameters is valid.

Specified by:

validate in interface JobValidator

validate

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

Returns a List of error messages, or null if the Trigger is valid.

Specified by:

validate in interface JobValidator

Parameters:

trigger -

validate

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

Returns a List of error messages, or null if the RetryStrategy is valid.

Specified by:

validate in interface JobValidator

isValid

public final boolean isValid(JobParameters job)

Indicates whether the provided JobParameters is valid.

isValid

public final boolean isValid(JobTrigger trigger)

Indicates whether the provided JobTrigger is valid.

isValid

public final boolean isValid(RetryStrategy retryStrategy)

Indicates whether the provided RetryStrategy is valid.

ensureValid

public final void ensureValid(JobParameters job)

Throws a RuntimeException if the provided JobParameters is invalid.

Throws:

ValidationEnforcer.ValidationException

ensureValid

public final void ensureValid(JobTrigger trigger)

Throws a RuntimeException if the provided JobTrigger is invalid.

Throws:

ValidationEnforcer.ValidationException

ensureValid

public final void ensureValid(RetryStrategy retryStrategy)

Throws a RuntimeException if the provided RetryStrategy is invalid.

Throws:

ValidationEnforcer.ValidationException