AbsentClimateState (ForestryMC 5.8.2.427 API)

java.lang.Object
- forestry.core.climate.AbsentClimateState

All Implemented Interfaces:: IClimateState

@Immutable
public final class AbsentClimateState
extends java.lang.Object
implements IClimateState

Field Summary

Fields
Modifier and Type Field and Description

static AbsentClimateState INSTANCE

Fields
Modifier and Type	Field and Description
`static AbsentClimateState`	`INSTANCE`

Constructor Summary

Constructors
Constructor and Description

AbsentClimateState()

Constructors
Constructor and Description
`AbsentClimateState()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`IClimateState`	`add(IClimateState state)` Adds the given state to this state.
`IClimateState`	`addHumidity(float humidity)` Adds the given value to the humidity value of this state.
`IClimateState`	`addTemperature(float temperature)` Adds the given value to the temperature value of this state.
`IClimateState`	`copy()`
`IClimateState`	`copy(boolean mutable)`
`boolean`	`equals(java.lang.Object obj)`
`float`	`getHumidity()`
`float`	`getTemperature()`
`int`	`hashCode()`
`boolean`	`isClamped()`
`boolean`	`isMutable()`
`boolean`	`isPresent()`
`IClimateState`	`map(java.util.function.Function<java.lang.Float,java.lang.Float> mapper)` Applies the mapper `Function.apply(Object)` on the two climate values of this state.
`IClimateState`	`multiply(double factor)` Multiplies the values of this state with the given factor.
`IClimateState`	`setClimate(float temperature, float humidity)` Sets the humidity and temperature value to the given values.
`IClimateState`	`setHumidity(float humidity)` Sets the humidity value of this state.
`IClimateState`	`setTemperature(float temperature)` Sets the temperature value of this state.
`IClimateState`	`subtract(IClimateState state)` Subtracts the given state from this state.
`IClimateState`	`toImmutable()`
`IClimateState`	`toMutable()`
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface forestry.api.climate.IClimateState
add, getClimate, getHumidityEnum, getTemperatureEnum, setClimate, subtract, subtractHumidity, subtractTemperature

- Field Detail
  - INSTANCE
```
public static final AbsentClimateState INSTANCE
```
- Constructor Detail
  - AbsentClimateState
```
public AbsentClimateState()
```
- Method Detail
  - copy
```
public IClimateState copy()
```
    Specified by:
    
    copy in interface IClimateState
    
    Returns:
    
    The copy of this state if IClimateState.isMutable() of this state is true or returns the immutable state.
  - setTemperature
```
public IClimateState setTemperature(float temperature)
```
    Description copied from interface: IClimateState
    
    Sets the temperature value of this state.
    
    Specified by:
    
    setTemperature in interface IClimateState
    
    Returns:
    
    The absent state if any of the two climate values would be Float.NAN otherwise if this state is IClimateState.isMutable() this state or if it isn't a immutable copy of the state with the new values.
  - setHumidity
```
public IClimateState setHumidity(float humidity)
```
    Description copied from interface: IClimateState
    
    Sets the humidity value of this state.
    
    Specified by:
    
    setHumidity in interface IClimateState
    
    Returns:
    
    The absent state if any of the two climate values would be Float.NAN otherwise if this state is IClimateState.isMutable() this state or if it isn't a immutable copy of the state with the new values.
  - setClimate
```
public IClimateState setClimate(float temperature,
                                float humidity)
