org.apache.maven.index.reader

Enum Record.Type

java.lang.Object

java.lang.Enum<Record.Type>

org.apache.maven.index.reader.Record.Type

All Implemented Interfaces:

Serializable, Comparable<Record.Type>

Enclosing class:

Record

public static enum Record.Type
extends Enum<Record.Type>

Types of returned records returned from index.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL_GROUPS Special record, containing all the Maven "groupId"s that are enlisted on the index.
ARTIFACT_ADD Artifact ADD record.
ARTIFACT_REMOVE Artifact REMOVE record.
DESCRIPTOR Descriptor record.
ROOT_GROUPS Special record, containing all the root groups of Maven "groupId"s that are enlisted on the index.

Method Summary

Modifier and Type	Method and Description
static Record.Type	valueOf(String name) Returns the enum constant of this type with the specified name.
static Record.Type[]	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

DESCRIPTOR

public static final Record.Type DESCRIPTOR

Descriptor record. Can be safely ignored. Contains following entries:

• Record.REPOSITORY_ID

ARTIFACT_ADD

public static final Record.Type ARTIFACT_ADD

Artifact ADD record. Records of this type should be added to your indexing system. Contains following entries:

• Record.REC_MODIFIED (when record was added/modified on index)
• Record.GROUP_ID
• Record.ARTIFACT_ID
• Record.VERSION
• Record.CLASSIFIER (optional)
• Record.FILE_EXTENSION
• Record.FILE_MODIFIED
• Record.FILE_SIZE
• Record.PACKAGING
• Record.HAS_SOURCES
• Record.HAS_JAVADOC
• Record.HAS_SIGNATURE
• Record.NAME
• Record.DESCRIPTION
• Record.SHA1
• Record.CLASSNAMES (optional)
• Record.PLUGIN_PREFIX (optional, for maven-plugins only)
• Record.PLUGIN_GOALS (optional, for maven-plugins only)

ARTIFACT_REMOVE

public static final Record.Type ARTIFACT_REMOVE

Artifact REMOVE record. In case of incremental updates, signals that this artifact was removed. Records of this type should be removed from your indexing system. Contains following entries:

• Record.REC_MODIFIED (when record was deleted from index)
• Record.GROUP_ID
• Record.ARTIFACT_ID
• Record.VERSION
• Record.CLASSIFIER (optional)
• Record.FILE_EXTENSION (if Record.CLASSIFIER present)
• Record.PACKAGING (optional)

ALL_GROUPS

public static final Record.Type ALL_GROUPS

Special record, containing all the Maven "groupId"s that are enlisted on the index. Can be safely ignored. Contains following entries:

• ALL_GROUPS

ROOT_GROUPS

public static final Record.Type ROOT_GROUPS

Special record, containing all the root groups of Maven "groupId"s that are enlisted on the index. Can be safely ignored. Contains following entries:

• ROOT_GROUPS

Method Detail

values

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

Returns:

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

valueOf

public static Record.Type 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