Index
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).
- And(Query, Query) - Constructor for class org.apache.maven.search.api.request.BooleanQuery.And
- ARTIFACT_ID - Static variable in class org.apache.maven.search.api.MAVEN
- 
String field for artifact artifactId.
B
- backendId - Variable in class org.apache.maven.search.api.Record
- backendId - Variable in class org.apache.maven.search.api.support.SearchBackendSupport
- 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.
- client - Variable in class org.apache.maven.search.api.transport.Java11HttpClientTransport
- close() - Method in class org.apache.maven.search.api.support.SearchBackendSupport
- close() - Method in class org.apache.maven.search.api.transport.Java11HttpClientTransport.ResponseImpl
E
- equals(Object) - Method in class org.apache.maven.search.api.request.Field
F
- field - Variable in class org.apache.maven.search.api.request.FieldQuery
- Field - Class in org.apache.maven.search.api.request
- 
Field, that is used as key in record.
- Field(String) - Constructor for class org.apache.maven.search.api.request.Field
- 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
- fieldName - Variable in class org.apache.maven.search.api.request.Field
- fieldQuery(Field, String) - Static method in class org.apache.maven.search.api.request.FieldQuery
- 
Creates a field query using givenFieldand 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
- fields - Variable in class org.apache.maven.search.api.Record
- fieldSet() - Method in class org.apache.maven.search.api.Record
- 
Returns unmodifiable set of present fields in this record, nevernull.
- 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 usingserviceUriand return response.
- getBackendId() - Method in class org.apache.maven.search.api.Record
- 
ReturnsSearchBackend.getBackendId()of originating search backend.
- getBackendId() - Method in interface org.apache.maven.search.api.SearchBackend
- 
Returns the ID of this backend, nevernull.
- getBackendId() - Method in class org.apache.maven.search.api.support.SearchBackendSupport
- getBody() - Method in class org.apache.maven.search.api.transport.Java11HttpClientTransport.ResponseImpl
- getBody() - Method in interface org.apache.maven.search.api.transport.Transport.Response
- getCode() - Method in class org.apache.maven.search.api.transport.Java11HttpClientTransport.ResponseImpl
- 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, nevernull.
- 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 byFieldbacking 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, ornullif 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 class org.apache.maven.search.api.transport.Java11HttpClientTransport.ResponseImpl
- getHeaders() - Method in interface org.apache.maven.search.api.transport.Transport.Response
- getLastUpdated() - Method in class org.apache.maven.search.api.Record
- 
ReturnsLong, 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, nevernull.
- getPage() - Method in interface org.apache.maven.search.api.SearchResponse
- 
Returns current "page" of results as list of records, nevernull.
- 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
- 
ThePagingof this request: defines page size and page offset, nevernull.
- getQuery() - Method in class org.apache.maven.search.api.SearchRequest
- 
TheQueryof this request, nevernull.
- getRepositoryId() - Method in class org.apache.maven.search.api.Record
- 
ReturnsSearchBackend.getRepositoryId()) of originating search backend.
- getRepositoryId() - Method in interface org.apache.maven.search.api.SearchBackend
- 
Returns the repository ID that this backend searches for, nevernull.
- 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, nevernull.
- getSearchRequest() - Method in interface org.apache.maven.search.api.SearchResponse
- 
Returns theSearchRequestused for this response, nevernull.
- 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 bySearchResponse.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 withRecord.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, nevernull.
- getValue(Field.BooleanField) - Method in class org.apache.maven.search.api.Record
- 
Returns the value belonging to given field in this record, ornullif 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, ornullif 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, ornullif 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.jarpresent).
- HAS_SOURCE - Static variable in class org.apache.maven.search.api.MAVEN
- 
Boolean field representing the known presence/absence of artifact sources (is-sources.jarpresent).
- hasField(Field) - Method in class org.apache.maven.search.api.Record
- 
Returnstrueif 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 usingserviceUriand return response.
I
- inputStream - Variable in class org.apache.maven.search.api.transport.Java11HttpClientTransport.ResponseImpl
- InstantField(String) - Constructor for class org.apache.maven.search.api.request.Field.InstantField
J
- Java11HttpClientTransport - Class in org.apache.maven.search.api.transport
- 
Java 11HttpClientbacked 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
- Java11HttpClientTransport.ResponseImpl - Class in org.apache.maven.search.api.transport
L
- lastUpdated - Variable in class org.apache.maven.search.api.Record
- left - Variable in class org.apache.maven.search.api.request.BooleanQuery
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 newSearchRequestinstance for "next page" relative to this instance, nevernull.
- 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.
- page - Variable in class org.apache.maven.search.api.support.SearchResponseSupport
- pageOffset - Variable in class org.apache.maven.search.api.request.Paging
- pageSize - Variable in class org.apache.maven.search.api.request.Paging
- paging - Variable in class org.apache.maven.search.api.SearchRequest
- 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 - Variable in class org.apache.maven.search.api.SearchRequest
- 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
- queryString - Variable in 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
- repositoryId - Variable in class org.apache.maven.search.api.Record
- repositoryId - Variable in class org.apache.maven.search.api.support.SearchBackendSupport
- response - Variable in class org.apache.maven.search.api.transport.Java11HttpClientTransport.ResponseImpl
- ResponseImpl(HttpResponse<?>, InputStream) - Constructor for class org.apache.maven.search.api.transport.Java11HttpClientTransport.ResponseImpl
- right - Variable in class org.apache.maven.search.api.request.BooleanQuery
S
- search(SearchRequest) - Method in interface org.apache.maven.search.api.SearchEngine
- 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 - Variable in class org.apache.maven.search.api.support.SearchResponseSupport
- 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
- SearchRequest(Query) - Constructor for class org.apache.maven.search.api.SearchRequest
- 
Creates a request with givenQueryinstance 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
- timeout - Variable in class org.apache.maven.search.api.transport.Java11HttpClientTransport
- 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
- toString() - Method in class org.apache.maven.search.api.transport.Java11HttpClientTransport.ResponseImpl
- totalHits - Variable 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.
U
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 carryingInteger, representing the count of versions for given GA.
All Classes and Interfaces|All Packages