```
    Description copied from interface: IClimateState
    
    Sets the humidity and temperature value to the given values.
    
    Specified by:
    
    setClimate in interface IClimateState
    
    Returns:
    
    The absent state if any of the two climate values would be Float.NAN otherwise if this state is IClimateState.isMutable() this state or if it isn't a immutable copy of the state with the new values.
  - addTemperature
```
public IClimateState addTemperature(float temperature)
```
    Description copied from interface: IClimateState
    
    Adds the given value to the temperature value of this state.
    
    Specified by:
    
    addTemperature in interface IClimateState
    
    Returns:
    
    The absent state if any of the two climate values would be Float.NAN otherwise if this state is IClimateState.isMutable() this state or if it isn't a immutable copy of the state with the new values.
  - addHumidity
```
public IClimateState addHumidity(float humidity)
```
    Description copied from interface: IClimateState
    
    Adds the given value to the humidity value of this state.
    
    Specified by:
    
    addHumidity in interface IClimateState
    
    Returns:
    
    The absent state if any of the two climate values would be Float.NAN otherwise if this state is IClimateState.isMutable() this state or if it isn't a immutable copy of the state with the new values.
  - add
```
public IClimateState add(IClimateState state)
```
    Description copied from interface: IClimateState
    
    Adds the given state to this state.
    
    Specified by:
    
    add in interface IClimateState
    
    Returns:
    
    The absent state if any of the two climate values would be Float.NAN otherwise if this state is IClimateState.isMutable() this state or if it isn't a immutable copy of the state with the new values.
  - multiply
```
public IClimateState multiply(double factor)
```
    Description copied from interface: IClimateState
    
    Multiplies the values of this state with the given factor.
    
    Specified by:
    
    multiply in interface IClimateState
    
    Returns:
    
    The absent state if any of the two climate values would be Float.NAN otherwise if this state is IClimateState.isMutable() this state or if it isn't a immutable copy of the state with the new values.
  - subtract
```
public IClimateState subtract(IClimateState state)
```
    Description copied from interface: IClimateState
    
    Subtracts the given state from this state.
    
    Specified by:
    
    subtract in interface IClimateState
    
    Returns:
    
    The absent state if any of the two climate values would be Float.NAN otherwise if this state is IClimateState.isMutable() this state or if it isn't a immutable copy of the state with the new values.
  - map
```
public IClimateState map(java.util.function.Function<java.lang.Float,java.lang.Float> mapper)
```
    Description copied from interface: IClimateState
    
    Applies the mapper Function.apply(Object) on the two climate values of this state.
    
    Specified by:
    
    map in interface IClimateState
    
    Returns:
    
    The absent state if any of the two climate values would be Float.NAN otherwise if this state is IClimateState.isMutable() this state or if it isn't a immutable copy of the state with the new values.
  - isPresent
```
public boolean isPresent()
```
    Specified by:
    
    isPresent in interface IClimateState
    
    Returns:
    
    If any of the two climate values of this state is Float.NAN.
  - isClamped
```
public boolean isClamped()
```
    Specified by:
    
    isClamped in interface IClimateState
    
    Returns:
    
    If the two values of this state are between 0 and 2.0.
    
    See Also:
    
    IClimateStateHelper.clamp(IClimateState)
  - isMutable
```
public boolean isMutable()
```
    Specified by:
    
    isMutable in interface IClimateState
    
    Returns:
    
    If the state is mutable.
  - toImmutable
```
public IClimateState toImmutable()
```
    Specified by:
    
    toImmutable in interface IClimateState
    
    Returns:
    
    A immutable copy of this state of the state is mutable and the state itself if the state is immutable.
  - copy
```
public IClimateState copy(boolean mutable)
```
    Specified by:
    
    copy in interface IClimateState
    
    Parameters:
    
    mutable - If the copy of this state should be mutable or immutable.
    
    Returns:
    
    The copy of this state.
  - toMutable
```
public IClimateState toMutable()
```
    Specified by:
    
    toMutable in interface IClimateState
    
    Returns:
    
    A mutable copy of this state if the state is immutable and the state itself if the state is mutable.
  - getTemperature
```
public float getTemperature()
```
    Specified by:
    
    getTemperature in interface IClimateState
    
    Returns:
    
    Returns the exact temperature value of this climate state.
  - getHumidity
```
public float getHumidity()
```
    Specified by:
    
    getHumidity in interface IClimateState
    
    Returns:
    
    Returns the exact humidity value of this climate state.
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class AbsentClimateState

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface forestry.api.climate.IClimateState

Field Detail

INSTANCE

Constructor Detail

AbsentClimateState

Method Detail

copy

setTemperature

setHumidity

setClimate

addTemperature

addHumidity

add

multiply

subtract

map

isPresent

isClamped

isMutable

toImmutable

copy

toMutable

getTemperature

getHumidity

equals

hashCode

toString