Index (Maven :: Search API 7.1.2 API)

A B C E F G H I J M N O P Q R S T V
All Classes and Interfaces|All Packages

A

and(Query, Query...) - Static method in class org.apache.maven.search.api.request.BooleanQuery: Creates Logical AND query (requires presence of all queries) out of passed in queries (at least 2 or more should be given).
ARTIFACT_ID - Static variable in class org.apache.maven.search.api.MAVEN: String field for artifact artifactId.

B

BooleanField(String) - Constructor for class org.apache.maven.search.api.request.Field.BooleanField
BooleanQuery - Class in org.apache.maven.search.api.request: Boolean query.
BooleanQuery(Query, String, Query) - Constructor for class org.apache.maven.search.api.request.BooleanQuery
BooleanQuery.And - Class in org.apache.maven.search.api.request

C

CLASS_NAME - Static variable in class org.apache.maven.search.api.MAVEN: String field for artifact contained Java class name.
CLASSIFIER - Static variable in class org.apache.maven.search.api.MAVEN: String field for artifact classifier.
close() - Method in class org.apache.maven.search.api.support.SearchBackendSupport

E

equals(Object) - Method in class org.apache.maven.search.api.request.Field

F

Field - Class in org.apache.maven.search.api.request: Field, that is used as key in record.
Field.BooleanField - Class in org.apache.maven.search.api.request
Field.InstantField - Class in org.apache.maven.search.api.request
Field.NumberField - Class in org.apache.maven.search.api.request
Field.StringField - Class in org.apache.maven.search.api.request
fieldQuery(Field, String) - Static method in class org.apache.maven.search.api.request.FieldQuery: Creates a field query using given Field and query string.
FieldQuery - Class in org.apache.maven.search.api.request: Field query.
FieldQuery(Field, String) - Constructor for class org.apache.maven.search.api.request.FieldQuery
fieldSet() - Method in class org.apache.maven.search.api.Record: Returns unmodifiable set of present fields in this record, never null.
FILE_EXTENSION - Static variable in class org.apache.maven.search.api.MAVEN: String field for artifact file extension.
FQ_CLASS_NAME - Static variable in class org.apache.maven.search.api.MAVEN: String field for artifact contained FQ Java class name.

G

