ninja.leaping.configurate.Types

public final class Types
extends Object

Contains functions useful for performing configuration type conversions.

The naming scheme is as follows:

as methods attempt to convert the data passed to the appropriate type
strictAs methods will only return values if the input value is already of an appropriate type

Method Summary

Modifier and Type	Method	Description
`static @Nullable Boolean`	`asBoolean(@Nullable Object value)`	Attempts to convert `value` to a `Boolean`.
`static @Nullable Double`	`asDouble(@Nullable Object value)`	Attempts to convert `value` to a `Double`.
`static @Nullable Float`	`asFloat(@Nullable Object value)`	Attempts to convert `value` to a `Float`.
`static @Nullable Integer`	`asInt(@Nullable Object value)`	Attempts to convert `value` to a `Integer`.
`static @Nullable Long`	`asLong(@Nullable Object value)`	Attempts to convert `value` to a `Long`.
`static @Nullable String`	`asString(@Nullable Object value)`	Attempts to convert `value` to a `String`.
`static @Nullable Boolean`	`strictAsBoolean(@Nullable Object value)`	Returns `value` if it is a `Boolean`.
`static @Nullable Double`	`strictAsDouble(@Nullable Object value)`	Returns `value` if it is a `Double`.
`static @Nullable Float`	`strictAsFloat(@Nullable Object value)`	Returns `value` if it is a `Float`.
`static @Nullable Integer`	`strictAsInt(@Nullable Object value)`	Returns `value` if it is a `Integer`.
`static @Nullable Long`	`strictAsLong(@Nullable Object value)`	Returns `value` if it is a `Long`.
`static @Nullable String`	`strictAsString(@Nullable Object value)`	Returns `value` if it is a `String`.

Methods inherited from class java.lang.Object

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

Method Details
- asString
  
  public static @Nullable String asString(@Nullable Object value)
  
  Attempts to convert value to a String.
  Returns null if value is null, and the Object.toString() representation of value otherwise.
  
  Parameters:
  
  value - The value
  
  Returns:
  
  value as a String, or null
  
  See Also:
  
  Object.toString()
- strictAsString
  
  public static @Nullable String strictAsString(@Nullable Object value)
  
  Returns value if it is a String.
  
  Parameters:
  
  value - The value
  
  Returns:
  
  value as a String, or null
- asFloat
  
  public static @Nullable Float asFloat(@Nullable Object value)
  
  Attempts to convert value to a Float.
  Returns null if value is null.
  
  This method will attempt to cast value to Float, or parse the value if it is a String.
  
  Parameters:
  
  value - The value
  
  Returns:
  
  value as a Float, or null
- strictAsFloat
  
  public static @Nullable Float strictAsFloat(@Nullable Object value)
  
  Returns value if it is a Float.
  
  Parameters:
  
  value - The value
  
  Returns:
  
  value as a Float, or null
- asDouble
  
  public static @Nullable Double asDouble(@Nullable Object value)
  
  Attempts to convert value to a Double.
  Returns null if value is null.
  
  This method will attempt to cast value to Double, or parse the value if it is a String.
  
  Parameters:
  
  value - The value
  
  Returns:
  
  value as a Float, or null
- strictAsDouble
  
  public static @Nullable Double strictAsDouble(@Nullable Object value)
  
  Returns value if it is a Double.
  
  Parameters:
  
  value - The value
  
  Returns:
  
  value as a Double, or null
- asInt
  
  public static @Nullable Integer asInt(@Nullable Object value)
  
  Attempts to convert value to a Integer.
  Returns null if value is null.
  
  This method will attempt to cast value to Integer, or parse the value if it is a String.
  
  Parameters:
  
  value - The value
  
  Returns:
  
  value as a Float, or null
- strictAsInt
  
  public static @Nullable Integer strictAsInt(@Nullable Object value)
  
  Returns value if it is a Integer.
  
  Parameters:
  
  value - The value
  
  Returns:
  
  value as a Integer, or null
- asLong
  
  public static @Nullable Long asLong(@Nullable Object value)
  
  Attempts to convert value to a Long.
  Returns null if value is null.
  
  This method will attempt to cast value to Long, or parse the value if it is a String.
  
  Parameters:
  
  value - The value
  
  Returns:
  
  value as a Float, or null
- strictAsLong
  
  public static @Nullable Long strictAsLong(@Nullable Object value)
  
  Returns value if it is a Long.
  
  Parameters:
  
  value - The value
  
  Returns:
  
  value as a Long, or null
- asBoolean
  
  public static @Nullable Boolean asBoolean(@Nullable Object value)
  Attempts to convert value to a Boolean.
  
  If value is a Boolean, casts and returns
  
  If value is a Number, returns true if value is not 0
  
  If value.toString() returns true, t, yes, y, or 1, returns true
  
  If value.toString() returns false, f, no, n, or 0, returns false
  
  Otherwise returns null
  Parameters:
  
  value - The value
  
  Returns:
  
  value as a Boolean, or null
- strictAsBoolean
  
  public static @Nullable Boolean strictAsBoolean(@Nullable Object value)
  
  Returns value if it is a Boolean.
  
  Parameters:
  
  value - The value
  
  Returns:
  
  value as a Boolean, or null

Class Types

Method Summary

Methods inherited from class java.lang.Object

Method Details