org.gradle.gradleplugin.foundation.filters

Class BasicProjectAndTaskFilter

java.lang.Object

org.gradle.gradleplugin.foundation.filters.BasicProjectAndTaskFilter

All Implemented Interfaces:

ProjectAndTaskFilter, SettingsSerializable

public class BasicProjectAndTaskFilter
extends Object
implements ProjectAndTaskFilter, SettingsSerializable

This is a basic filter where you can specify specific projects and tasks that will be filtered out.

Author:

mhunsicker

Constructor Summary

Constructors

Constructor and Description
BasicProjectAndTaskFilter()
BasicProjectAndTaskFilter(List<String> filteredOutProjectNames, List<String> filteredOutTaskNames, boolean filterOutTasksWithNoDescription)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	doesAllowProject(ProjectView project) Determines if the specified project should be allowed or not.
boolean	doesAllowTask(TaskView task) Determines if the specified task should be allowed or not.
static boolean	doesAllowTask(TaskView task, List<String> filteredOutTasks, boolean filterOutTasksWithNoDescription) Determines if the specified task should be allowed or not.
boolean	filterOutTasksWithNoDescription()
List<String>	getFilteredOutProjectNames()
List<String>	getFilteredOutTaskNames()
void	serializeIn(SettingsNode settings) Call this to read in this object's settings.
void	serializeOut(SettingsNode settings) Call this to saves the current settings.

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicProjectAndTaskFilter

public BasicProjectAndTaskFilter(List<String> filteredOutProjectNames,
                         List<String> filteredOutTaskNames,
                         boolean filterOutTasksWithNoDescription)

BasicProjectAndTaskFilter

public BasicProjectAndTaskFilter()

Method Detail

getFilteredOutProjectNames

public List<String> getFilteredOutProjectNames()

getFilteredOutTaskNames

public List<String> getFilteredOutTaskNames()

filterOutTasksWithNoDescription

public boolean filterOutTasksWithNoDescription()

doesAllowProject

public boolean doesAllowProject(ProjectView project)

Determines if the specified project should be allowed or not.

Specified by:

doesAllowProject in interface ProjectAndTaskFilter

Parameters:

project - the project in question

Returns:

true to allow it, false not to.

doesAllowTask

public boolean doesAllowTask(TaskView task)

Determines if the specified task should be allowed or not.

Specified by:

doesAllowTask in interface ProjectAndTaskFilter

Parameters:

task - the task in question

Returns:

true to allow it, false not to.

doesAllowTask

public static boolean doesAllowTask(TaskView task,
                    List<String> filteredOutTasks,
                    boolean filterOutTasksWithNoDescription)

Determines if the specified task should be allowed or not. This version is static and is shared by this filter and its editor.

Parameters:

task - the task in question

filteredOutTasks - a list of filtered out task names

filterOutTasksWithNoDescription - whether or not to hide it if it as no description

Returns:

true if the task is allowed, false if not.

serializeOut

public void serializeOut(SettingsNode settings)

Call this to saves the current settings.

Specified by:

serializeOut in interface SettingsSerializable

Parameters:

settings - where you save the settings.

serializeIn

public void serializeIn(SettingsNode settings)

Call this to read in this object's settings. The reverse of serializeOut.

Specified by:

serializeIn in interface SettingsSerializable

Parameters:

settings - where you read your settings.