org.semanticweb.owlapi.model

Enum PriorityCollectionSorting

java.lang.Object

java.lang.Enum<PriorityCollectionSorting>

org.semanticweb.owlapi.model.PriorityCollectionSorting

All Implemented Interfaces:

Serializable, Comparable<PriorityCollectionSorting>, ByName<PriorityCollectionSorting>

public enum PriorityCollectionSorting
extends Enum<PriorityCollectionSorting>
implements ByName<PriorityCollectionSorting>

Specifies how PriorityCollection should sort its entries.

Since:

4.0.2

Author:

Ignazio

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALWAYS Always keep the collection sorted by HasPriority annotation values.
NEVER Sorting of entries is disabled.
ON_SET_INJECTION_ONLY Only sort according to HasPriority annotation when a Set is passed in, do not sort otherwise.

Method Summary

Modifier and Type	Method and Description
PriorityCollectionSorting	byName(CharSequence name)
abstract <O> List<O>	sort(List<O> list)
abstract <O> List<O>	sortInputSet(List<O> list)
static PriorityCollectionSorting	valueOf(String name) Returns the enum constant of this type with the specified name.
static PriorityCollectionSorting[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ALWAYS

public static final PriorityCollectionSorting ALWAYS

Always keep the collection sorted by HasPriority annotation values.

ON_SET_INJECTION_ONLY

public static final PriorityCollectionSorting ON_SET_INJECTION_ONLY

Only sort according to HasPriority annotation when a Set is passed in, do not sort otherwise. This allows for fine tuning of the order in which entries appear, but does not lose the default prioritisation. This is important for parsers. When this sorting is used, addition of new elements causes the elements to be added at the front of the collection (First In, First Out)

NEVER

public static final PriorityCollectionSorting NEVER

Sorting of entries is disabled. When this sorting is used, addition of new elements causes the elements to be added at the front of the collection (First In, First Out)

Method Detail

values

public static PriorityCollectionSorting[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (PriorityCollectionSorting c : PriorityCollectionSorting.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static PriorityCollectionSorting valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

sort

public abstract <O> List<O> sort(List<O> list)

Type Parameters:

O - type of elements

Parameters:

list - list to sort

Returns:

sorted list

sortInputSet

public abstract <O> List<O> sortInputSet(List<O> list)

Type Parameters:

O - type of elements

Parameters:

list - list to sort

Returns:

sorted list

byName

public PriorityCollectionSorting byName(CharSequence name)

Specified by:

byName in interface ByName<PriorityCollectionSorting>

Parameters:

name - the name to map to an object

Returns:

the object associated with name