TextLinks.TextLink

public static final class TextLinks.TextLink
extends Object implements Parcelable

java.lang.Object
   ↳ android.view.textclassifier.TextLinks.TextLink


A link, identifying a substring of text and possible entity types for it.

Summary

Inherited constants

Fields

public static final Creator<TextLinks.TextLink> CREATOR

Public methods

int describeContents()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

float getConfidenceScore(String entityType)

Returns the confidence score for a particular entity type.

int getEnd()

Returns the end index of this link in the original text.

String getEntity(int index)

Returns the entity type at a given index.

int getEntityCount()

Returns the number of entity types that have confidence scores.

int getStart()

Returns the start index of this link in the original text.

String toString()

Returns a string representation of the object.

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

Fields

CREATOR

added in API level 28
public static final Creator<TextLinks.TextLink> CREATOR

Public methods

describeContents

added in API level 28
public int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
int a bitmask indicating the set of special object types marshaled by this Parcelable object instance.

getConfidenceScore

added in API level 28
public float getConfidenceScore (String entityType)

Returns the confidence score for a particular entity type.

Parameters
entityType String: the entity type

Value is TYPE_UNKNOWN, TYPE_OTHER, TYPE_EMAIL, TYPE_PHONE, TYPE_ADDRESS, TYPE_URL, TYPE_DATE, TYPE_DATE_TIME or TYPE_FLIGHT_NUMBER.

Returns
float

Value is between 0.0 and 1.0 inclusive.

getEnd

added in API level 28
public int getEnd ()

Returns the end index of this link in the original text.

Returns
int the end index

getEntity

added in API level 28
public String getEntity (int index)

Returns the entity type at a given index. Entity types are sorted by confidence.

Parameters
index int

Returns
String the entity type at the provided index

This value will never be null.

Value is TYPE_UNKNOWN, TYPE_OTHER, TYPE_EMAIL, TYPE_PHONE, TYPE_ADDRESS, TYPE_URL, TYPE_DATE, TYPE_DATE_TIME or TYPE_FLIGHT_NUMBER.

getEntityCount

added in API level 28
public int getEntityCount ()

Returns the number of entity types that have confidence scores.

Returns
int the entity count

getStart

added in API level 28
public int getStart ()

Returns the start index of this link in the original text.

Returns
int the start index

toString

added in API level 28
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 a string representation of the object.

writeToParcel

added in API level 28
public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
dest Parcel: The Parcel in which the object should be written.

flags int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE.