com.squareup.square.models

Class StandardUnitDescription

java.lang.Object

com.squareup.square.models.StandardUnitDescription

public class StandardUnitDescription
extends Object

This is a model class for StandardUnitDescription type.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StandardUnitDescription.Builder Class to build instances of StandardUnitDescription.

Constructor Summary

Constructors

Constructor and Description
StandardUnitDescription(MeasurementUnit unit, String name, String abbreviation) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getAbbreviation() Getter for Abbreviation.
String	getName() Getter for Name.
MeasurementUnit	getUnit() Getter for Unit.
int	hashCode()
StandardUnitDescription.Builder	toBuilder() Builds a new StandardUnitDescription.Builder object.
String	toString() Converts this StandardUnitDescription into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

StandardUnitDescription

public StandardUnitDescription(MeasurementUnit unit,
                               String name,
                               String abbreviation)

Initialization constructor.

Parameters:

unit - MeasurementUnit value for unit.

name - String value for name.

abbreviation - String value for abbreviation.

Method Detail

getUnit

public MeasurementUnit getUnit()

Getter for Unit. Represents a unit of measurement to use with a quantity, such as ounces or inches. Exactly one of the following fields are required: `custom_unit`, `area_unit`, `length_unit`, `volume_unit`, and `weight_unit`.

Returns:

Returns the MeasurementUnit

getName

public String getName()

Getter for Name. UI display name of the measurement unit. For example, 'Pound'.

Returns:

Returns the String

getAbbreviation

public String getAbbreviation()

Getter for Abbreviation. UI display abbreviation for the measurement unit. For example, 'lb'.

Returns:

Returns the String

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Converts this StandardUnitDescription into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public StandardUnitDescription.Builder toBuilder()

Builds a new StandardUnitDescription.Builder object. Creates the instance with the state of the current model.

Returns:

a new StandardUnitDescription.Builder object