Module watamebot

Package net.foxgenesis.watame.property

Class GuildProperty

java.lang.Object

net.foxgenesis.watame.property.GuildProperty

All Implemented Interfaces:

IPropertyField<String,net.dv8tion.jda.api.entities.Guild,IGuildPropertyMapping>

public class GuildProperty
extends Object
implements IPropertyField<String,net.dv8tion.jda.api.entities.Guild,IGuildPropertyMapping>

Constructor Summary

Constructors

Constructor	Description
GuildProperty(String key, IGuildDataProvider database)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
IGuildPropertyMapping	get(net.dv8tion.jda.api.entities.Guild from)	Get this property's data wrapped in an IPropertyMapping.
String	getKey()	Get the key pointing to the property.
int	hashCode()
boolean	isEditable()	Check if this property is end user editable.
boolean	isPresent(net.dv8tion.jda.api.entities.Guild from)	Check if this property is present.
boolean	set(net.dv8tion.jda.api.entities.Guild from, Object value)	Update/Set this property's value.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.foxgenesis.property.IPropertyField

get, get, get, set

Constructor Details

GuildProperty

public GuildProperty(String key,
 IGuildDataProvider database)

Method Details

get

@CheckForNull
public IGuildPropertyMapping get(@Nonnull
 net.dv8tion.jda.api.entities.Guild from)

Description copied from interface: IPropertyField

Get this property's data wrapped in an IPropertyMapping.

Specified by:

get in interface IPropertyField<String,net.dv8tion.jda.api.entities.Guild,IGuildPropertyMapping>

Parameters:

from - - property lookup data

Returns:

The property's data inside an IPropertyMapping

set

public boolean set(net.dv8tion.jda.api.entities.Guild from,
 @Nullable
 Object value)

Description copied from interface: IPropertyField

Update/Set this property's value.

Specified by:

set in interface IPropertyField<String,net.dv8tion.jda.api.entities.Guild,IGuildPropertyMapping>

Parameters:

from - - property lookup data

value - - the new value

Returns:

Returns true if the property was updated successfully

See Also:

• IPropertyField.set(Object, Object, boolean)

getKey

@Nonnull
public String getKey()

Description copied from interface: IPropertyField

Get the key pointing to the property.

Specified by:

getKey in interface IPropertyField<String,net.dv8tion.jda.api.entities.Guild,IGuildPropertyMapping>

Returns:

The property's key

isEditable

public boolean isEditable()

Description copied from interface: IPropertyField

Check if this property is end user editable.

Specified by:

isEditable in interface IPropertyField<String,net.dv8tion.jda.api.entities.Guild,IGuildPropertyMapping>

Returns:

Returns true if this property is allowed to be modified by the end user

isPresent

public boolean isPresent(net.dv8tion.jda.api.entities.Guild from)

Description copied from interface: IPropertyField

Check if this property is present.

Specified by:

isPresent in interface IPropertyField<String,net.dv8tion.jda.api.entities.Guild,IGuildPropertyMapping>

Parameters:

from - - lookup data

Returns:

Returns true if the property was found using the provided lookup data

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(@Nullable
 Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object