Stay organized with collections
Save and categorize content based on your preferences.
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
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.
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:
" width
x
height
" 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
fun toString
(): String
!
Return the size represented as a string with the format "WxH"
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License
, and code samples are licensed under the Apache 2.0 License
. For details, see the Google Developers Site Policies
. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-31 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-10-31 UTC."],[[["\u003cp\u003e\u003ccode\u003eSize\u003c/code\u003e is an immutable class representing width and height dimensions in pixels.\u003c/p\u003e\n"],["\u003cp\u003eIt provides methods for creation, comparison (\u003ccode\u003eequals\u003c/code\u003e), hashing (\u003ccode\u003ehashCode\u003c/code\u003e), and string conversion (\u003ccode\u003etoString\u003c/code\u003e).\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eparseSize\u003c/code\u003e is a static method to create a \u003ccode\u003eSize\u003c/code\u003e object from a string representation like "WxH".\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ewidth\u003c/code\u003e and \u003ccode\u003eheight\u003c/code\u003e properties provide access to the size's dimensions.\u003c/p\u003e\n"]]],[],null,["# Size\n====\n\nKotlin \\|[Java](/android/reference/com/google/android/gms/common/images/Size \"View this page in Java\") \n\n\n```\nclass Size\n```\n\n\u003cbr /\u003e\n\n*** ** * ** ***\n\nImmutable class for describing width and height dimensions in pixels.\n\nSummary\n-------\n\n| ### Public constructors |\n|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [Size](/android/reference/kotlin/com/google/android/gms/common/images/Size#Size(int,int))`(width: `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, height: `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)` Create a new immutable Size instance. |\n\n| ### Public functions |\n|----------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | [equals](/android/reference/kotlin/com/google/android/gms/common/images/Size#equals(java.lang.Object))`(obj: `[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)`?)` Check if this size is equal to another size. |\n| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [hashCode](/android/reference/kotlin/com/google/android/gms/common/images/Size#hashCode())`()` |\n| `java-static `[Size](/android/reference/kotlin/com/google/android/gms/common/images/Size)`!` | [parseSize](/android/reference/kotlin/com/google/android/gms/common/images/Size#parseSize(java.lang.String))`(string: `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`!)` Parses the specified string as a size value. |\n| [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`!` | [toString](/android/reference/kotlin/com/google/android/gms/common/images/Size#toString())`()` Return the size represented as a string with the format `\"WxH\"` |\n\n| ### Public properties |\n|----------------------------------------------------------------------------|----------------------------------------------------------------------------------------|\n| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [height](/android/reference/kotlin/com/google/android/gms/common/images/Size#height()) |\n| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [width](/android/reference/kotlin/com/google/android/gms/common/images/Size#width()) |\n\nPublic constructors\n-------------------\n\n### Size\n\n```\nSize(width: Int, height: Int)\n```\n\nCreate a new immutable Size instance. \n\n| Parameters |\n|--------------------------------------------------------------------------------------|-----------------------------------|\n| `width: `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | The width of the size, in pixels |\n| `height: `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | The height of the size, in pixels |\n\nPublic functions\n----------------\n\n### equals\n\n```\nfun equals(obj: Any?): Boolean\n```\n\nCheck if this size is equal to another size.\n\nTwo sizes are equal if and only if both their widths and heights are equal.\n\nA size object is never equal to any other type of object. \n\n| Returns |\n|------------------------------------------------------------------------------------|-----------------------------------------------------|\n| [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | `true` if the objects were equal, `false` otherwise |\n\n### hashCode\n\n```\nfun hashCode(): Int\n``` \n\n### parseSize\n\n```\njava-static fun parseSize(string: String!): Size!\n```\n\nParses the specified string as a size value.\n\nThe ASCII characters `\\``u002a` ('\\*') and `\\``u0078` ('x') are recognized as separators between the width and height.\n\nFor any `Size s`: `Size.parseSize(s.toString()).equals(s)`. However, the method also handles sizes expressed in the following forms:\n\n\"*width* `x`*height* \" or \"*width* `*`*height* \" `=\u003e new\nSize(width, height)`, where *width* and *height* are string integers potentially containing a sign, such as \"-10\", \"+7\" or \"5\". \n\n```kotlin\nSize.parseSize(\"3*+6\").equals(new Size(3, 6)) == true\nSize.parseSize(\"-3x-6\").equals(new Size(-3, -6)) == true\nSize.parseSize(\"4 by 3\") =\u003e throws NumberFormatException\n``` \n\n| Parameters |\n|-----------------------------------------------------------------------------------------------|--------------------------------------------|\n| `string: `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`!` | the string representation of a size value. |\n\n| Returns |\n|--------------------------------------------------------------------------------|-----------------------------------------|\n| [Size](/android/reference/kotlin/com/google/android/gms/common/images/Size)`!` | the size value represented by `string`. |\n\n| Throws |\n|-----------------------------------------------------------------------------------------------------------------|-----------------------------------------------|\n| [java.lang.NumberFormatException](https://developer.android.com/reference/java/lang/NumberFormatException.html) | if `string` cannot be parsed as a size value. |\n| [java.lang.NullPointerException](https://developer.android.com/reference/java/lang/NullPointerException.html) | if `string` was `null` |\n\n### toString\n\n```\nfun toString(): String!\n```\n\nReturn the size represented as a string with the format `\"WxH\"` \n\n| Returns |\n|-------------------------------------------------------------------------------------|-----------------------------------|\n| [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`!` | string representation of the size |\n\nPublic properties\n-----------------\n\n### height\n\n```\nval height: Int\n``` \n\n### width\n\n```\nval width: Int\n```"]]
