public final class Size extends Object

Immutable class for describing width and height dimensions in pixels.

Public Constructor Summary

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

Public Method Summary

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

Public Constructors

public Size (int width, int height)

Create a new immutable Size instance.

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

Public Methods

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.

Returns
  • true if the objects were equal, false otherwise

public int getHeight ()

Get the height of the size (in pixels).

Returns
  • height

public int getWidth ()

Get the width of the size (in pixels).

Returns
  • width

public int hashCode ()

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 the string representation of a size value.
Returns
  • the size value represented by string.
Throws
NumberFormatException if string cannot be parsed as a size value.
NullPointerException if string was null

public String toString ()

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

Returns
  • string representation of the size