Package com.io7m.jwheatsheaf.api

Class JWFileListingFailed

java.lang.Object

com.io7m.jwheatsheaf.api.JWFileListingFailed

All Implemented Interfaces:

JWFileChooserEventType, JWFileChooserEventType.JWFileChooserEventErrorType, JWFileChooserEventType.JWFileListingFailedType

public final class JWFileListingFailed
extends Object
implements JWFileChooserEventType.JWFileListingFailedType

An error occurred whilst trying to list a directory.

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from interface com.io7m.jwheatsheaf.api.JWFileChooserEventType

JWFileChooserEventType.JWDirectoryCreationFailedType, JWFileChooserEventType.JWFileChooserEventErrorType, JWFileChooserEventType.JWFileListingFailedType

Method Summary

Modifier and Type	Method	Description
static JWFileListingFailed.Builder	builder()	Creates a builder for JWFileListingFailed.
static JWFileListingFailed	copyOf(JWFileChooserEventType.JWFileListingFailedType instance)	Creates an immutable copy of a JWFileChooserEventType.JWFileListingFailedType value.
boolean	equals(Object another)	This instance is equal to all instances of JWFileListingFailed that have equal attribute values.
Exception	exception()
int	hashCode()	Computes a hash code from attributes: path, exception.
static JWFileListingFailed	of(Path path, Exception exception)	Construct a new immutable JWFileListingFailed instance.
Path	path()
String	toString()	Prints the immutable value JWFileListingFailed with attribute values.
final JWFileListingFailed	withException(Exception value)	Copy the current immutable object by setting a value for the exception attribute.
final JWFileListingFailed	withPath(Path value)	Copy the current immutable object by setting a value for the path attribute.

Methods inherited from class java.lang.Object

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

Method Details

path

public Path path()

Specified by:

path in interface JWFileChooserEventType.JWFileChooserEventErrorType

Specified by:

path in interface JWFileChooserEventType.JWFileListingFailedType

Returns:

The directory that could not be listed

exception

public Exception exception()

Specified by:

exception in interface JWFileChooserEventType.JWFileChooserEventErrorType

Specified by:

exception in interface JWFileChooserEventType.JWFileListingFailedType

Returns:

The exception

withPath

public final JWFileListingFailed withPath(Path value)

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

Parameters:

value - A new value for path

Returns:

A modified copy of the this object

withException

public final JWFileListingFailed withException(Exception value)

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

Parameters:

value - A new value for exception

Returns:

A modified copy of the this object

equals

public boolean equals(Object another)

This instance is equal to all instances of JWFileListingFailed 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: path, exception.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value JWFileListingFailed with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

of

public static JWFileListingFailed of(Path path,
 Exception exception)

Construct a new immutable JWFileListingFailed instance.

Parameters:

path - The value for the path attribute

exception - The value for the exception attribute

Returns:

An immutable JWFileListingFailed instance

copyOf

public static JWFileListingFailed copyOf(JWFileChooserEventType.JWFileListingFailedType instance)

Creates an immutable copy of a JWFileChooserEventType.JWFileListingFailedType 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 JWFileListingFailed instance

builder

public static JWFileListingFailed.Builder builder()

Creates a builder for JWFileListingFailed.

 JWFileListingFailed.builder()
    .setPath(java.nio.file.Path) // required path
    .setException(Exception) // required exception
    .build();
 

Returns:

A new JWFileListingFailed builder