Package net.minecraftforge.fml
Class OptionalMod<T>
java.lang.Object
net.minecraftforge.fml.OptionalMod<T>
-
Field Summary
-
Constructor Summary
ModifierConstructorDescriptionprivate
OptionalMod
(boolean searched) private
OptionalMod
(String modId) -
Method Summary
Modifier and TypeMethodDescriptionprivate static <T> OptionalMod<T>
empty()
boolean
If a mod object is present, and the mod object matches the given predicate, return anOptionalMod
describing the value, otherwise return an emptyOptionalMod
.<U> Optional<U>
If a value is present, apply the providedOptional
-bearing mapping function to it, return that result, otherwise return an emptyOptional
.get()
If a mod is present in thisOptionalMod
, returns the value, otherwise throwsNoSuchElementException
.getModId()
private T
getValue()
int
hashCode()
void
If a mod object is present, invoke the specified consumer with the object, otherwise do nothing.boolean
Returntrue
if there is a mod object present, otherwisefalse
.<U> Optional<U>
If a mod object is present, apply the provided mapping function to it, and if the result is non-null, return anOptional
describing the result.static <M> OptionalMod<M>
Return the mod object if present, otherwise returnother
.Return the mod object if present, otherwise invokeother
and return the result of that invocation.orElseThrow
(Supplier<? extends X> exceptionSupplier) Return the contained mod object, if present, otherwise throw an exception to be created by the provided supplier.
-
Field Details
-
modId
-
value
-
searched
private boolean searched -
EMPTY
-
-
Constructor Details
-
OptionalMod
private OptionalMod(boolean searched) -
OptionalMod
-
-
Method Details
-
of
-
empty
-
getValue
-
get
If a mod is present in thisOptionalMod
, returns the value, otherwise throwsNoSuchElementException
.- Returns:
- the modobject held by this
OptionalMod
- Throws:
NoSuchElementException
- if there is no modobject present- See Also:
-
getModId
-
isPresent
public boolean isPresent()Returntrue
if there is a mod object present, otherwisefalse
.- Returns:
true
if there is a mod object present, otherwisefalse
-
ifPresent
If a mod object is present, invoke the specified consumer with the object, otherwise do nothing.- Parameters:
consumer
- block to be executed if a mod object is present- Throws:
NullPointerException
- if mod object is present andconsumer
is null
-
filter
If a mod object is present, and the mod object matches the given predicate, return anOptionalMod
describing the value, otherwise return an emptyOptionalMod
.- Parameters:
predicate
- a predicate to apply to the mod object, if present- Returns:
- an
OptionalMod
describing the value of thisOptionalMod
if a mod object is present and the mod object matches the given predicate, otherwise an emptyOptionalMod
- Throws:
NullPointerException
- if the predicate is null
-
map
If a mod object is present, apply the provided mapping function to it, and if the result is non-null, return anOptional
describing the result. Otherwise return an emptyOptional
.- Type Parameters:
U
- The type of the result of the mapping function- Parameters:
mapper
- a mapping function to apply to the mod object, if present- Returns:
- an
Optional
describing the result of applying a mapping function to the mod object of thisOptionalMod
, if a mod object is present, otherwise an emptyOptional
- Throws:
NullPointerException
- if the mapping function is null
-
flatMap
If a value is present, apply the providedOptional
-bearing mapping function to it, return that result, otherwise return an emptyOptional
. This method is similar tomap(Function)
, but the provided mapper is one whose result is already anOptional
, and if invoked,flatMap
does not wrap it with an additionalOptional
.- Type Parameters:
U
- The type parameter to theOptional
returned by- Parameters:
mapper
- a mapping function to apply to the mod object, if present the mapping function- Returns:
- the result of applying an
Optional
-bearing mapping function to the value of thisOptional
, if a value is present, otherwise an emptyOptional
- Throws:
NullPointerException
- if the mapping function is null or returns a null result
-
orElse
Return the mod object if present, otherwise returnother
.- Parameters:
other
- the mod object to be returned if there is no mod object present, may be null- Returns:
- the mod object, if present, otherwise
other
-
orElseGet
Return the mod object if present, otherwise invokeother
and return the result of that invocation.- Parameters:
other
- aSupplier
whose result is returned if no mod object is present- Returns:
- the mod object if present otherwise the result of
other.get()
- Throws:
NullPointerException
- if mod object is not present andother
is null
-
orElseThrow
Return the contained mod object, if present, otherwise throw an exception to be created by the provided supplier.- Type Parameters:
X
- Type of the exception to be thrown- Parameters:
exceptionSupplier
- The supplier which will return the exception to be thrown- Returns:
- the present mod object
- Throws:
X
- if there is no mod object presentNullPointerException
- if no mod object is present andexceptionSupplier
is null
-
equals
-
hashCode
public int hashCode()
-