Added in API level 21

SizeF

---

Kotlin |Java

class SizeF : Parcelable

kotlin.Any
↳	android.util.SizeF

Immutable class for describing width and height dimensions in some arbitrary unit.

Width and height are finite values stored as a floating point representation.

Summary

Inherited constants

From class Parcelable Int CONTENTS_FILE_DESCRIPTOR Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. Int PARCELABLE_WRITE_RETURN_VALUE Flag for use with writeToParcel: the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". Some implementations may want to release resources at this point.

Public constructors
SizeF(width: Float, height: Float) Create a new immutable SizeF instance.

Public methods
Int	describeContents() Parcelable interface methods
Boolean	equals(other: Any?) Check if this size is equal to another size.
Float	getHeight() Get the height of the size (as an arbitrary unit).
Float	getWidth() Get the width of the size (as an arbitrary unit).
Int	hashCode() Returns a hash code value for the object.
static SizeF!	parseSizeF(string: String!) Parses the specified string as a size value.
String	toString() Return the size represented as a string with the format "WxH"
Unit	writeToParcel(out: Parcel, flags: Int) Write this size to the specified parcel.

Properties
static Parcelable.Creator<SizeF!>	CREATOR

Public constructors

SizeF

Added in API level 21

SizeF(
    width: Float, 
    height: Float)

Create a new immutable SizeF instance.

Both the width and the height must be a finite number. In particular, NaN and positive/negative infinity are illegal values.

Parameters
width	Float: The width of the size
height	Float: The height of the size

Exceptions
java.lang.IllegalArgumentException	if either width or height was not finite.

Public methods

describeContents

Added in API level 31

fun describeContents(): Int

Parcelable interface methods

Return
Int	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR

equals

Added in API level 21

fun equals(other: Any?): Boolean

Check if this size is equal to another size.

Two sizes are equal if and only if both their widths and heights are the same.

For this purpose, the width/height float values are considered to be the same if and only if the method Float#floatToIntBits(float) returns the identical int value when applied to each.

Parameters
obj	the reference object with which to compare.

Return
Boolean	true if the objects were equal, false otherwise

getHeight

Added in API level 21

fun getHeight(): Float

Get the height of the size (as an arbitrary unit).

Return
Float	height

getWidth

Added in API level 21

fun getWidth(): Float

Get the width of the size (as an arbitrary unit).

Return
Float	width

hashCode

Added in API level 21

fun hashCode(): Int

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.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.

Return
Int	a hash code value for this object.

parseSizeF

Added in API level 21

static fun parseSizeF(string: String!): SizeF!

Parses the specified string as a size value.

The ASCII characters \u002a ('*') and \u0078 ('x') are recognized as separators between the width and height.

For any SizeF s: SizeF.parseSizeF(s.toString()).equals(s). However, the method also handles sizes expressed in the following forms:

"widthxheight" or "width*height" => new SizeF(width, height), where width and height are string floats potentially containing a sign, such as "-10.3", "+7" or "5.2", but not containing an 'x' (such as a float in hexadecimal string format).

<code>SizeF.parseSizeF("3.2*+6").equals(new SizeF(3.2f, 6.0f)) == true
  SizeF.parseSizeF("-3x-6").equals(new SizeF(-3.0f, -6.0f)) == true
  SizeF.parseSizeF("4 by 3") =&gt; throws NumberFormatException
  </code>

Parameters
string	String!: the string representation of a size value.

Return
SizeF!	the size value represented by string.

Exceptions
java.lang.NumberFormatException	if string cannot be parsed as a size value.
java.lang.NullPointerException	if string was null

toString

Added in API level 21

fun toString(): String

Return the size represented as a string with the format "WxH"

Return
String	string representation of the size

writeToParcel

Added in API level 31

fun writeToParcel(
    out: Parcel, 
    flags: Int
): Unit

Write this size to the specified parcel. To restore a size from a parcel, use the CREATOR.

Parameters
dest	The Parcel in which the object should be written. This value cannot be null.
flags	Int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES
out	Parcel: The parcel to write the point's coordinates into This value cannot be null.

Properties

CREATOR

Added in API level 31

static val CREATOR: Parcelable.Creator<SizeF!>