uws.job.serializer.filter

Class PhasesFilter

java.lang.Object

uws.job.serializer.filter.PhasesFilter

All Implemented Interfaces:

JobFilter

public final class PhasesFilter
extends java.lang.Object
implements JobFilter

Job filter based on the execution phase.

Only jobs that are in one of the execution phases listed in this filter are kept.

The constructor of this filter requires exactly one execution phase. But obviously more phases can be added to the list of accepted execution phases by using the function add(ExecutionPhase).

Since:

4.3

Version:

4.3 (10/2017)

Author:

Grégory Mantelet (ARI)

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<ExecutionPhase>	phases List of execution phases in which jobs to keep must be.

Constructor Summary

Constructors

Constructor and Description
PhasesFilter(ExecutionPhase phase) Build a PhasesFilter which will retain only jobs in the given execution phase.

Method Summary

Modifier and Type	Method and Description
void	add(ExecutionPhase phase) Add the given phase in the list of accepted phases.
boolean	match(UWSJob job) Tell whether the given job match this filter.

Methods inherited from class java.lang.Object

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

Field Detail

phases

protected final java.util.List<ExecutionPhase> phases

List of execution phases in which jobs to keep must be.

Constructor Detail

PhasesFilter

public PhasesFilter(ExecutionPhase phase)
             throws java.lang.NullPointerException

Build a PhasesFilter which will retain only jobs in the given execution phase.

More phases can be added into the list of accepted phases thanks to the function add(ExecutionPhase).

Parameters:

phase - An execution phase on which jobs to retain must be.

Throws:

java.lang.NullPointerException - If the given phase is NULL.

Method Detail

add

public void add(ExecutionPhase phase)

Add the given phase in the list of accepted phases.

Note: The given phase is not added into the list if it is already inside.

Parameters:

phase - An execution phase to add inside the list of accepted phases.

match

public boolean match(UWSJob job)

Description copied from interface: JobFilter

Tell whether the given job match this filter.

Note: In case of error while evaluating this filter on the given job, false will be returned.

Specified by:

match in interface JobFilter

Parameters:

job - A job to filter.

Returns:

true if the job matches this filter, false otherwise.