org.firstinspires.ftc.robotcore.external.android.util

Class Size

java.lang.Object

org.firstinspires.ftc.robotcore.external.android.util.Size

public final class Size
extends java.lang.Object

Immutable class for describing width and height dimensions in integer valued units. Backported from API21, where it was introduced, to here, where we need to support API19.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.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(java.lang.String string) Parses the specified string as a size value.
java.lang.String	toString() Return the size represented as a string with the format "WxH"

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Size

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

Method Detail

getWidth

public int getWidth()

Get the width of the size (in pixels).

Returns:

width

getHeight

public int getHeight()

Get the height of the size (in pixels).

Returns:

height

equals

public boolean equals(java.lang.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.

Overrides:

equals in class java.lang.Object

Returns:

true if the objects were equal, false otherwise

toString

public java.lang.String toString()

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

Overrides:

toString in class java.lang.Object

Returns:

string representation of the size

parseSize

public static Size parseSize(java.lang.String string)
                      throws java.lang.NumberFormatException

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:

java.lang.NumberFormatException - if string cannot be parsed as a size value.

java.lang.NullPointerException - if string was null

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object