com.pixelmonmod.pixelmon.battles.api.rules.property

Class TierProperty

java.lang.Object

com.pixelmonmod.pixelmon.battles.api.rules.property.TierProperty

All Implemented Interfaces:

BattleProperty<Tier>

public class TierProperty
extends java.lang.Object
implements BattleProperty<Tier>

Constructor Summary

Constructors

Constructor and Description
TierProperty()

Method Summary

Modifier and Type	Method and Description
java.util.Optional<PropertyValue<Tier>>	getDefault() Gets the default value when not supplied If returning an empty optional this means it isn't always required
java.lang.String	getId() The id of the property
PropertyValue<Tier>	getInstance() Gets a new instanceof the PropertyValue
java.util.Optional<PropertyValue<Tier>>	parse(java.lang.Object o) Attempts to parse the object into a PropertyValue Will return Optional.empty() if fails to parse
boolean	requiredByClient() If the property's value is required by the client for UI logic

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TierProperty

public TierProperty()

Method Detail

getId

public java.lang.String getId()

Description copied from interface: BattleProperty

The id of the property

Specified by:

getId in interface BattleProperty<Tier>

Returns:

The id

requiredByClient

public boolean requiredByClient()

Description copied from interface: BattleProperty

If the property's value is required by the client for UI logic

Specified by:

requiredByClient in interface BattleProperty<Tier>

Returns:

True if required by the client

parse

public java.util.Optional<PropertyValue<Tier>> parse(java.lang.Object o)

Description copied from interface: BattleProperty

Attempts to parse the object into a PropertyValue Will return Optional.empty() if fails to parse

Specified by:

parse in interface BattleProperty<Tier>

Parameters:

o - The object being parsed

Returns:

The optional PropertyValue

getDefault

public java.util.Optional<PropertyValue<Tier>> getDefault()

Description copied from interface: BattleProperty

Gets the default value when not supplied If returning an empty optional this means it isn't always required

Specified by:

getDefault in interface BattleProperty<Tier>

Returns:

The default Optional>

getInstance

public PropertyValue<Tier> getInstance()

Description copied from interface: BattleProperty

Gets a new instanceof the PropertyValue

Specified by:

getInstance in interface BattleProperty<Tier>

Returns:

The new value instance