Index

A B C D E F G I L M N O P R S T U V W
All Classes and Interfaces|All Packages|Serialized Form

A

AbsentValueException() - Constructor for exception net.orbyfied.coldlib.util.Result.AbsentValueException

AbsentValueException(String) - Constructor for exception net.orbyfied.coldlib.util.Result.AbsentValueException

AbsentValueException(String, Throwable) - Constructor for exception net.orbyfied.coldlib.util.Result.AbsentValueException

AbsentValueException(Throwable) - Constructor for exception net.orbyfied.coldlib.util.Result.AbsentValueException

addIntermediateConsumer(BiConsumer<I, O>) - Method in class net.orbyfied.coldlib.util.Assembly.Builder

addIntermediateTransformer(Assembly.Transformer<I, O>) - Method in class net.orbyfied.coldlib.util.Assembly.Builder

addResultConsumer(BiConsumer<T, O>) - Method in class net.orbyfied.coldlib.util.Assembly.Builder

addResultTransformer(Assembly.Transformer<T, O>) - Method in class net.orbyfied.coldlib.util.Assembly.Builder

all() - Static method in interface net.orbyfied.coldlib.util.logic.BitFlag

Create a new bit flag which will produce a full bit mask to cover all bits.

asContainer() - Method in interface net.orbyfied.coldlib.util.functional.ThrowingSupplier

Creates a new lazily loaded Container using Container.lazy(Supplier) with this supplier as the loader function.

asForking(BiFunction<Container<V>, V, Container<V>>) - Method in interface net.orbyfied.coldlib.util.Container

asProtected(Predicate<StackTraceElement>, boolean) - Method in interface net.orbyfied.coldlib.util.Container

Assembly<I,T,O> - Class in net.orbyfied.coldlib.util

Pipeline for creating and initializing an instance of type R with options of type O.

Assembly.Builder<I,T,O> - Class in net.orbyfied.coldlib.util

Builder for an assembly.

Assembly.InstanceFactory<T,O> - Interface in net.orbyfied.coldlib.util

Responsible for creating an instance, taking in account the provided options.

Assembly.Line<T,O> - Class in net.orbyfied.coldlib.util

A pipeline or assembly line which will transform the instance of type T by passing it through a line of Assembly.Transformers.

Assembly.Transformer<T,O> - Interface in net.orbyfied.coldlib.util

One transformer/handler in a line.

at(int) - Static method in interface net.orbyfied.coldlib.util.logic.BitFlag

Create a new basic bit flag with a specific bit offset set.

atomic() - Static method in interface net.orbyfied.coldlib.util.Container

A mutable container which stores the current value in an atomic reference making it thread safe.

attempt() - Method in interface net.orbyfied.coldlib.util.functional.ThrowingSupplier

Try to issue the value using issue() and return a successful result when successful, but catch any errors and return a failed result capturing them instead of rethrowing them.

await() - Method in interface net.orbyfied.coldlib.util.Container

await(boolean) - Method in interface net.orbyfied.coldlib.util.Container

Awaits a value in this container if supported.

awaitable() - Method in interface net.orbyfied.coldlib.util.Container

awaitable(Container<V>) - Static method in interface net.orbyfied.coldlib.util.Container

Create a new container wrapping the provided, already existent container, to introduce awaiting functionality.

B

biMap(Function<V, R>, Function<R, V>) - Method in interface net.orbyfied.coldlib.util.Container

biMapped(Container<V>, Function<V, R>, Function<R, V>) - Static method in interface net.orbyfied.coldlib.util.Container

Wraps the given container with a two-way mapping system returning a bi-mapped container, which converts between V and R for setting and getting.

BitFlag - Interface in net.orbyfied.coldlib.util.logic

Represents a flag object, which can be stored in a bit set (integer as well).

build() - Method in class net.orbyfied.coldlib.util.Assembly

Assembles (creates, initializes, prepares) a new instance of type T with the default options.

build() - Method in class net.orbyfied.coldlib.util.Assembly.Builder

Builds a new assembly instance with the specified properties.

build(O) - Method in class net.orbyfied.coldlib.util.Assembly

Assembles (creates, initializes, prepares) a new instance of type T with the provided options (nullable).

builder(Class<I>, Class<T>, Class<O>) - Static method in class net.orbyfied.coldlib.util.Assembly

Create a new builder instance.

C

canAwait() - Method in interface net.orbyfied.coldlib.util.Container

Get if you can await/listen a value.

cloneMutable() - Method in interface net.orbyfied.coldlib.util.Container

Clones this container (copies the value reference) into a new mutable container instance.

ColdLib - Class in net.orbyfied.coldlib

The library instance.

ColdLib(ColdLibProvider) - Constructor for class net.orbyfied.coldlib.ColdLib

