Added in API level 21

Size


class Size
kotlin.Any
   ↳ android.util.Size

Immutable class for describing width and height dimensions in pixels.

Summary

Public constructors
Size(width: Int, height: Int)

Create a new immutable Size instance.

Public methods
Boolean
equals(other: Any?)

Check if this size is equal to another size.

Int

Get the height of the size (in pixels).

Int

Get the width of the size (in pixels).

Int

Returns a hash code value for the object.

static Size!
parseSize(string: String!)

Parses the specified string as a size value.

String

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

Public constructors

Size

Added in API level 21
Size(
    width: Int,
    height: Int)

Create a new immutable Size instance.

Parameters
width Int: The width of the size, in pixels
height Int: The height of the size, in pixels

Public methods

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

A size object is never equal to any other type of object.

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

Get the height of the size (in pixels).

Return
Int height

getWidth

Added in API level 21
fun getWidth(): Int

Get the width of the size (in pixels).

Return
Int 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.

parseSize

Added in API level 21
static fun parseSize(string: String!): Size!

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 Size s: Size.parseSize(s.toString()).equals(s). However, the method also handles sizes expressed in the following forms:

"widthxheight" or "width*height" => new Size(width, height), where width and height are string integers potentially containing a sign, such as "-10", "+7" or "5".

<code>Size.parseSize("3*+6").equals(new Size(3, 6)) == true
  Size.parseSize("-3x-6").equals(new Size(-3, -6)) == true
  Size.parseSize("4 by 3") =&gt; throws NumberFormatException
  </code>
Parameters
string String!: the string representation of a size value.
Return
Size! 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