com.birbit.android.jobqueue

Class Constraint

java.lang.Object

com.birbit.android.jobqueue.Constraint

public class Constraint
extends java.lang.Object

This class is used when querying JobQueues to fetch particular jobs.

JobQueues should not reference this class after the query method returns because Constraints are re-used by the JobManager.

Constructor Summary

Constructors

Constructor and Description
Constraint()

Method Summary

Modifier and Type	Method and Description
boolean	excludeRunning() Returns true if running jobs should be excluded from the query
java.util.List<java.lang.String>	getExcludeGroups() The list of groups to be excluded.
java.util.List<java.lang.String>	getExcludeJobIds() The list of jobs ids that should be excluded from the result
int	getMaxNetworkType() Returns the max allowed network type
long	getNowInNs()
TagConstraint	getTagConstraint() The tag constraint to be used while querying with tags.
java.util.Set<java.lang.String>	getTags() The set of tags.
java.lang.Long	getTimeLimit() Exclude jobs whose run time is after this time.
void	setNowInNs(long nowInNs)

Methods inherited from class java.lang.Object

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

Constructor Detail

Constraint

public Constraint()

Method Detail

getMaxNetworkType

public int getMaxNetworkType()

Returns the max allowed network type

Returns:

The max allowed network type for a job to match

getTagConstraint

public TagConstraint getTagConstraint()

The tag constraint to be used while querying with tags.

Returns:

The tag constraint to be used or null if there is no tag constraints.

See Also:

getTags()

getTags

public java.util.Set<java.lang.String> getTags()

The set of tags. If this list is not-empty, getTagConstraint() will have a non-null result.

Returns:

The set of tags

See Also:

getTagConstraint()

getExcludeGroups

public java.util.List<java.lang.String> getExcludeGroups()

The list of groups to be excluded. It is guaranteed to be ordered in natural string sorting order.

Returns:

The set of job groups to exclude.

excludeRunning

public boolean excludeRunning()

Returns true if running jobs should be excluded from the query

Returns:

True if running jobs should be excluded

getTimeLimit

public java.lang.Long getTimeLimit()

Exclude jobs whose run time is after this time. Might be null if there is no time limit.

Returns:

Time in NS which should be used to filter out delayed jobs

getExcludeJobIds

public java.util.List<java.lang.String> getExcludeJobIds()

The list of jobs ids that should be excluded from the result

Returns:

The list of job ids that should be excluded from the result

setNowInNs

public void setNowInNs(long nowInNs)

getNowInNs

public long getNowInNs()