ColdLibProvider - Class in net.orbyfied.coldlib

Responsible for loading, bootstrapping and providing ColdLib to the VM.

ColdLibProvider() - Constructor for class net.orbyfied.coldlib.ColdLibProvider

ColdLibService - Class in net.orbyfied.coldlib

ColdLibService(ColdLib, String) - Constructor for class net.orbyfied.coldlib.ColdLibService

constant(T) - Static method in interface net.orbyfied.coldlib.util.functional.ThrowingSupplier

Create a new throwing supplier, which just always returns the provided value.

Container<V> - Interface in net.orbyfied.coldlib.util

A class responsible for holding a value and providing access to that value under certain conditions.

Container.Mutability - Enum Class in net.orbyfied.coldlib.util

Specifies the way

create(O) - Method in interface net.orbyfied.coldlib.util.Assembly.InstanceFactory

Creates an instance of type T with the given options.

createService(Class<S>, String) - Method in class net.orbyfied.coldlib.ColdLib

Creates and registers a new service instance of type sClass with the provided (optional) instance name.

D

defaultOptionProvider - Variable in class net.orbyfied.coldlib.util.Assembly

The function which provides the default options object.

E

enable() - Method in class net.orbyfied.coldlib.ColdLibProvider

Enables the library provider.

error() - Method in class net.orbyfied.coldlib.util.Result

Returns the captured error if present, or null if absent.

F

failed(Throwable) - Static method in class net.orbyfied.coldlib.util.Result

Create a new result signaling that the operation failed with the given error, and no value is present.

FailedException() - Constructor for exception net.orbyfied.coldlib.util.Result.FailedException

finalImmutable(V) - Static method in interface net.orbyfied.coldlib.util.Container

Create a new immutable container with the value already set.

finalizer - Variable in class net.orbyfied.coldlib.util.Assembly

The finalizer function.

FORK - Enum constant in enum class net.orbyfied.coldlib.util.Container.Mutability

Trying to modify the container will fork it into a new instance with the modifications applied.

forking(Container<V>, BiFunction<Container<V>, V, Container<V>>) - Static method in interface net.orbyfied.coldlib.util.Container

Create a new container wrapping the given container instance, which will, when modified, fork the instance, apply modification to the fork, and return the forked instance from the method.

futureImmutable() - Static method in interface net.orbyfied.coldlib.util.Container

Create a new container whose value can only be set once.

G

get() - Static method in class net.orbyfied.coldlib.ColdLib

Get the ColdLib instance from the provider.

get() - Static method in class net.orbyfied.coldlib.ColdLibProvider

Get the library provider instance.

get() - Method in interface net.orbyfied.coldlib.util.Container

Issue the value currently stored.

get() - Method in interface net.orbyfied.coldlib.util.functional.ThrowingSupplier

Get the value by calling the issue() method, and sneakily rethrow any errors to eliminate a throws ... declaration.

getAs(Class<T>) - Method in interface net.orbyfied.coldlib.util.Container

Get the value currently stored casted to type T.

getBitMask() - Method in interface net.orbyfied.coldlib.util.logic.BitFlag

Get the bit mask by shifting one BitFlag.getBitOffset() times to the right.

getBitOffset() - Method in interface net.orbyfied.coldlib.util.logic.BitFlag

Get the offset of the bit this flag uses in a bit set.

getDefaultOptions() - Method in class net.orbyfied.coldlib.util.Assembly

Get the default options if defined.

getDefaultOptionsProvider() - Method in class net.orbyfied.coldlib.util.Assembly.Builder

getFinalizer() - Method in class net.orbyfied.coldlib.util.Assembly.Builder

getInstanceFactory() - Method in class net.orbyfied.coldlib.util.Assembly.Builder

getInstanceName() - Method in class net.orbyfied.coldlib.ColdLibService

getIntermediateTransformers() - Method in class net.orbyfied.coldlib.util.Assembly.Builder

getIntermediateType() - Method in class net.orbyfied.coldlib.util.Assembly

getLibrary() - Static method in class net.orbyfied.coldlib.ColdLibProvider

Get the library instance.

getLog() - Method in class net.orbyfied.coldlib.ColdLibProvider

Get the main event log.

getLogGroup() - Method in class net.orbyfied.coldlib.ColdLibProvider

Get the main event log group.

getMessage() - Method in exception net.orbyfied.coldlib.util.Result.FailedException

getOptionsType() - Method in class net.orbyfied.coldlib.util.Assembly

getResultTransformers() - Method in class net.orbyfied.coldlib.util.Assembly.Builder

getResultType() - Method in class net.orbyfied.coldlib.util.Assembly

