uk.ac.starlink.vo

Enum TapMetaOrder

java.lang.Object

java.lang.Enum<TapMetaOrder>

uk.ac.starlink.vo.TapMetaOrder

All Implemented Interfaces:

Serializable, Comparable<TapMetaOrder>

public enum TapMetaOrder
extends Enum<TapMetaOrder>

Defines an ordering for TAP metadata items: schemas and the tables within them.

Since:

5 Feb 2024

Author:

Mark Taylor

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALPHABETIC Alphabetical ordering.
INDEXED Ordering based on schema/table index (may or may not be reliable).

Method Summary

Modifier and Type	Method and Description
void	sortSchemas(SchemaMeta[] schemas) Modifies a set of schemas to obey this ordering.
static TapMetaOrder	valueOf(String name) Returns the enum constant of this type with the specified name.
static TapMetaOrder[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ALPHABETIC

public static final TapMetaOrder ALPHABETIC

Alphabetical ordering.

INDEXED

public static final TapMetaOrder INDEXED

Ordering based on schema/table index (may or may not be reliable).

Method Detail

values

public static TapMetaOrder[] 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 (TapMetaOrder c : TapMetaOrder.values())
    System.out.println(c);

Returns:

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

valueOf

public static TapMetaOrder 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

sortSchemas

public void sortSchemas(SchemaMeta[] schemas)

Modifies a set of schemas to obey this ordering. The order of the elements of the supplied array may change in place, and the ordering of tables within each one may also change.

Parameters:

schemas - array of schemas to alter in place