com.communote.common.menu

Class EntryIdIncludeExcludeFilter<T extends MenuEntry>

java.lang.Object

com.communote.common.menu.EntryIdIncludeExcludeFilter<T>

Type Parameters:

T - type of the menu entry this filter handles

All Implemented Interfaces:

MenuEntryFilter<T>

Direct Known Subclasses:

GlobalClientFilter, HttpsSupportFilter

public abstract class EntryIdIncludeExcludeFilter<T extends MenuEntry>
extends Object
implements MenuEntryFilter<T>

Base class to implement a filter which includes or excludes an entry if a condition is met. The entries are identified by the ID.

Author:

Communote GmbH - http://www.communote.com/

Constructor Summary

Constructors

Constructor and Description
EntryIdIncludeExcludeFilter()

Method Summary

Modifier and Type	Method and Description
void	addEntryToExclude(String entryId) Add the ID of an entry that should only be included if the condition is not fulfilled If the same ID was also added via addEntryToInclude(String) the inclusion takes precedence.
void	addEntryToInclude(String entryId) Add the ID of an entry that should only be included if the condition is fulfilled
boolean	include(T entry) Whether the menu entry should be included in the menu
void	removeEntryToExclude(String entryId) Remove a previously added entry ID from those that should be excluded.
void	removeEntryToInclude(String entryId) Remove a previously added entry ID from those that should be included.
protected abstract boolean	testCondition(T entry) Test the condition and return true if the condition is fulfilled.

Methods inherited from class java.lang.Object

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

Constructor Detail

EntryIdIncludeExcludeFilter

public EntryIdIncludeExcludeFilter()

Method Detail

addEntryToExclude

public void addEntryToExclude(String entryId)

Add the ID of an entry that should only be included if the condition is not fulfilled If the same ID was also added via addEntryToInclude(String) the inclusion takes precedence.

Parameters:

entryId - the ID of the entry to check

addEntryToInclude

public void addEntryToInclude(String entryId)

Add the ID of an entry that should only be included if the condition is fulfilled

Parameters:

entryId - the ID of the entry to check

include

public boolean include(T entry)

Description copied from interface: MenuEntryFilter

Whether the menu entry should be included in the menu

Specified by:

include in interface MenuEntryFilter<T extends MenuEntry>

Parameters:

entry - the entry to test

Returns:

true if the condition is fulfilled and the ID of the entry was added to the includes or the condition is fulfilled and the ID of the entry was added to the includes. Also returns true if the ID of the entry was not added as inclusion or exclusion.

removeEntryToExclude

public void removeEntryToExclude(String entryId)

Remove a previously added entry ID from those that should be excluded.

Parameters:

entryId - the ID of the entry

removeEntryToInclude

public void removeEntryToInclude(String entryId)

Remove a previously added entry ID from those that should be included.

Parameters:

entryId - the ID of the entry

testCondition

protected abstract boolean testCondition(T entry)

Test the condition and return true if the condition is fulfilled.

Parameters:

entry - the entry to test

Returns:

true if the condition is fulfilled