SortKeyAware.java

/*
 * SortKeyAware.java
 * Copyright James Dempsey, 2012
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 *
 * Created on 13/10/2012 10:09:02 PM
 *
 * $Id$
 */
package pcgen.util;

/**
 * The Class {@code SortKeyAware} identifies a class which can return its
 * sort key. That is the text to be used for sorting, which may be different 
 * from the text used to display the item.
 *
 * <br>
 * 
 * @author James Dempsey <jdempsey@users.sourceforge.net>
 */
@FunctionalInterface
public interface SortKeyAware
{

	/**
	 * @return The sort key for this object.
	 */
	public String getSortKey();

}