Module io.jstach.rainbowgum

Package io.jstach.rainbowgum

Interface LogProviderRef

public sealed interface LogProviderRef

Log LogProvider Source.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	LogProviderRef.NotFoundException	Thrown if a provider could not be found for the ref.

Method Summary

Modifier and Type	Method	Description
@Nullable String	keyOrNull()	Property key from where the URI came from or null.
static LogProviderRef	of(LogProperty.Result.Success<? extends URI> property)	Create a provider ref from a property result.
static LogProviderRef	of(URI uri)	Creates a log provider ref from URI.
static LogProviderRef	of(URI uri, @Nullable String key)	Creates a log provider ref from URI.
URI	uri()	URI of the log provider.

Method Details

uri

URI uri()

URI of the log provider.

Returns:

uri not null.

keyOrNull

@Nullable String keyOrNull()

Property key from where the URI came from or null.

Returns:

property key.

of

static LogProviderRef of(URI uri)

Creates a log provider ref from URI.

Parameters:

uri - uri.

Returns:

ref.

of

static LogProviderRef of(LogProperty.Result.Success<? extends URI> property)

Create a provider ref from a property result.

Parameters:

property - successful URI result.

Returns:

provider ref.

of

static LogProviderRef of(URI uri,
 @Nullable String key)

Creates a log provider ref from URI.

Parameters:

uri - uri.

key - property key where URI came from.

Returns:

ref.