MenuBuilder.java

/*******************************************************************************
 * Copyright (c) 2012 OpenLegacy Inc.
 * All rights reserved. This program and the accompanying materials 
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 * 
 * Contributors:
 *     OpenLegacy Inc. - initial API and implementation
 *******************************************************************************/
package org.openlegacy.modules.menu;

import org.openlegacy.modules.menu.Menu.MenuEntity;

/**
 * Defines a menu builder logic. A menu builder builds a {@link MenuItem} and it's child nodes, from a given {@link MenuEntity}
 * class, or from root if not specified.
 * 
 * @author Roi Mor
 * 
 */
public interface MenuBuilder {

	/**
	 * Retrieve a menu tree from the given menu class
	 * 
	 * @param menuEntityClass
	 * @return menu tree from the given menu class
	 */
	MenuItem getMenuTree(Class<?> menuEntityClass);

	/**
	 * Find the root menu and retrieve a full menu tree
	 * 
	 * @return menu tree from root
	 */
	MenuItem getMenuTree();
}