get(String, Map<String, String>) - Method in class org.apache.maven.search.api.transport.Java11HttpClientTransport
get(String, Map<String, String>) - Method in interface org.apache.maven.search.api.transport.Transport: This method should issue HTTP GET requests using serviceUri and return response.
getBackendId() - Method in class org.apache.maven.search.api.Record: Returns SearchBackend.getBackendId() of originating search backend.
getBackendId() - Method in interface org.apache.maven.search.api.SearchBackend: Returns the ID of this backend, never null.
getBackendId() - Method in class org.apache.maven.search.api.support.SearchBackendSupport
getBody() - Method in interface org.apache.maven.search.api.transport.Transport.Response
getCode() - Method in interface org.apache.maven.search.api.transport.Transport.Response
getCurrentHits() - Method in interface org.apache.maven.search.api.SearchResponse: Returns the count of current hits in current "page".
getCurrentHits() - Method in class org.apache.maven.search.api.support.SearchResponseSupport
getField() - Method in class org.apache.maven.search.api.request.FieldQuery: Returns the field, never null.
getFieldName() - Method in class org.apache.maven.search.api.request.Field: Returns the field name.
getFields() - Method in class org.apache.maven.search.api.Record: Returns unmodifiable map of all values keyed by Field backing this record.
getFieldValue(Map<Field, Object>) - Method in class org.apache.maven.search.api.request.Field.BooleanField
getFieldValue(Map<Field, Object>) - Method in class org.apache.maven.search.api.request.Field: Returns the value of the field from given record instance, or null if field not present in record.
getFieldValue(Map<Field, Object>) - Method in class org.apache.maven.search.api.request.Field.InstantField
getFieldValue(Map<Field, Object>) - Method in class org.apache.maven.search.api.request.Field.NumberField
getFieldValue(Map<Field, Object>) - Method in class org.apache.maven.search.api.request.Field.StringField
getHeaders() - Method in interface org.apache.maven.search.api.transport.Transport.Response
getLastUpdated() - Method in class org.apache.maven.search.api.Record: Returns Long, representing "last updated" timestamp as epoch millis if provided by backend.
getLeft() - Method in class org.apache.maven.search.api.request.BooleanQuery: Returns left term of this boolean query, never null.
getPage() - Method in interface org.apache.maven.search.api.SearchResponse: Returns current "page" of results as list of records, never null.
getPage() - Method in class org.apache.maven.search.api.support.SearchResponseSupport
getPageOffset() - Method in class org.apache.maven.search.api.request.Paging: Returns the page offset: a zero or a positive integer.
getPageSize() - Method in class org.apache.maven.search.api.request.Paging: Returns the page size: positive integer, never zero or less.
getPaging() - Method in class org.apache.maven.search.api.SearchRequest: The Paging of this request: defines page size and page offset, never null.
getQuery() - Method in class org.apache.maven.search.api.SearchRequest: The Query of this request, never null.
getRepositoryId() - Method in class org.apache.maven.search.api.Record: Returns SearchBackend.getRepositoryId()) of originating search backend.
getRepositoryId() - Method in interface org.apache.maven.search.api.SearchBackend: Returns the repository ID that this backend searches for, never null.
getRepositoryId() - Method in class org.apache.maven.search.api.support.SearchBackendSupport
getRight() - Method in class org.apache.maven.search.api.request.BooleanQuery: Returns right term of this boolean query, never null.
getSearchRequest() - Method in interface org.apache.maven.search.api.SearchResponse: Returns the SearchRequest used for this response, never null.
getSearchRequest() - Method in class org.apache.maven.search.api.support.SearchResponseSupport
getTotalHits() - Method in interface org.apache.maven.search.api.SearchResponse: Returns the total count of hits produced by SearchResponse.getSearchRequest().
getTotalHits() - Method in class org.apache.maven.search.api.support.SearchResponseSupport
getUid() - Method in class org.apache.maven.search.api.Record: Returns UID (unique if combined with Record.getBackendId()) of search result record, if provided by backend.
getValue() - Method in class org.apache.maven.search.api.request.Query: Returns the query string value, never null.
getValue(Field.BooleanField) - Method in class org.apache.maven.search.api.Record: Returns the value belonging to given field in this record, or null if field not present.
getValue(Field.NumberField) - Method in class org.apache.maven.search.api.Record: Returns the value belonging to given field in this record, or null if field not present.
getValue(Field.StringField) - Method in class org.apache.maven.search.api.Record: Returns the value belonging to given field in this record, or null if field not present.
GROUP_ID - Static variable in class org.apache.maven.search.api.MAVEN: String field for artifact groupId.

H

HAS_GPG_SIGNATURE - Static variable in class org.apache.maven.search.api.MAVEN: Boolean field representing the known presence/absence of artifact GPG signature.
HAS_JAVADOC - Static variable in class org.apache.maven.search.api.MAVEN: Boolean field representing the known presence/absence of artifact Javadoc (is -javadoc.jar present).
HAS_SOURCE - Static variable in class org.apache.maven.search.api.MAVEN: Boolean field representing the known presence/absence of artifact sources (is -sources.jar present).
hasField(Field) - Method in class org.apache.maven.search.api.Record: Returns true if given field is present in this record.
hashCode() - Method in class org.apache.maven.search.api.request.Field
head(String, Map<String, String>) - Method in class org.apache.maven.search.api.transport.Java11HttpClientTransport
head(String, Map<String, String>) - Method in interface org.apache.maven.search.api.transport.Transport: This method should issue HTTP HEAD requests using serviceUri and return response.

I

InstantField(String) - Constructor for class org.apache.maven.search.api.request.Field.InstantField

J

Java11HttpClientTransport - Class in org.apache.maven.search.api.transport: Java 11 HttpClient backed transport.
Java11HttpClientTransport() - Constructor for class org.apache.maven.search.api.transport.Java11HttpClientTransport
Java11HttpClientTransport(Duration) - Constructor for class org.apache.maven.search.api.transport.Java11HttpClientTransport
Java11HttpClientTransport(Duration, HttpClient) - Constructor for class org.apache.maven.search.api.transport.Java11HttpClientTransport