getService(Class<S>) - Method in class net.orbyfied.coldlib.ColdLib

Get a registered service by only class.

getService(Class<S>, String) - Method in class net.orbyfied.coldlib.ColdLib

Get a registered service.

getServices() - Method in class net.orbyfied.coldlib.ColdLib

Get the list of registered services.

I

immutable() - Method in interface net.orbyfied.coldlib.util.Container

immutable(Container<V>) - Static method in interface net.orbyfied.coldlib.util.Container

Wraps the provided container to make it immutable.

init() - Method in class net.orbyfied.coldlib.ColdLibProvider

instance() - Method in class net.orbyfied.coldlib.ColdLibProvider

Get the library instance.

instanceFactory - Variable in class net.orbyfied.coldlib.util.Assembly

The instance factory responsible for creating the first instance.

instanceName - Variable in class net.orbyfied.coldlib.ColdLibService

The service instance name.

intermediateLine - Variable in class net.orbyfied.coldlib.util.Assembly

The pipeline to transform the intermediate instance.

isPresent() - Method in class net.orbyfied.coldlib.util.Result

Check if a SUCCESSFUL value is present.

isSet() - Method in interface net.orbyfied.coldlib.util.Container

Get if a value is currently set.

isSuccess() - Method in class net.orbyfied.coldlib.util.Result

Check if an error occurred.

issue() - Method in interface net.orbyfied.coldlib.util.Container

Try to issue the value currently stored, return a successful result containing the value if successful, or failed when an error occurs or the operation simply failed.

issue() - Method in interface net.orbyfied.coldlib.util.functional.ThrowingSupplier

The throwing supplier method.

L

lazy(Supplier<V>) - Static method in interface net.orbyfied.coldlib.util.Container

Create a new container which lazy loads the value using the provided supplier when it is first queried.

lib - Variable in class net.orbyfied.coldlib.ColdLibProvider

The library instance.

lib - Variable in class net.orbyfied.coldlib.ColdLibService

The library instance.

Line(List<Assembly.Transformer<T, O>>) - Constructor for class net.orbyfied.coldlib.util.Assembly.Line

Create a new assembly line.

load() - Method in class net.orbyfied.coldlib.ColdLibProvider

Loads the library provider.

log - Variable in class net.orbyfied.coldlib.ColdLibProvider

The main library log.

logGroup - Variable in class net.orbyfied.coldlib.ColdLibProvider

The library event log group.

M

map(Function<V, R>) - Method in interface net.orbyfied.coldlib.util.Container

mapped(Container<V>, Function<V, R>) - Static method in interface net.orbyfied.coldlib.util.Container

Wraps the given container with the provided mapping function to return an immutable container which maps the queried value of type V to a value of type T.

modifiesInstance() - Method in enum class net.orbyfied.coldlib.util.Container.Mutability

If a container with this mutability will modify the instance it was called on or fork/silently fail.

MODIFY - Enum constant in enum class net.orbyfied.coldlib.util.Container.Mutability

Modifications will not throw an error and go through to affect the original instance it was called on.

mutability() - Method in interface net.orbyfied.coldlib.util.Container

Get this containers mutability.

mutable() - Static method in interface net.orbyfied.coldlib.util.Container

Create a new mutable container instance without a value pre-set.

mutable(V) - Static method in interface net.orbyfied.coldlib.util.Container

Create a new mutable container instance with a value optionally pre-set.

N

net.orbyfied.coldlib - package net.orbyfied.coldlib

net.orbyfied.coldlib.util - package net.orbyfied.coldlib.util

General purpose static utilities.

net.orbyfied.coldlib.util.functional - package net.orbyfied.coldlib.util.functional

net.orbyfied.coldlib.util.logic - package net.orbyfied.coldlib.util.logic

O

of(ThrowingSupplier<T>) - Static method in interface net.orbyfied.coldlib.util.functional.ThrowingSupplier

Helper method to avoid casting when trying to provide a throwing supplier to a method taking in a Supplier.

orElse(V) - Method in class net.orbyfied.coldlib.util.Result

Get the value if present or the provided default/fallback value if absent.

orNull() - Method in class net.orbyfied.coldlib.util.Result

Get the value if present or null if absent.

orRethrow() - Method in class net.orbyfied.coldlib.util.Result

Get the captured value if successful, or rethrow the captured error if failed.

P

protect(Container<V>, Predicate<StackTraceElement>, boolean) - Static method in interface net.orbyfied.coldlib.util.Container

Wraps the given container in an access layer protecting it against denied callers according to the provided stack frame predicate.

provider() - Method in class net.orbyfied.coldlib.ColdLib

Get the library provider that instantiated this library.

push(T, O) - Method in class net.orbyfied.coldlib.util.Assembly.Line

