SchemaVisibilityConfig


public final class SchemaVisibilityConfig
extends Object implements Parcelable

java.lang.Object
   ↳ android.app.appsearch.SchemaVisibilityConfig


A class to hold a all necessary Visibility information corresponding to the same schema. This pattern allows for easier association of these documents.

This does not correspond to any schema, the properties held in this class are kept in two separate schemas, VisibilityConfig and PublicAclOverlay.

Summary

Nested classes

class SchemaVisibilityConfig.Builder

The builder class of SchemaVisibilityConfig

Inherited constants

Fields

public static final Creator<SchemaVisibilityConfig> CREATOR

Public methods

boolean equals(Object o)

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

List<PackageIdentifier> getAllowedPackages()

Returns a list of PackageIdentifiers of packages that can access this schema.

PackageIdentifier getPubliclyVisibleTargetPackage()

Returns the PackageIdentifier of the package that will be used as the target package in a call to PackageManager.canPackageQuery(String, String) to determine which packages can access this publicly visible schema.

Set<Set<Integer>> getRequiredPermissions()

Returns an array of Integers representing Android Permissions that the caller must hold to access the schema this SchemaVisibilityConfig represents.

int hashCode()

Returns a hash code value for the object.

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

Fields

CREATOR

Added in API level 35
public static final Creator<SchemaVisibilityConfig> CREATOR

Public methods

equals

Added in API level 35
public boolean equals (Object o)

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.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
o Object: This value may be null.

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

getAllowedPackages

Added in API level 35
public List<PackageIdentifier> getAllowedPackages ()

Returns a list of PackageIdentifiers of packages that can access this schema.

Returns
List<PackageIdentifier> This value cannot be null.

getPubliclyVisibleTargetPackage

Added in API level 35
public PackageIdentifier getPubliclyVisibleTargetPackage ()

Returns the PackageIdentifier of the package that will be used as the target package in a call to PackageManager.canPackageQuery(String, String) to determine which packages can access this publicly visible schema. Returns null if the schema is not publicly visible.

Returns
PackageIdentifier

getRequiredPermissions

Added in API level 35
public Set<Set<Integer>> getRequiredPermissions ()

Returns an array of Integers representing Android Permissions that the caller must hold to access the schema this SchemaVisibilityConfig represents.

Returns
Set<Set<Integer>> This value cannot be null.

hashCode

Added in API level 35
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 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 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.

Returns
int a hash code value for this object.

writeToParcel

Added in API level 35
public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
dest Parcel: This value cannot be null.

flags int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES