Record (Maven :: Indexer Reader 6.0.0 API)

java.lang.Object
- org.apache.maven.index.reader.Record

public final class Record
extends Object

Maven 2 Index record.

Since:: 5.1.2

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Record.EntryKey<T>` Entry key is field key with some metadata.
`static class`	`Record.Type` Types of returned records returned from index.

Field Summary

Fields
Modifier and Type	Field and Description
`static Record.EntryKey<String[]>`	`ALL_GROUPS` Key of all groups list entry, that contains `List<String>`.
`static Record.EntryKey<String>`	`ARTIFACT_ID` Key of artifact artifactId entry, that contains `String`.
`static Record.EntryKey<String>`	`CLASSIFIER` Key of artifact classifier entry, that contains `String`.
`static Record.EntryKey<String[]>`	`CLASSNAMES` Key of artifact contained class names, that contains `List<String>`.
`static Record.EntryKey<String>`	`DESCRIPTION` Key of artifact description (as set in POM), that contains `String`.
`static Record.EntryKey<String>`	`FILE_EXTENSION` Key of artifact file extension, that contains `String`.
`static Record.EntryKey<Long>`	`FILE_MODIFIED` Key of artifact file last modified timestamp, that contains `Long`.
`static Record.EntryKey<Long>`	`FILE_SIZE` Key of artifact file size in bytes, that contains `Long`.
`static Record.EntryKey<String>`	`GROUP_ID` Key of artifact groupId entry, that contains `String`.
`static Record.EntryKey<Boolean>`	`HAS_JAVADOC` Key of artifact Javadoc presence flag, that contains `Boolean`.
`static Record.EntryKey<Boolean>`	`HAS_SIGNATURE` Key of artifact signature presence flag, that contains `Boolean`.
`static Record.EntryKey<Boolean>`	`HAS_SOURCES` Key of artifact Sources presence flag, that contains `Boolean`.
`static Record.EntryKey<String>`	`NAME` Key of artifact name (as set in POM), that contains `String`.
`static Record.EntryKey<String>`	`OSGI_BREE` Key of deprecated OSGi "Bundle-RequiredExecutionEnvironment" manifest entry, that contains `String`.
`static Record.EntryKey<String>`	`OSGI_BUNDLE_DESCRIPTION` Key of OSGi "Bundle-Description" manifest entry, that contains `String`.
`static Record.EntryKey<String>`	`OSGI_BUNDLE_LICENSE` Key of OSGi "Bundle-License" manifest entry, that contains `String`.
`static Record.EntryKey<String>`	`OSGI_BUNDLE_NAME` Key of OSGi "Bundle-Name" manifest entry, that contains `String`.
`static Record.EntryKey<String>`	`OSGI_BUNDLE_SYMBOLIC_NAME` Key of OSGi "Bundle-SymbolicName" manifest entry, that contains `String`.
`static Record.EntryKey<String>`	`OSGI_BUNDLE_VERSION` Key of OSGi "Bundle-Version" manifest entry, that contains `String`.
`static Record.EntryKey<String>`	`OSGI_EXPORT_DOCURL` Key of OSGi "Bundle-DocURL" manifest entry, that contains `String`.
`static Record.EntryKey<String>`	`OSGI_EXPORT_PACKAGE` Key of OSGi "Export-Package" manifest entry, that contains `String`.
`static Record.EntryKey<String>`	`OSGI_EXPORT_SERVICE` Key of OSGi "Export-Service" manifest entry, that contains `String`.
`static Record.EntryKey<String>`	`OSGI_FRAGMENT_HOST` Key of OSGi "Fragment-Host" manifest entry, that contains `String`.
`static Record.EntryKey<String>`	`OSGI_IMPORT_PACKAGE` Key of OSGi "Import-Package" manifest entry, that contains `String`.
`static Record.EntryKey<String>`	`OSGI_PROVIDE_CAPABILITY` Key of OSGi "Provide-Capability" manifest entry, that contains `String`.
`static Record.EntryKey<String>`	`OSGI_REQUIRE_BUNDLE` Key of OSGi "Require-Bundle" manifest entry, that contains `String`.
`static Record.EntryKey<String>`	`OSGI_REQUIRE_CAPABILITY` Key of OSGi "Require-Capability" manifest entry, that contains `String`.
`static Record.EntryKey<String>`	`PACKAGING` Key of artifact packaging entry, that contains `String`.
`static Record.EntryKey<String[]>`	`PLUGIN_GOALS` Key of plugin artifact goals, that contains `List<String>`.
`static Record.EntryKey<String>`	`PLUGIN_PREFIX` Key of plugin artifact prefix, that contains `String`.
`static Record.EntryKey<Long>`	`REC_MODIFIED` Key of index record modification (added to index or removed from index) timestamp entry, that contains `Long`.
`static Record.EntryKey<String>`	`REPOSITORY_ID` Key of repository ID entry, that contains `String`.
`static Record.EntryKey<String[]>`	`ROOT_GROUPS` Key of root groups list entry, that contains `List<String>`.
`static Record.EntryKey<String>`	`SHA_256` Key for SHA-256 checksum needed for OSGI content capability that contains `String`.
`static Record.EntryKey<String>`	`SHA1` Key of artifact SHA1 digest, that contains `String`.
`static Record.EntryKey<String>`	`VERSION` Key of artifact version entry, that contains `String`.

Constructor Summary

Constructors
Constructor and Description

Record(Record.Type type, Map<Record.EntryKey,Object> expanded)

Constructors
Constructor and Description
`Record(Record.Type type, Map<Record.EntryKey,Object> expanded)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<T> T`	`get(Record.EntryKey<T> entryKey)` Type safe handy method to get value from expanded map.
`Map<Record.EntryKey,Object>`	`getExpanded()` Returns the expanded (processed and expanded synthetic fields) record as `Map` ready for consumption.
`Record.Type`	`getType()` Returns the `Record.Type` of this record.
`<T> T`	`put(Record.EntryKey<T> entryKey, T value)` Type safe handy method to put value to expanded map.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - REPOSITORY_ID
```
public static final Record.EntryKey<String> REPOSITORY_ID
```
    Key of repository ID entry, that contains String.
  - ALL_GROUPS
```
public static final Record.EntryKey<String[]> ALL_GROUPS
```
    Key of all groups list entry, that contains List<String>.
  - ROOT_GROUPS
```
public static final Record.EntryKey<String[]> ROOT_GROUPS
```
    Key of root groups list entry, that contains List<String>.
  - REC_MODIFIED
```
public static final Record.EntryKey<Long> REC_MODIFIED
```
    Key of index record modification (added to index or removed from index) timestamp entry, that contains Long.
  - GROUP_ID
```
public static final Record.EntryKey<String> GROUP_ID
```
    Key of artifact groupId entry, that contains String.
  - ARTIFACT_ID
```
public static final Record.EntryKey<String> ARTIFACT_ID
```
    Key of artifact artifactId entry, that contains String.
  - VERSION
```
public static final Record.EntryKey<String> VERSION
```
    Key of artifact version entry, that contains String.
  - CLASSIFIER
```
public static final Record.EntryKey<String> CLASSIFIER
```
    Key of artifact classifier entry, that contains String.
  - PACKAGING
```
public static final Record.EntryKey<String> PACKAGING
```
    Key of artifact packaging entry, that contains String.
  - FILE_EXTENSION
```
public static final Record.EntryKey<String> FILE_EXTENSION
```
    Key of artifact file extension, that contains String.
  - FILE_MODIFIED
```
public static final Record.EntryKey<Long> FILE_MODIFIED
```
    Key of artifact file last modified timestamp, that contains Long.
  - FILE_SIZE
```
public static final Record.EntryKey<Long> FILE_SIZE
```
    Key of artifact file size in bytes, that contains Long.
  - HAS_SOURCES
```
public static final Record.EntryKey<Boolean> HAS_SOURCES
```
    Key of artifact Sources presence flag, that contains Boolean.
  - HAS_JAVADOC
```
public static final Record.EntryKey<Boolean> HAS_JAVADOC
```
    Key of artifact Javadoc presence flag, that contains Boolean.
  - HAS_SIGNATURE
```
public static final Record.EntryKey<Boolean> HAS_SIGNATURE
```
    Key of artifact signature presence flag, that contains Boolean.
  - NAME
```
public static final Record.EntryKey<String> NAME
```
    Key of artifact name (as set in POM), that contains String.
  - DESCRIPTION
```
public static final Record.EntryKey<String> DESCRIPTION
```
    Key of artifact description (as set in POM), that contains String.
  - SHA1
```
public static final Record.EntryKey<String> SHA1
```
    Key of artifact SHA1 digest, that contains String.
  - CLASSNAMES
```
public static final Record.EntryKey<String[]> CLASSNAMES
```
    Key of artifact contained class names, that contains List<String>. Extracted by JarFileContentsIndexCreator.
  - PLUGIN_PREFIX
```
public static final Record.EntryKey<String> PLUGIN_PREFIX
```
    Key of plugin artifact prefix, that contains String. Extracted by MavenPluginArtifactInfoIndexCreator.
  - PLUGIN_GOALS
```
public static final Record.EntryKey<String[]> PLUGIN_GOALS
```
    Key of plugin artifact goals, that contains List<String>. Extracted by MavenPluginArtifactInfoIndexCreator.
  - OSGI_BUNDLE_SYMBOLIC_NAME
```
public static final Record.EntryKey<String> OSGI_BUNDLE_SYMBOLIC_NAME
```
    Key of OSGi "Bundle-SymbolicName" manifest entry, that contains String. Extracted by OsgiArtifactIndexCreator.
  - OSGI_BUNDLE_VERSION
```
public static final Record.EntryKey<String> OSGI_BUNDLE_VERSION
```
    Key of OSGi "Bundle-Version" manifest entry, that contains String. Extracted by OsgiArtifactIndexCreator.
  - OSGI_EXPORT_PACKAGE
```
public static final Record.EntryKey<String> OSGI_EXPORT_PACKAGE
```
    Key of OSGi "Export-Package" manifest entry, that contains String. Extracted by OsgiArtifactIndexCreator.
  - OSGI_EXPORT_SERVICE
```
public static final Record.EntryKey<String> OSGI_EXPORT_SERVICE
```
    Key of OSGi "Export-Service" manifest entry, that contains String. Extracted by OsgiArtifactIndexCreator.
  - OSGI_BUNDLE_DESCRIPTION
```
public static final Record.EntryKey<String> OSGI_BUNDLE_DESCRIPTION
```
    Key of OSGi "Bundle-Description" manifest entry, that contains String. Extracted by OsgiArtifactIndexCreator.
  - OSGI_BUNDLE_NAME
```
public static final Record.EntryKey<String> OSGI_BUNDLE_NAME
```
    Key of OSGi "Bundle-Name" manifest entry, that contains String. Extracted by OsgiArtifactIndexCreator.
  - OSGI_BUNDLE_LICENSE
```
public static final Record.EntryKey<String> OSGI_BUNDLE_LICENSE
```
    Key of OSGi "Bundle-License" manifest entry, that contains String. Extracted by OsgiArtifactIndexCreator.
  - OSGI_EXPORT_DOCURL
```
public static final Record.EntryKey<String> OSGI_EXPORT_DOCURL
```
    Key of OSGi "Bundle-DocURL" manifest entry, that contains String. Extracted by OsgiArtifactIndexCreator.
  - OSGI_IMPORT_PACKAGE
```
public static final Record.EntryKey<String> OSGI_IMPORT_PACKAGE
```
    Key of OSGi "Import-Package" manifest entry, that contains String. Extracted by OsgiArtifactIndexCreator.
  - OSGI_REQUIRE_BUNDLE
```
public static final Record.EntryKey<String> OSGI_REQUIRE_BUNDLE
```
    Key of OSGi "Require-Bundle" manifest entry, that contains String. Extracted by OsgiArtifactIndexCreator.
  - OSGI_PROVIDE_CAPABILITY
```
public static final Record.EntryKey<String> OSGI_PROVIDE_CAPABILITY
```
    Key of OSGi "Provide-Capability" manifest entry, that contains String. Extracted by OsgiArtifactIndexCreator.
  - OSGI_REQUIRE_CAPABILITY
```
public static final Record.EntryKey<String> OSGI_REQUIRE_CAPABILITY
```
    Key of OSGi "Require-Capability" manifest entry, that contains String. Extracted by OsgiArtifactIndexCreator.
  - OSGI_FRAGMENT_HOST
```
public static final Record.EntryKey<String> OSGI_FRAGMENT_HOST
```
    Key of OSGi "Fragment-Host" manifest entry, that contains String. Extracted by OsgiArtifactIndexCreator.
  - OSGI_BREE
```
public static final Record.EntryKey<String> OSGI_BREE
```
    Key of deprecated OSGi "Bundle-RequiredExecutionEnvironment" manifest entry, that contains String. Extracted by OsgiArtifactIndexCreator.
  - SHA_256
```
public static final Record.EntryKey<String> SHA_256
```
    Key for SHA-256 checksum needed for OSGI content capability that contains String. Extracted by OsgiArtifactIndexCreator.
- Constructor Detail
  - Record
```
public Record(Record.Type type,
              Map<Record.EntryKey,Object> expanded)
