Package com.io7m.brooklime.api

Class BLProgressFileStarted

java.lang.Object

com.io7m.brooklime.api.BLProgressFileStarted

All Implemented Interfaces:

BLProgressEventType, BLProgressEventType.BLProgressFileStartedType

public final class BLProgressFileStarted
extends Object
implements BLProgressEventType.BLProgressFileStartedType

Progress started on a particular file.

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from interface com.io7m.brooklime.api.BLProgressEventType

BLProgressEventType.BLProgressFileStartedType, BLProgressEventType.BLProgressUpdateType, BLProgressEventType.Kind

Method Summary

Modifier and Type	Method	Description
int	attemptCurrent()
int	attemptMaximum()
static BLProgressFileStarted.Builder	builder()	Creates a builder for BLProgressFileStarted.
static BLProgressFileStarted	copyOf(BLProgressEventType.BLProgressFileStartedType instance)	Creates an immutable copy of a BLProgressEventType.BLProgressFileStartedType value.
boolean	equals(Object another)	This instance is equal to all instances of BLProgressFileStarted that have equal attribute values.
int	fileIndexCurrent()
int	fileIndexMaximum()
int	hashCode()	Computes a hash code from attributes: name, attemptCurrent, attemptMaximum, fileIndexCurrent, fileIndexMaximum.
String	name()
String	toString()	Prints the immutable value BLProgressFileStarted with attribute values.
final BLProgressFileStarted	withAttemptCurrent(int value)	Copy the current immutable object by setting a value for the attemptCurrent attribute.
final BLProgressFileStarted	withAttemptMaximum(int value)	Copy the current immutable object by setting a value for the attemptMaximum attribute.
final BLProgressFileStarted	withFileIndexCurrent(int value)	Copy the current immutable object by setting a value for the fileIndexCurrent attribute.
final BLProgressFileStarted	withFileIndexMaximum(int value)	Copy the current immutable object by setting a value for the fileIndexMaximum attribute.
final BLProgressFileStarted	withName(String value)	Copy the current immutable object by setting a value for the name attribute.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.io7m.brooklime.api.BLProgressEventType.BLProgressFileStartedType

kind

Method Details

name

public String name()

Specified by:

name in interface BLProgressEventType

Specified by:

name in interface BLProgressEventType.BLProgressFileStartedType

Returns:

The value of the name attribute

attemptCurrent

public int attemptCurrent()

Specified by:

attemptCurrent in interface BLProgressEventType

Specified by:

attemptCurrent in interface BLProgressEventType.BLProgressFileStartedType

Returns:

The value of the attemptCurrent attribute

attemptMaximum

public int attemptMaximum()

Specified by:

attemptMaximum in interface BLProgressEventType

Specified by:

attemptMaximum in interface BLProgressEventType.BLProgressFileStartedType

Returns:

The value of the attemptMaximum attribute

fileIndexCurrent

public int fileIndexCurrent()

Specified by:

fileIndexCurrent in interface BLProgressEventType

Specified by:

fileIndexCurrent in interface BLProgressEventType.BLProgressFileStartedType

Returns:

The value of the fileIndexCurrent attribute

fileIndexMaximum

public int fileIndexMaximum()

Specified by:

fileIndexMaximum in interface BLProgressEventType

Specified by:

fileIndexMaximum in interface BLProgressEventType.BLProgressFileStartedType

Returns:

The value of the fileIndexMaximum attribute

withName

public final BLProgressFileStarted withName(String value)

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

Parameters:

value - A new value for name

Returns:

A modified copy of the this object

withAttemptCurrent

public final BLProgressFileStarted withAttemptCurrent(int value)

Copy the current immutable object by setting a value for the attemptCurrent attribute. A value equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for attemptCurrent

Returns:

A modified copy of the this object

withAttemptMaximum

public final BLProgressFileStarted withAttemptMaximum(int value)

Copy the current immutable object by setting a value for the attemptMaximum attribute. A value equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for attemptMaximum

Returns:

A modified copy of the this object

withFileIndexCurrent

public final BLProgressFileStarted withFileIndexCurrent(int value)

Copy the current immutable object by setting a value for the fileIndexCurrent attribute. A value equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for fileIndexCurrent

Returns:

A modified copy of the this object

withFileIndexMaximum

public final BLProgressFileStarted withFileIndexMaximum(int value)

Copy the current immutable object by setting a value for the fileIndexMaximum attribute. A value equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for fileIndexMaximum

Returns:

A modified copy of the this object

equals

public boolean equals(Object another)

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

Overrides:

equals in class Object

Returns:

true if this is equal to another instance

hashCode

public int hashCode()

Computes a hash code from attributes: name, attemptCurrent, attemptMaximum, fileIndexCurrent, fileIndexMaximum.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value BLProgressFileStarted with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static BLProgressFileStarted copyOf(BLProgressEventType.BLProgressFileStartedType instance)

Creates an immutable copy of a BLProgressEventType.BLProgressFileStartedType 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 BLProgressFileStarted instance

builder

public static BLProgressFileStarted.Builder builder()

Creates a builder for BLProgressFileStarted.

 BLProgressFileStarted.builder()
    .setName(String) // required name
    .setAttemptCurrent(int) // required attemptCurrent
    .setAttemptMaximum(int) // required attemptMaximum
    .setFileIndexCurrent(int) // required fileIndexCurrent
    .setFileIndexMaximum(int) // required fileIndexMaximum
    .build();
 

Returns:

A new BLProgressFileStarted builder