/*
 * Hibernate, Relational Persistence for Idiomatic Java
 *
 * Copyright (c) 2010, Red Hat Inc. or third-party contributors as
 * indicated by the @author tags or express copyright attribution
 * statements applied by the authors.  All third-party contributions are
 * distributed under license by Red Hat Inc.
 *
 * This copyrighted material is made available to anyone wishing to use, modify,
 * copy, or redistribute it subject to the terms and conditions of the GNU
 * Lesser General Public License, as published by the Free Software Foundation.
 *
 * This program 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 distribution; if not, write to:
 * Free Software Foundation, Inc.
 * 51 Franklin Street, Fifth Floor
 * Boston, MA  02110-1301  USA
 */
package org.hibernate.annotations;

import java.lang.annotation.Retention;
import java.lang.annotation.Target;

import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

Collection sort (in-memory sorting).  Different that ordering, which is applied during the SQL select.
Author:
Emmanuel Bernard
See Also:
OrderBy
Deprecated:
Use SortComparator or SortNatural instead depending on need./**
 * Collection sort (in-memory sorting).  Different that ordering, which is applied during the SQL select.
 *
 * @author Emmanuel Bernard
 *
 * @see OrderBy
 *
 * @deprecated Use {@link SortComparator} or {@link SortNatural} instead depending on need.
 */
@Target({METHOD, FIELD})
@Retention(RUNTIME)
@Deprecated
public @interface Sort {
	
The type of sorting to use.  The default is to not use sorting.
/**
	 * The type of sorting to use.  The default is to not use sorting.
	 */
	SortType type() default SortType.UNSORTED;

	
Specifies the comparator to use. Only valid when type specifies SortType.COMPARATOR. TODO find a way to use Class -> see HHH-8164
/**
	 * Specifies the comparator to use.  Only valid when {@link #type} specifies {@link SortType#COMPARATOR}.
	 *
	 * TODO find a way to use Class<Comparator> -> see HHH-8164
	 */
	Class comparator() default void.class;
}