Added in API level 21

Summary: Inherited Constants | Fields | Ctors | Methods | Inherited Methods

SizeF

Kotlin |Java

public final class SizeF
extends Object implements Parcelable

java.lang.Object
↳	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 interface android.os.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(Parcel, int)`: 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)`".

Fields
`public static final Creator<SizeF>`	`CREATOR`

Public constructors
`SizeF(float width, float height)` Create a new immutable SizeF instance.

Public methods
`int`	`describeContents()` Parcelable interface methods
`boolean`	`equals(Object obj)` 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"`
`void`	`writeToParcel(Parcel out, int flags)` Write this size to the specified parcel.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          android.os.Parcelable

`abstract int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`abstract void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Fields

CREATOR

Added in API level 31

public static final Creator<SizeF> CREATOR

Public constructors

SizeF

Added in API level 21

public SizeF (float width, 
                float height)

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

Throws
`IllegalArgumentException`	if either `width` or `height` was not finite.

Public methods

describeContents

Added in API level 31

public int describeContents ()

Parcelable interface methods

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 21

public boolean equals (Object obj)

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`	`Object`: the reference object with which to compare.

Returns
`boolean`	`true` if the objects were equal, `false` otherwise

getHeight

Added in API level 21

public float getHeight ()

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

Returns
`float`	height

getWidth

Added in API level 21

public float getWidth ()

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

Returns
`float`	width

hashCode

Added in API level 21

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.

parseSizeF

Added in API level 21

public static SizeF parseSizeF (String string)

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

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") => throws NumberFormatException

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

Returns
`SizeF`	the size value represented by `string`.

Throws
`NumberFormatException`	if `string` cannot be parsed as a size value.
`NullPointerException`	if `string` was `null`

toString

Added in API level 21

public String toString ()

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

Returns
`String`	string representation of the size

writeToParcel

Added in API level 31

public void writeToParcel (Parcel out, 
                int flags)

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

Parameters
`out`	`Parcel`: The parcel to write the point's coordinates into 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