Pushes the given instance through the line transforming it and giving an output instance.

R

referenceService(Class<S>) - Method in class net.orbyfied.coldlib.ColdLib

Get or create a future reference to the specified service instance.

referenceService(Class<S>, String) - Method in class net.orbyfied.coldlib.ColdLib

Get or create a future reference to the specified service instance.

Result<V> - Class in net.orbyfied.coldlib.util

Construct to hold the result of an operation which could have thrown an error.

Result.AbsentValueException - Exception in net.orbyfied.coldlib.util

An exception used by Result when unwrapping the result to signal the absence of a value.

Result.FailedException - Exception in net.orbyfied.coldlib.util

For absent errors.

resultLine - Variable in class net.orbyfied.coldlib.util.Assembly

The pipeline to transform the result instance.

rethrowFailed() - Method in class net.orbyfied.coldlib.util.Result

Rethrow the error if present, or exit and return this instance back if absent.

S

self() - Method in interface net.orbyfied.coldlib.util.Self

Get this casted to type T.

Self<T> - Interface in net.orbyfied.coldlib.util

Interface for stream lining self returning with inherited classes, without complex generics.

set(int, boolean) - Method in interface net.orbyfied.coldlib.util.logic.BitFlag

Set the flag bit to the given value in the provided integer.

set(long, boolean) - Method in interface net.orbyfied.coldlib.util.logic.BitFlag

Set the flag bit to the given value in the provided integer.

set(BitSet, boolean) - Method in interface net.orbyfied.coldlib.util.logic.BitFlag

Set the flag bit to the given value in the provided bit set.

set(V) - Method in interface net.orbyfied.coldlib.util.Container

Set the value stored to val.

setDefaultOptions(O) - Method in class net.orbyfied.coldlib.util.Assembly.Builder

setDefaultOptionsProvider(Supplier<O>) - Method in class net.orbyfied.coldlib.util.Assembly.Builder

setFinalizer(Function<I, T>) - Method in class net.orbyfied.coldlib.util.Assembly.Builder

setInstance(P) - Static method in class net.orbyfied.coldlib.ColdLibProvider

Set the provider instance.

setInstanceFactory(Assembly.InstanceFactory<I, O>) - Method in class net.orbyfied.coldlib.util.Assembly.Builder

setIntermediateTransformers(List<Assembly.Transformer<I, O>>) - Method in class net.orbyfied.coldlib.util.Assembly.Builder

setResultTransformers(List<Assembly.Transformer<T, O>>) - Method in class net.orbyfied.coldlib.util.Assembly.Builder

sneakyThrow(Throwable) - Static method in class net.orbyfied.coldlib.util.Throwables

Allows sneakily throwing an exception: This means any exception can be thrown without having to declare it in the method declaration.

success(V) - Static method in class net.orbyfied.coldlib.util.Result

Create a new success result, with a nullable value.

T

Throwables - Class in net.orbyfied.coldlib.util

Utilities for dealing with throwables.

ThrowingSupplier<T> - Interface in net.orbyfied.coldlib.util.functional

A supplier of a value, but declaring any throwables that might be thrown.

throwsError() - Method in enum class net.orbyfied.coldlib.util.Container.Mutability

Will the call throw an error on a container with this mutability.

toBuilder() - Method in class net.orbyfied.coldlib.util.Assembly

Creates a new builder with the properties of this instance set.

transform(T, O) - Method in interface net.orbyfied.coldlib.util.Assembly.Transformer

Transforms the given instance, may either return the instance back or an entirely new instance.

transformers - Variable in class net.orbyfied.coldlib.util.Assembly.Line

The transformers in the assembly line.

tryOrNull() - Method in interface net.orbyfied.coldlib.util.functional.ThrowingSupplier

Try to issue the value using issue(), but catch any errors and return null instead of rethrowing them.

U

unload() - Method in class net.orbyfied.coldlib.ColdLibProvider

Unloads the library provider.

UNSUPPORTED - Enum constant in enum class net.orbyfied.coldlib.util.Container.Mutability

Trying to mutate the container will throw an error.

unwrap() - Method in class net.orbyfied.coldlib.util.Result

Get and return the value if present, or throw with a description if absent.

V

valueOf(String) - Static method in enum class net.orbyfied.coldlib.util.Container.Mutability

Returns the enum constant of this class with the specified name.

values() - Static method in enum class net.orbyfied.coldlib.util.Container.Mutability

Returns an array containing the constants of this enum class, in the order they are declared.

W

withService(S) - Method in class net.orbyfied.coldlib.ColdLib

Registers the provided service to this ColdLib instance.

A B C D E F G I L M N O P R S T U V W
All Classes and Interfaces|All Packages|Serialized Form