Package com.io7m.coffeepick.api

Class CoffeePickTaskEventSucceeded

java.lang.Object

com.io7m.coffeepick.api.CoffeePickTaskEventSucceeded

All Implemented Interfaces:

CoffeePickEventType, CoffeePickTaskEventSucceededType, CoffeePickTaskEventType

public final class CoffeePickTaskEventSucceeded
extends java.lang.Object
implements CoffeePickTaskEventSucceededType

A task has completed successfully.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CoffeePickTaskEventSucceeded.Builder	Builds instances of type CoffeePickTaskEventSucceeded.

Nested classes/interfaces inherited from interface com.io7m.coffeepick.api.CoffeePickEventType

CoffeePickEventType.Severity

Method Summary

Modifier and Type	Method	Description
static CoffeePickTaskEventSucceeded.Builder	builder()	Creates a builder for CoffeePickTaskEventSucceeded.
static CoffeePickTaskEventSucceeded	copyOf(CoffeePickTaskEventSucceededType instance)	Creates an immutable copy of a CoffeePickTaskEventSucceededType value.
java.lang.String	description()
boolean	equals(java.lang.Object another)	This instance is equal to all instances of CoffeePickTaskEventSucceeded that have equal attribute values.
int	hashCode()	Computes a hash code from attributes: description.
java.lang.String	toString()	Prints the immutable value CoffeePickTaskEventSucceeded with attribute values.
CoffeePickTaskEventSucceeded	withDescription(java.lang.String value)	Copy the current immutable object by setting a value for the description attribute.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.io7m.coffeepick.api.CoffeePickTaskEventSucceededType

severity

Method Detail

description

public java.lang.String description()

Specified by:

description in interface CoffeePickTaskEventSucceededType

Specified by:

description in interface CoffeePickTaskEventType

Returns:

The value of the description attribute

withDescription

public final CoffeePickTaskEventSucceeded withDescription(java.lang.String value)

Copy the current immutable object by setting a value for the description attribute. An equals check used to prevent copying of the same value by returning this.

Parameters:

value - A new value for description

Returns:

A modified copy of the this object

equals

public boolean equals(java.lang.Object another)

This instance is equal to all instances of CoffeePickTaskEventSucceeded that have equal attribute values.

Overrides:

equals in class java.lang.Object

Returns:

true if this is equal to another instance

hashCode

public int hashCode()

Computes a hash code from attributes: description.

Overrides:

hashCode in class java.lang.Object

Returns:

hashCode value

toString

public java.lang.String toString()

Prints the immutable value CoffeePickTaskEventSucceeded with attribute values.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of the value

copyOf

public static CoffeePickTaskEventSucceeded copyOf(CoffeePickTaskEventSucceededType instance)

Creates an immutable copy of a CoffeePickTaskEventSucceededType value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.

Parameters:

instance - The instance to copy

Returns:

A copied immutable CoffeePickTaskEventSucceeded instance

builder

public static CoffeePickTaskEventSucceeded.Builder builder()

Creates a builder for CoffeePickTaskEventSucceeded.

 CoffeePickTaskEventSucceeded.builder()
    .setDescription(String) // required description
    .build();
 

Returns:

A new CoffeePickTaskEventSucceeded builder