Most visited

Recently visited

Results for

Summary: Constants | Methods | Inherited Methods

AppSearchResult

public final class AppSearchResult
extends Object

java.lang.Object
↳	android.app.appsearch.AppSearchResult<ValueType>

Information about the success or failure of an AppSearch call.

Summary

Constants
`int`	`RESULT_INTERNAL_ERROR` An internal error occurred within AppSearch, which the caller cannot address.
`int`	`RESULT_INVALID_ARGUMENT` The caller supplied invalid arguments to the call.
`int`	`RESULT_INVALID_SCHEMA` The caller supplied a schema which is invalid or incompatible with the previous schema.
`int`	`RESULT_IO_ERROR` An issue occurred reading or writing to storage.
`int`	`RESULT_NOT_FOUND` An entity the caller requested to interact with does not exist in the system.
`int`	`RESULT_OK` The call was successful.
`int`	`RESULT_OUT_OF_SPACE` Storage is out of space, and no more space could be reclaimed.
`int`	`RESULT_SECURITY_ERROR` The caller requested an operation it does not have privileges for.
`int`	`RESULT_UNKNOWN_ERROR` An unknown error occurred while processing the call.

Public methods
`boolean`	`equals(Object other)` Indicates whether some other object is "equal to" this one.
`String`	`getErrorMessage()` Returns the error message associated with this result.
`int`	`getResultCode()` Returns one of the `RESULT` constants defined in `AppSearchResult`.
`ValueType`	`getResultValue()` Returns the result value associated with this result, if it was successful.
`int`	`hashCode()` Returns a hash code value for the object.
`boolean`	`isSuccess()` Returns `true` if `getResultCode()` equals `AppSearchResult#RESULT_OK`.
`static <ValueType> AppSearchResult<ValueType>`	`newFailedResult(int resultCode, String errorMessage)` Creates a new failed `AppSearchResult`.
`static <ValueType> AppSearchResult<ValueType>`	`newSuccessfulResult(ValueType value)` Creates a new successful `AppSearchResult`.
`String`	`toString()` Returns a string representation of the object.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeout, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void`	`wait(long timeout)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void`	`wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

Constants

RESULT_INTERNAL_ERROR

public static final int RESULT_INTERNAL_ERROR

An internal error occurred within AppSearch, which the caller cannot address.

This error may be considered similar to IllegalStateException

Constant Value: 2 (0x00000002)

RESULT_INVALID_ARGUMENT

public static final int RESULT_INVALID_ARGUMENT

The caller supplied invalid arguments to the call.

This error may be considered similar to IllegalArgumentException.

Constant Value: 3 (0x00000003)

RESULT_INVALID_SCHEMA

public static final int RESULT_INVALID_SCHEMA

The caller supplied a schema which is invalid or incompatible with the previous schema.

Constant Value: 7 (0x00000007)

RESULT_IO_ERROR

public static final int RESULT_IO_ERROR

An issue occurred reading or writing to storage. The call might succeed if repeated.

This error may be considered similar to IOException.

Constant Value: 4 (0x00000004)

RESULT_NOT_FOUND

public static final int RESULT_NOT_FOUND

An entity the caller requested to interact with does not exist in the system.

Constant Value: 6 (0x00000006)

RESULT_OK

public static final int RESULT_OK

The call was successful.

Constant Value: 0 (0x00000000)

RESULT_OUT_OF_SPACE

public static final int RESULT_OUT_OF_SPACE

Storage is out of space, and no more space could be reclaimed.

Constant Value: 5 (0x00000005)

RESULT_SECURITY_ERROR

public static final int RESULT_SECURITY_ERROR

The caller requested an operation it does not have privileges for.

Constant Value: 8 (0x00000008)

RESULT_UNKNOWN_ERROR

public static final int RESULT_UNKNOWN_ERROR

An unknown error occurred while processing the call.

Constant Value: 1 (0x00000001)

Public methods

equals

public boolean equals (Object other)

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

Parameters
`other`	`Object`: This value may be `null`.

Returns
`boolean`	`true` if this object is the same as the obj argument; `false` otherwise.

getErrorMessage

public String getErrorMessage ()

Returns the error message associated with this result.

If isSuccess() is true, the error message is always null. The error message may be null even if isSuccess() is false. See the documentation of the particular AppSearchSession call producing this AppSearchResult for what is returned by getErrorMessage().

Returns
`String`

getResultCode

public int getResultCode ()

Returns one of the RESULT constants defined in AppSearchResult.

Returns
`int`	Value is `RESULT_OK`, `RESULT_UNKNOWN_ERROR`, `RESULT_INTERNAL_ERROR`, `RESULT_INVALID_ARGUMENT`, `RESULT_IO_ERROR`, `RESULT_OUT_OF_SPACE`, `RESULT_NOT_FOUND`, `RESULT_INVALID_SCHEMA`, or `RESULT_SECURITY_ERROR`

getResultValue

public ValueType getResultValue ()

Returns the result value associated with this result, if it was successful.

See the documentation of the particular AppSearchSession call producing this AppSearchResult for what is placed in the result value by that call.

Returns
`ValueType`	This value may be `null`.

Throws
`IllegalStateException`	if this `AppSearchResult` is not successful.

hashCode

public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java™ programming language.)

Returns
`int`	a hash code value for this object.

isSuccess

public boolean isSuccess ()

Returns true if getResultCode() equals AppSearchResult#RESULT_OK.

Returns
`boolean`

newFailedResult

public static AppSearchResult<ValueType> newFailedResult (int resultCode, 
                String errorMessage)

Creates a new failed AppSearchResult.

Parameters
`resultCode`	`int`: One of the constants documented in `AppSearchResult#getResultCode`. Value is `RESULT_OK`, `RESULT_UNKNOWN_ERROR`, `RESULT_INTERNAL_ERROR`, `RESULT_INVALID_ARGUMENT`, `RESULT_IO_ERROR`, `RESULT_OUT_OF_SPACE`, `RESULT_NOT_FOUND`, `RESULT_INVALID_SCHEMA`, or `RESULT_SECURITY_ERROR`
`errorMessage`	`String`: An optional string describing the reason or nature of the failure. This value may be `null`.

Returns
`AppSearchResult<ValueType>`	This value cannot be `null`.

newSuccessfulResult

public static AppSearchResult<ValueType> newSuccessfulResult (ValueType value)

Creates a new successful AppSearchResult.

Parameters
`value`	`ValueType`: An optional value to associate with the successful result of the operation being performed. This value may be `null`.

Returns
`AppSearchResult<ValueType>`	This value cannot be `null`.

toString

public String toString ()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())

Returns
`String`	This value cannot be `null`.

Interfaces

Classes

Most visited

Recently visited

Results for

AppSearchResult

Summary

Constants

Public methods

Inherited methods

Constants

RESULT_INTERNAL_ERROR

RESULT_INVALID_ARGUMENT

RESULT_INVALID_SCHEMA

RESULT_IO_ERROR

RESULT_NOT_FOUND

RESULT_OK

RESULT_OUT_OF_SPACE

RESULT_SECURITY_ERROR

RESULT_UNKNOWN_ERROR

Public methods

equals

getErrorMessage

getResultCode

getResultValue

hashCode

isSuccess

newFailedResult

newSuccessfulResult

toString