org.dayflower.pathtracer.application

Class AbstractApplication.Setting

java.lang.Object

org.dayflower.pathtracer.application.AbstractApplication.Setting

Enclosing class:

AbstractApplication

public static final class AbstractApplication.Setting
extends java.lang.Object

A Setting represents a setting that can be enabled or disabled.

Since:

1.0.0

Author:

Jörgen Lundgren

Constructor Summary

Constructors

Constructor and Description
Setting(java.lang.String name) Constructs a new Setting instance.
Setting(java.lang.String name, boolean isEnabled) Constructs a new Setting instance.

Method Summary

Modifier and Type	Method and Description
void	disable() Disables this Setting instance.
void	enable() Enables this Setting instance.
boolean	equals(java.lang.Object object) Compares object to this Setting instance for equality.
java.lang.String	getName() Returns the name of this Setting instance.
int	hashCode() Returns a hash code for this Setting instance.
boolean	isDisabled() Returns true if, and only if, this Setting is disabled, false otherwise.
boolean	isEnabled() Returns true if, and only if, this Setting is enabled, false otherwise.
void	set(boolean isEnabled) Enables or disables this Setting instance.
void	toggle() Toggles this Setting instance.
java.lang.String	toString() Returns a String representation of this Setting instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

Setting

public Setting(java.lang.String name)

Constructs a new Setting instance.

Calling this constructor is equivalent to calling new Setting(name, false).

If name is null, a NullPointerException will be thrown.

Parameters:

name - the name to use

Throws:

java.lang.NullPointerException - thrown if, and only if, name is null

Setting

public Setting(java.lang.String name,
               boolean isEnabled)

Constructs a new Setting instance.

If name is null, a NullPointerException will be thrown.

Parameters:

name - the name to use

isEnabled - true if enabled, false otherwise

Throws:

java.lang.NullPointerException - thrown if, and only if, name is null

Method Detail

getName

public java.lang.String getName()

Returns the name of this Setting instance.

Returns:

the name of this Setting instance

toString

public java.lang.String toString()

Returns a String representation of this Setting instance.

Overrides:

toString in class java.lang.Object

Returns:

a String representation of this Setting instance

equals

public boolean equals(java.lang.Object object)

Compares object to this Setting instance for equality.

Returns true if, and only if, object is an instance of Setting, and their respective values are equal, false otherwise.

Overrides:

equals in class java.lang.Object

Parameters:

object - the Object to compare to this Setting instance for equality

Returns:

true if, and only if, object is an instance of Setting, and their respective values are equal, false otherwise

isDisabled

public boolean isDisabled()

Returns true if, and only if, this Setting is disabled, false otherwise.

Returns:

true if, and only if, this Setting is disabled, false otherwise

isEnabled

public boolean isEnabled()

Returns true if, and only if, this Setting is enabled, false otherwise.

Returns:

true if, and only if, this Setting is enabled, false otherwise

hashCode

public int hashCode()

Returns a hash code for this Setting instance.

Overrides:

hashCode in class java.lang.Object

Returns:

a hash code for this Setting instance

disable

public void disable()

Disables this Setting instance.

enable

public void enable()

Enables this Setting instance.

set

public void set(boolean isEnabled)

Enables or disables this Setting instance.

Parameters:

isEnabled - true if enabled, false otherwise

toggle

public void toggle()

Toggles this Setting instance.