jpaoletti.jpm.menu.MenuItemLocation Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jpm-core Show documentation

Core module for jpm

The newest version!

package jpaoletti.jpm.menu;

/**
 * This simple interface represents a MenuItem location, that is "where should 
 * this item points in the menu?" This is an abstraction of a location, and must
 * be implemented on each PM implementation.
 *   
 *  * {@code
 *         
 *             
 *             ...
 *         
 * }
 * 
 * 
 * Each implementation of this interface must be defined in a location file with the id and class
 * that implements this interface. The idea is that each location builds its own "pointer" on each
 * menu leaf.
 * 
 * The configuration file for locations has this general form:
 * 
 *  * {@code
 * 
 * 
 * 
 *     
 *     
 *     ...
 * 
 * }
 *  
 * 
 * @author jpaoletti
 * */
public interface MenuItemLocation {

    /**
     * Builds a custom representation of the goal of a menu item
     * @param item The menu item
     * @param params Generic parameters.
     * @return The representation of the link
     */
    public Object build(MenuItem item, Object... params);
}