Package com.foreach.across.modules.web.menu

Class PathBasedMenuBuilder.PathBasedMenuItemBuilder

java.lang.Object

com.foreach.across.modules.web.menu.PathBasedMenuBuilder.PathBasedMenuItemBuilder

All Implemented Interfaces:

Comparable<PathBasedMenuBuilder.PathBasedMenuItemBuilder>

Enclosing class:

PathBasedMenuBuilder

public static final class PathBasedMenuBuilder.PathBasedMenuItemBuilder
extends Object
implements Comparable<PathBasedMenuBuilder.PathBasedMenuItemBuilder>

Represents a single item builder attached to a parent PathBasedMenuBuilder.

Method Summary

Modifier and Type	Method	Description
PathBasedMenuBuilder	and()	Go up a level, switch from the item builder back to the menu builder.
PathBasedMenuBuilder.PathBasedMenuItemBuilder	attribute(@NonNull Consumer<Map<String,Object>> attributeRegistrar)	Apply an attribute registrar to the collection of attributes for this menu item.
PathBasedMenuBuilder.PathBasedMenuItemBuilder	attribute(String key, Object value)	Add a single attribute to this menu item.
PathBasedMenuBuilder.PathBasedMenuItemBuilder	changePathTo(@NonNull String newPath)	Change the path of this menu item, as well as all other items that have the current path as a prefix.
PathBasedMenuBuilder.PathBasedMenuItemBuilder	changePathTo(@NonNull String newPath, boolean replaceAllItemsWithPrefix)	Change the path of this menu item, optionally changing other items that have the current path as a prefix.
PathBasedMenuBuilder.PathBasedMenuItemBuilder	comparator(Comparator<Menu> comparator, boolean inheritable)	Set the comparator to be used when sorting the children of this menu item.
int	compareTo(PathBasedMenuBuilder.PathBasedMenuItemBuilder o)
PathBasedMenuBuilder.PathBasedMenuItemBuilder	disable()	Flag this menu item as disabled.
PathBasedMenuBuilder.PathBasedMenuItemBuilder	disable(boolean status)	Flag this menu item as disabled or enabled.
PathBasedMenuBuilder.PathBasedMenuItemBuilder	enable()	Flag this menu item as enabled.
PathBasedMenuBuilder.PathBasedMenuItemBuilder	enable(boolean status)	Flag this menu item as disabled or enabled.
boolean	equals(Object o)
PathBasedMenuBuilder.PathBasedMenuItemBuilder	group(boolean group)	Set the 'group' flag on the menu item.
int	hashCode()
PathBasedMenuBuilder.PathBasedMenuItemBuilder	matchRequests(String... matchers)	Add prefix strings on which this menu item will match in case a RequestMenuSelector is being used.
PathBasedMenuBuilder.PathBasedMenuItemBuilder	options(String... options)	Add one or more option attributes to this menu item.
PathBasedMenuBuilder.PathBasedMenuItemBuilder	order(int order)	Set the order of this menu item.
PathBasedMenuBuilder	remove(boolean removeAllItemsWithPrefix)	Remove this item.
PathBasedMenuBuilder.PathBasedMenuItemBuilder	removeAttributes(String... keys)	Remove the attributes with the given keys.
PathBasedMenuBuilder.PathBasedMenuItemBuilder	title(String title)	Set the title for this menu item.
String	toString()
PathBasedMenuBuilder.PathBasedMenuItemBuilder	url(String url)	Set the url for this menu item.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

comparator

public PathBasedMenuBuilder.PathBasedMenuItemBuilder comparator(Comparator<Menu> comparator,
 boolean inheritable)

Set the comparator to be used when sorting the children of this menu item. If the comparator is inheritable, it will also be used for the sub-menus in the resulting tree, unless they have another comparator set explicitly.

Note that depending on the custom comparator you set, the value of order(int) might be ignored.

Parameters:

comparator - to use

inheritable - should the comparator also apply to any resulting sub-menus of this item

Returns:

current builder

order

public PathBasedMenuBuilder.PathBasedMenuItemBuilder order(int order)

Set the order of this menu item.

Returns:

current item builder

disable

public PathBasedMenuBuilder.PathBasedMenuItemBuilder disable()

Flag this menu item as disabled.

Returns:

current item builder