```
- Method Detail
  - getType
```
public Record.Type getType()
```
    Returns the Record.Type of this record. Usually users would be interested in Record.Type.ARTIFACT_ADD and Record.Type.ARTIFACT_REMOVE types only to maintain their own index. Still, indexer offers extra records too, see Record.Type for all existing types.
  - getExpanded
```
public Map<Record.EntryKey,Object> getExpanded()
```
    Returns the expanded (processed and expanded synthetic fields) record as Map ready for consumption.
  - get
```
public <T> T get(Record.EntryKey<T> entryKey)
```
    Type safe handy method to get value from expanded map.
  - put
```
public <T> T put(Record.EntryKey<T> entryKey,
                 T value)
```
    Type safe handy method to put value to expanded map. Accepts null values, that removes the mapping.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Record

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

REPOSITORY_ID

ALL_GROUPS

ROOT_GROUPS

REC_MODIFIED

GROUP_ID

ARTIFACT_ID

VERSION

CLASSIFIER

PACKAGING

FILE_EXTENSION

FILE_MODIFIED

FILE_SIZE

HAS_SOURCES

HAS_JAVADOC

HAS_SIGNATURE

NAME

DESCRIPTION

SHA1

CLASSNAMES

PLUGIN_PREFIX

PLUGIN_GOALS

OSGI_BUNDLE_SYMBOLIC_NAME

OSGI_BUNDLE_VERSION

OSGI_EXPORT_PACKAGE

OSGI_EXPORT_SERVICE

OSGI_BUNDLE_DESCRIPTION

OSGI_BUNDLE_NAME

OSGI_BUNDLE_LICENSE

OSGI_EXPORT_DOCURL

OSGI_IMPORT_PACKAGE

OSGI_REQUIRE_BUNDLE

OSGI_PROVIDE_CAPABILITY

OSGI_REQUIRE_CAPABILITY

OSGI_FRAGMENT_HOST

OSGI_BREE

SHA_256

Constructor Detail

Record

Method Detail

getType

getExpanded

get

put

toString