M

MAVEN - Class in org.apache.maven.search.api: The ontology of Apache Maven related fields.

N

nextPage() - Method in class org.apache.maven.search.api.request.Paging: Creates "next page" instance relative to this instance.
nextPage() - Method in class org.apache.maven.search.api.SearchRequest: Returns a new SearchRequest instance for "next page" relative to this instance, never null.
NumberField(String) - Constructor for class org.apache.maven.search.api.request.Field.NumberField

O

org.apache.maven.search.api - package org.apache.maven.search.api
org.apache.maven.search.api.request - package org.apache.maven.search.api.request
org.apache.maven.search.api.support - package org.apache.maven.search.api.support
org.apache.maven.search.api.transport - package org.apache.maven.search.api.transport

P

PACKAGING - Static variable in class org.apache.maven.search.api.MAVEN: String field for artifact packaging.
Paging - Class in org.apache.maven.search.api.request: Paging.
Paging(int) - Constructor for class org.apache.maven.search.api.request.Paging: Creates paging instance with given page size (must be grater than 0) and 0 page offset.
Paging(int, int) - Constructor for class org.apache.maven.search.api.request.Paging: Creates paging instance with given page size (must be greater than 0) and page offset (must be non-negative).

Q

query(String) - Static method in class org.apache.maven.search.api.request.Query: Creates a plain query.
Query - Class in org.apache.maven.search.api.request: Query.
Query(String) - Constructor for class org.apache.maven.search.api.request.Query

R

Record - Class in org.apache.maven.search.api: A search response record.
Record(String, String, String, Long, Map<Field, Object>) - Constructor for class org.apache.maven.search.api.Record

S

search(SearchRequest) - Method in interface org.apache.maven.search.api.SearchEngine: Performs a search with given SearchRequest and returns SearchResponse, never null.
SearchBackend - Interface in org.apache.maven.search.api: An engine to perform search trough single repository index (backend).
SearchBackendSupport - Class in org.apache.maven.search.api.support: A search backend support class.
SearchBackendSupport(String, String) - Constructor for class org.apache.maven.search.api.support.SearchBackendSupport
SearchEngine - Interface in org.apache.maven.search.api: A search engine to perform searches trough configured repository indexes.
SearchRequest - Class in org.apache.maven.search.api: A search request to perform search: defines paging and query.
SearchRequest(Paging, Query) - Constructor for class org.apache.maven.search.api.SearchRequest: Creates a request with given Query and Paging.
SearchRequest(Query) - Constructor for class org.apache.maven.search.api.SearchRequest: Creates a request with given Query instance and default page size of 50.
SearchResponse - Interface in org.apache.maven.search.api: A search engine response.
SearchResponseSupport - Class in org.apache.maven.search.api.support: A search response support class.
SearchResponseSupport(SearchRequest, int, List<Record>) - Constructor for class org.apache.maven.search.api.support.SearchResponseSupport
SHA1 - Static variable in class org.apache.maven.search.api.MAVEN: String field for artifact SHA1 checksum.
StringField(String) - Constructor for class org.apache.maven.search.api.request.Field.StringField

T

toString() - Method in class org.apache.maven.search.api.request.BooleanQuery
toString() - Method in class org.apache.maven.search.api.request.Field
toString() - Method in class org.apache.maven.search.api.request.FieldQuery
toString() - Method in class org.apache.maven.search.api.request.Paging
toString() - Method in class org.apache.maven.search.api.request.Query
toString() - Method in class org.apache.maven.search.api.SearchRequest
toString() - Method in class org.apache.maven.search.api.support.SearchResponseSupport
Transport - Interface in org.apache.maven.search.api.transport: A trivial "transport abstraction" to make possible pluggable implementations.
Transport.Response - Interface in org.apache.maven.search.api.transport: Trivial response.

V

VERSION - Static variable in class org.apache.maven.search.api.MAVEN: String field for artifact version.
VERSION_COUNT - Static variable in class org.apache.maven.search.api.MAVEN: Number field carrying Integer, representing the count of versions for given GA.

A B C E F G H I J M N O P Q R S T V
All Classes and Interfaces|All Packages