Size

Kotlin |Java

class 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 functions
`Boolean`	`equals(obj: Any?)` Check if this size is equal to another size.
`Int`	`hashCode()`
`java-static Size!`	`parseSize(string: String!)` Parses the specified string as a size value.
`String!`	`toString()` Return the size represented as a string with the format `"WxH"`

Public properties
`Int`	`height`
`Int`	`width`

Public constructors

Size

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 functions

equals

fun equals(obj: 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.

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

hashCode

fun hashCode(): Int

parseSize

java-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".

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

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

Returns
`Size!`	the size value represented by `string`.

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

toString

fun toString(): String!

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

Returns
`String!`	string representation of the size

Public properties

height

val height: Int

width

val width: Int