Save the date! Android Dev Summit is coming to Mountain View, CA on November 7-8, 2018.

Size

public final class Size
extends Object

java.lang.Object
   ↳ android.util.Size


Immutable class for describing width and height dimensions in pixels.

Summary

Public constructors

Size(int width, int height)

Create a new immutable Size instance.

Public methods

boolean equals(Object obj)

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

Returns a hash code value for the object.

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"

Inherited methods

Public constructors

Size

added in API level 21
public Size (int width, 
                int height)

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

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

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 int getHeight ()

Get the height of the size (in pixels).

Returns
int height

getWidth

added in API level 21
public int getWidth ()

Get the width of the size (in pixels).

Returns
int 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(Object) 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(java.lang.Object) 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.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java™ programming language.)

Returns
int a hash code value for this object.

parseSize

added in API level 21
public static Size parseSize (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 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
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