com.squareup.square.models

Class Break

java.lang.Object

com.squareup.square.models.Break

public class Break
extends Object

This is a model class for Break type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
Break(String startAt, String breakTypeId, String name, String expectedDuration, boolean isPaid, String id, String endAt) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getBreakTypeId() Getter for BreakTypeId.
String	getEndAt() Getter for EndAt.
String	getExpectedDuration() Getter for ExpectedDuration.
String	getId() Getter for Id.
boolean	getIsPaid() Getter for IsPaid.
String	getName() Getter for Name.
String	getStartAt() Getter for StartAt.
int	hashCode()
Break.Builder	toBuilder() Builds a new Break.Builder object.
String	toString() Converts this Break into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

Break

public Break(String startAt,
             String breakTypeId,
             String name,
             String expectedDuration,
             boolean isPaid,
             String id,
             String endAt)

Initialization constructor.

Parameters:

startAt - String value for startAt.

breakTypeId - String value for breakTypeId.

name - String value for name.

expectedDuration - String value for expectedDuration.

isPaid - boolean value for isPaid.

id - String value for id.

endAt - String value for endAt.

Method Detail

getId

public String getId()

Getter for Id. The UUID for this object.

Returns:

Returns the String

getStartAt

public String getStartAt()

Getter for StartAt. RFC 3339; follows the same timezone information as `Shift`. Precision up to the minute is respected; seconds are truncated.

Returns:

Returns the String

getEndAt

public String getEndAt()

Getter for EndAt. RFC 3339; follows the same timezone information as `Shift`. Precision up to the minute is respected; seconds are truncated.

Returns:

Returns the String

getBreakTypeId

public String getBreakTypeId()

Getter for BreakTypeId. The `BreakType` that this `Break` was templated on.

Returns:

Returns the String

getName

public String getName()

Getter for Name. A human-readable name.

Returns:

Returns the String

getExpectedDuration

public String getExpectedDuration()

Getter for ExpectedDuration. Format: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. The expected length of the break.

Returns:

Returns the String

getIsPaid

public boolean getIsPaid()

Getter for IsPaid. Whether this break counts towards time worked for compensation purposes.

Returns:

Returns the boolean

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 Break into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public Break.Builder toBuilder()

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

Returns:

a new Break.Builder object