RoundedCorner

public final class RoundedCorner
extends Object implements Parcelable

java.lang.Object
   ↳ android.view.RoundedCorner


Represents a rounded corner of the display.

A figure to describe what the rounded corner radius and the center point are.

Note: The rounded corner formed by the radius and the center is an approximation.

RoundedCorner is immutable.

Summary

Constants

int POSITION_BOTTOM_LEFT

The rounded corner is at the bottom-left of the screen.

int POSITION_BOTTOM_RIGHT

The rounded corner is at the bottom-right of the screen.

int POSITION_TOP_LEFT

The rounded corner is at the top-left of the screen.

int POSITION_TOP_RIGHT

The rounded corner is at the top-right of the screen.

Inherited constants

Fields

public static final Creator<RoundedCorner> CREATOR

Public constructors

RoundedCorner(int position, int radius, int centerX, int centerY)

Creates a RoundedCorner.

Public methods

int describeContents()

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

boolean equals(Object o)

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

Point getCenter()

Returns the circle center of a quarter circle approximation of this RoundedCorner.

int getPosition()

Get the position of this RoundedCorner.

int getRadius()

Returns the radius of a quarter circle approximation of this RoundedCorner.

int hashCode()

Returns a hash code value for the object.

String toString()

Returns a string representation of the object.

void writeToParcel(Parcel out, int flags)

Flatten this object in to a Parcel.

Inherited methods

Constants

POSITION_BOTTOM_LEFT

Added in API level 31
public static final int POSITION_BOTTOM_LEFT

The rounded corner is at the bottom-left of the screen.

Constant Value: 3 (0x00000003)

POSITION_BOTTOM_RIGHT

Added in API level 31
public static final int POSITION_BOTTOM_RIGHT

The rounded corner is at the bottom-right of the screen.

Constant Value: 2 (0x00000002)

POSITION_TOP_LEFT

Added in API level 31
public static final int POSITION_TOP_LEFT

The rounded corner is at the top-left of the screen.

Constant Value: 0 (0x00000000)

POSITION_TOP_RIGHT

Added in API level 31
public static final int POSITION_TOP_RIGHT

The rounded corner is at the top-right of the screen.

Constant Value: 1 (0x00000001)

Fields

CREATOR

Added in API level 31
public static final Creator<RoundedCorner> CREATOR

Public constructors

RoundedCorner

Added in API level 31
public RoundedCorner (int position, 
                int radius, 
                int centerX, 
                int centerY)

Creates a RoundedCorner.

Note that this is only useful for tests. For production code, developers should always use a RoundedCorner obtained from the system via WindowInsets#getRoundedCorner or Display#getRoundedCorner.

Parameters
position int: the position of the rounded corner. Value is POSITION_TOP_LEFT, POSITION_TOP_RIGHT, POSITION_BOTTOM_RIGHT, or POSITION_BOTTOM_LEFT

radius int: the radius of the rounded corner.

centerX int: the x of center point of the rounded corner.

centerY int: the y of center point of the rounded corner.

Public methods

describeContents

Added in API level 31
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(android.os.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. Value is either 0 or CONTENTS_FILE_DESCRIPTOR

equals

Added in API level 31
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: the reference object with which to compare.

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

getCenter

Added in API level 31
public Point getCenter ()

Returns the circle center of a quarter circle approximation of this RoundedCorner.

Returns
Point the center point of this RoundedCorner in the application's coordinate. This value cannot be null.

getPosition

Added in API level 31
public int getPosition ()

Get the position of this RoundedCorner.

Returns
int Value is POSITION_TOP_LEFT, POSITION_TOP_RIGHT, POSITION_BOTTOM_RIGHT, or POSITION_BOTTOM_LEFT

getRadius

Added in API level 31
public int getRadius ()

Returns the radius of a quarter circle approximation of this RoundedCorner.

Returns
int the rounded corner radius of this RoundedCorner. Returns 0 if there is no rounded corner.

hashCode

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

toString

Added in API level 31
public String toString ()

Returns a string representation of the object.

Returns
String a string representation of the object.

writeToParcel

Added in API level 31
public void writeToParcel (Parcel out, 
                int flags)

Flatten this object in to a Parcel.

Parameters
out 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