enable

public PathBasedMenuBuilder.PathBasedMenuItemBuilder enable()

Flag this menu item as enabled.

Returns:

current item builder

disable

public PathBasedMenuBuilder.PathBasedMenuItemBuilder disable(boolean status)

Flag this menu item as disabled or enabled.

Parameters:

status - disabled or not

Returns:

current item builder

enable

public PathBasedMenuBuilder.PathBasedMenuItemBuilder enable(boolean status)

Flag this menu item as disabled or enabled.

Parameters:

status - enabled or not

Returns:

current item builder

attribute

public PathBasedMenuBuilder.PathBasedMenuItemBuilder attribute(String key,
 Object value)

Add a single attribute to this menu item.

Parameters:

key - attribute key

value - attribute value

Returns:

current item builder

attribute

public PathBasedMenuBuilder.PathBasedMenuItemBuilder attribute(@NonNull
 @NonNull Consumer<Map<String,Object>> attributeRegistrar)

Apply an attribute registrar to the collection of attributes for this menu item.

Parameters:

attributeRegistrar - to execute

Returns:

current item builder

options

public PathBasedMenuBuilder.PathBasedMenuItemBuilder options(String... options)

Add one or more option attributes to this menu item. An option attribute is an attribute where the key is identical to the value. For every argument X, an attribute with key X and value X will be added.

Parameters:

options - to add

Returns:

current item builder

removeAttributes

public PathBasedMenuBuilder.PathBasedMenuItemBuilder removeAttributes(String... keys)

Remove the attributes with the given keys.

Parameters:

keys - of the attributes to remove

Returns:

current item builder

matchRequests

public PathBasedMenuBuilder.PathBasedMenuItemBuilder matchRequests(String... matchers)

Add prefix strings on which this menu item will match in case a RequestMenuSelector is being used. If the request starts with any of these prefixes, this menu item will be selected.

These values only apply if the selector supports it. This is usually the case for menus being built through the MenuFactory using a RequestMenuBuilder behind the scened.

Parameters:

matchers - one or more prefix strings

See Also:

• RequestMenuSelector

remove

public PathBasedMenuBuilder remove(boolean removeAllItemsWithPrefix)

Remove this item. Optionally removing all other items with this path as prefix. This method returns the menu builder that this item belonged to, destroying the item builder.

Parameters:

removeAllItemsWithPrefix - true if all other items having this prefix should also be removed

Returns:

menu builder

changePathTo

public PathBasedMenuBuilder.PathBasedMenuItemBuilder changePathTo(@NonNull
 @NonNull String newPath)

Change the path of this menu item, as well as all other items that have the current path as a prefix. This path change will happen immediately and after this call a new item can be created on the previous path.

If you only want to change the path of the current item but not all other items starting with this path, use changePathTo("new path", false).

Parameters:

newPath - new path that should be used

Returns:

current item builder

See Also:

• changePathTo(String, boolean)

changePathTo

public PathBasedMenuBuilder.PathBasedMenuItemBuilder changePathTo(@NonNull
 @NonNull String newPath,
 boolean replaceAllItemsWithPrefix)

Change the path of this menu item, optionally changing other items that have the current path as a prefix. This path change will happen immediately and after this call a new item can be created on the previous path.

Parameters:

newPath - new path that should be used

replaceAllItemsWithPrefix - false if only the current item should have its path changed

Returns:

current item builder

See Also:

• changePathTo(String, boolean)

and

public PathBasedMenuBuilder and()

Go up a level, switch from the item builder back to the menu builder.

Returns:

menu builder this item belongs to

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

compareTo

public int compareTo(PathBasedMenuBuilder.PathBasedMenuItemBuilder o)

Specified by:

compareTo in interface Comparable<PathBasedMenuBuilder.PathBasedMenuItemBuilder>

toString

public String toString()

Overrides:

toString in class Object

group

public PathBasedMenuBuilder.PathBasedMenuItemBuilder group(boolean group)

Set the 'group' flag on the menu item.

Returns:

this.

title

public PathBasedMenuBuilder.PathBasedMenuItemBuilder title(String title)

Set the title for this menu item.

Returns:

this.

url

public PathBasedMenuBuilder.PathBasedMenuItemBuilder url(String url)

Set the url for this menu item.

Returns:

this.