Size

Kotlin |Java

public final classSize

Immutable class for describing width and height dimensions in pixels.

Summary

Public fields
`final int`	`height`
`final int`	`width`

Public constructors
`Size(int width, int height)` Create a new immutable Size instance.

Public methods
`boolean`	`equals(@NullableObjectobj)` Check if this size is equal to another size.
`int`	`getHeight()` Get the height of the size (in pixels).
`int`	`getWidth()` Get the width of the size (in pixels).
`int`	`hashCode()`
`staticSize`	`parseSize(Stringstring)` Parses the specified string as a size value.
`String`	`toString()` Return the size represented as a string with the format`"WxH"`

Public fields

height

public final intheight

width

public final intwidth

Public constructors

Size

publicSize(int width, int height)

Create a new immutable Size instance.

Parameters
`int width`	The width of the size, in pixels
`int height`	The height of the size, in pixels

Public methods

equals

public booleanequals(@NullableObjectobj)

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

getHeight

public intgetHeight()

Get the height of the size (in pixels).

Returns
`int`	height

getWidth

public intgetWidth()

Get the width of the size (in pixels).

Returns
`int`	width

hashCode

public inthashCode()

parseSize

public staticSizeparseSize(Stringstring)

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 anySize 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),wherewidthandheightare 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
`Stringstring`	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

publicStringtoString()

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

Returns
`String`	string representation of the size