Package org.apache.maven.search.api

Class Record

java.lang.Object

org.apache.maven.search.api.Record

public final class Record
extends Object

A search response record.

Constructor Summary

Constructors

Constructor	Description
Record(String backendId, String repositoryId, String uid, Long lastUpdated, Map<Field,Object> fields)

Method Summary

Modifier and Type	Method	Description
Set<Field>	fieldSet()	Returns unmodifiable set of present fields in this record, never null.
String	getBackendId()	Returns SearchBackend.getBackendId() of originating search backend.
Map<Field,Object>	getFields()	Returns unmodifiable map of all values keyed by Field backing this record.
Long	getLastUpdated()	Returns Long, representing "last updated" timestamp as epoch millis if provided by backend.
String	getRepositoryId()	Returns SearchBackend.getRepositoryId()) of originating search backend.
String	getUid()	Returns UID (unique if combined with getBackendId()) of search result record, if provided by backend.
Boolean	getValue(Field.BooleanField field)	Returns the value belonging to given field in this record, or null if field not present.
Number	getValue(Field.NumberField field)	Returns the value belonging to given field in this record, or null if field not present.
String	getValue(Field.StringField field)	Returns the value belonging to given field in this record, or null if field not present.
boolean	hasField(Field field)	Returns true if given field is present in this record.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Record

public Record(String backendId,
 String repositoryId,
 String uid,
 Long lastUpdated,
 Map<Field,Object> fields)

Method Details

getBackendId

public String getBackendId()

Returns SearchBackend.getBackendId() of originating search backend. Never null.

getRepositoryId

public String getRepositoryId()

Returns SearchBackend.getRepositoryId()) of originating search backend. Never null.

getUid

public String getUid()

Returns UID (unique if combined with getBackendId()) of search result record, if provided by backend. May be null if not provided.

getLastUpdated

public Long getLastUpdated()

Returns Long, representing "last updated" timestamp as epoch millis if provided by backend. May be null if not provided.

getFields

public Map<Field,Object> getFields()

Returns unmodifiable map of all values keyed by Field backing this record.

fieldSet

public Set<Field> fieldSet()

Returns unmodifiable set of present fields in this record, never null.

hasField

public boolean hasField(Field field)

Returns true if given field is present in this record.

getValue

public String getValue(Field.StringField field)

Returns the value belonging to given field in this record, or null if field not present.

getValue

public Number getValue(Field.NumberField field)

Returns the value belonging to given field in this record, or null if field not present.

getValue

public Boolean getValue(Field.BooleanField field)

Returns the value belonging to given field in this record, or null if field not present.