RestrictionEntry

TYPE_BOOLEAN

int TYPE_BOOLEAN

Restriction of type "bool". Use this for storing a boolean value, typically presented as a checkbox in the UI.

Constant Value: 1 (0x00000001)

TYPE_BUNDLE

int TYPE_BUNDLE

Restriction of type "bundle". Use this for storing bundles of restrictions

Constant Value: 7 (0x00000007)

TYPE_BUNDLE_ARRAY

int TYPE_BUNDLE_ARRAY

Restriction of type "bundle_array". Use this for storing arrays of bundles of restrictions

Constant Value: 8 (0x00000008)

TYPE_CHOICE

int TYPE_CHOICE

Restriction of type "choice". Use this for storing a string value, typically presented as a single-select list. Call setChoiceEntries(String[]) and setChoiceValues(String[]) to set the localized list entries to present to the user and the corresponding values, respectively.

Constant Value: 2 (0x00000002)

TYPE_INTEGER

int TYPE_INTEGER

Restriction of type "integer". Use this for storing an integer value. The range of values is from MIN_VALUE to MAX_VALUE.

Constant Value: 5 (0x00000005)

TYPE_MULTI_SELECT

int TYPE_MULTI_SELECT

Restriction of type "multi-select". Use this for presenting a multi-select list where more than one entry can be selected, such as for choosing specific titles to white-list. Call setChoiceEntries(String[]) and setChoiceValues(String[]) to set the localized list entries to present to the user and the corresponding values, respectively. Use getAllSelectedStrings() and setAllSelectedStrings(String[]) to manipulate the selections.

Constant Value: 4 (0x00000004)

TYPE_NULL

int TYPE_NULL

Hidden restriction type. Use this type for information that needs to be transferred across but shouldn't be presented to the user in the UI. Stores a single String value.

Constant Value: 0 (0x00000000)

TYPE_STRING

int TYPE_STRING

Restriction of type "string". Use this for storing a string value.

Constant Value: 6 (0x00000006)

CREATOR

Creator<RestrictionEntry> CREATOR

RestrictionEntry

RestrictionEntry (int type, 
                String key)

Constructor for specifying the type and key, with no initial value;

RestrictionEntry

RestrictionEntry (String key, 
                String selectedString)

Constructor for TYPE_CHOICE type.

RestrictionEntry

RestrictionEntry (String key, 
                boolean selectedState)

Constructor for TYPE_BOOLEAN type.

RestrictionEntry

RestrictionEntry (String key, 
                String[] selectedStrings)

Constructor for TYPE_MULTI_SELECT type.

RestrictionEntry

RestrictionEntry (String key, 
                int selectedInt)

Constructor for TYPE_INTEGER type.

RestrictionEntry

RestrictionEntry (Parcel in)

createBundleArrayEntry

RestrictionEntry createBundleArrayEntry (String key, 
                RestrictionEntry[] restrictionEntries)

Creates an entry of type TYPE_BUNDLE_ARRAY.

createBundleEntry

RestrictionEntry createBundleEntry (String key, 
                RestrictionEntry[] restrictionEntries)

Creates an entry of type TYPE_BUNDLE.

describeContents

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.

equals

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.

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.

getAllSelectedStrings

String[] getAllSelectedStrings ()

Returns the list of currently selected values.

getChoiceEntries

String[] getChoiceEntries ()

Returns the list of strings, set earlier, that will be presented as choices to the user.

getChoiceValues

String[] getChoiceValues ()

Returns the list of possible string values set earlier.

getDescription

String getDescription ()

Returns the provided user-visible description of the entry, if any.

getIntValue

int getIntValue ()

Returns the value of the entry as an integer when the type is TYPE_INTEGER.

getKey

String getKey ()

This is the unique key for the restriction entry.

getRestrictions

RestrictionEntry[] getRestrictions ()

Returns array of possible restriction entries that this entry may contain.

getSelectedState

boolean getSelectedState ()

Returns the current selected state for an entry of type TYPE_BOOLEAN.

getSelectedString

String getSelectedString ()

Returns the currently selected string value.

getTitle

String getTitle ()

Returns the user-visible title for the entry, if any.

getType

int getType ()

Returns the type for this restriction.

hashCode

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^TM programming language.)

setAllSelectedStrings

void setAllSelectedStrings (String[] allSelectedStrings)

Sets the current list of selected values for an entry of type TYPE_MULTI_SELECT. These values will be persisted by the system for later use by the application.

setChoiceEntries

void setChoiceEntries (Context context, 
                int stringArrayResId)

Sets a list of strings that will be presented as choices to the user. This is similar to setChoiceEntries(String[]).

setChoiceEntries

void setChoiceEntries (String[] choiceEntries)

Sets a list of strings that will be presented as choices to the user. When the user selects one or more of these choices, the corresponding value from the possible values are stored as the selected strings. The size of this array must match the size of the array set in setChoiceValues(String[]). This method is not relevant for types other than TYPE_CHOICE, and TYPE_MULTI_SELECT.

setChoiceValues

void setChoiceValues (String[] choiceValues)

Sets a list of string values that can be selected by the user. If no user-visible entries are set by a call to setChoiceEntries(String[]), these values will be the ones shown to the user. Values will be chosen from this list as the user's selection and the selected values can be retrieved by a call to getAllSelectedStrings(), or getSelectedString(), depending on whether it is a multi-select type or choice type. This method is not relevant for types other than TYPE_CHOICE, and TYPE_MULTI_SELECT.

setChoiceValues

void setChoiceValues (Context context, 
                int stringArrayResId)

Sets a list of string values that can be selected by the user, similar to setChoiceValues(String[]).

setDescription

void setDescription (String description)

Sets the user-visible description of the entry, as a possible sub-text for the title. You can use this to describe the entry in more detail or to display the current state of the restriction.

setIntValue

void setIntValue (int value)

Sets the integer value of the entry when the type is TYPE_INTEGER.

setRestrictions

void setRestrictions (RestrictionEntry[] restrictions)

Sets an array of possible restriction entries, that this entry may contain.

This method is only relevant for types TYPE_BUNDLE and TYPE_BUNDLE_ARRAY

setSelectedState

void setSelectedState (boolean state)

Sets the current selected state for an entry of type TYPE_BOOLEAN. This value will be persisted by the system for later use by the application.

setSelectedString

void setSelectedString (String selectedString)

Sets the string value to use as the selected value for this restriction. This value will be persisted by the system for later use by the application.

setTitle

void setTitle (String title)

Sets the user-visible title for the entry.

setType

void setType (int type)

Sets the type for this restriction.

toString

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())
 

writeToParcel

void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.