Index
All Classes and Interfaces|All Packages|Serialized Form
A
- addFilter(Predicate<Meta>) - Method in interface io.github.jonloucks.metalog.api.Filterable
-
Add a new filter
- asList() - Method in interface io.github.jonloucks.metalog.api.Entities
-
Create a new List containing all the entities in the proper order
B
- block() - Method in interface io.github.jonloucks.metalog.api.Meta.Builder
-
Enables block mode.
- block(boolean) - Method in interface io.github.jonloucks.metalog.api.Meta.Builder
-
Set the block mode for the Meta
C
- channel(String) - Method in interface io.github.jonloucks.metalog.api.Meta.Builder
-
Set the channel for the Meta
- Console - Interface in io.github.jonloucks.metalog.api
-
Responsible for the special logging case of System out and System err It is both a Subscriber and Publisher
- CONSUMED - Enum constant in enum class io.github.jonloucks.metalog.api.Outcome
-
Known consumption of the log message
- CONTRACT - Static variable in interface io.github.jonloucks.metalog.api.Console
-
The Contract for the Console.
- CONTRACT - Static variable in interface io.github.jonloucks.metalog.api.Metalog
-
Access the current Metalog implementation
- CONTRACT - Static variable in interface io.github.jonloucks.metalog.api.MetalogFactory
-
Used to promise and claim the MetalogFactory implementation
- contracts() - Method in interface io.github.jonloucks.metalog.api.Metalog.Config
- contracts(Contracts) - Method in interface io.github.jonloucks.metalog.api.Metalog.Config.Builder
- copy(Entity) - Method in interface io.github.jonloucks.metalog.api.Entity.Builder
-
Copies non-empty values from an existing Entity
- copy(Meta) - Method in interface io.github.jonloucks.metalog.api.Meta.Builder
-
Copy the non-empty values from the given Meta
- correlation(Entity) - Method in interface io.github.jonloucks.metalog.api.Entity.Builder
-
Add a correlation Entity
- correlation(Consumer<Entity.Builder<?>>) - Method in interface io.github.jonloucks.metalog.api.Entity.Builder
-
Add a correlation Entity
- correlations(Consumer<Entities.Builder<?>>) - Method in interface io.github.jonloucks.metalog.api.Entity.Builder
-
Set correlations via created Entities.Builder
- create(Metalog.Config) - Method in interface io.github.jonloucks.metalog.api.MetalogFactory
-
Create a new instance of Metalog
- create(Consumer<Metalog.Config.Builder>) - Method in interface io.github.jonloucks.metalog.api.MetalogFactory
- createMetalog(Metalog.Config) - Static method in class io.github.jonloucks.metalog.api.GlobalMetalog
D
- DEFAULT - Static variable in interface io.github.jonloucks.metalog.api.Meta
-
Can be used when logging without any meta information
- DEFAULT - Static variable in interface io.github.jonloucks.metalog.api.Metalog.Config
-
The default configuration used when creating a new Metalog instance
- dispatch(Meta, Runnable) - Method in interface io.github.jonloucks.metalog.api.Dispatcher
-
Responsible for delegating processing log messages dispatching
- DISPATCHED - Enum constant in enum class io.github.jonloucks.metalog.api.Outcome
-
Dispatched asynchronously and will likely be consumed in the future
- Dispatcher - Interface in io.github.jonloucks.metalog.api
-
Responsible for delegating processing log messages dispatching
E
- Entities - Interface in io.github.jonloucks.metalog.api
-
Contains zero or more Entity instances Supports both unique and duplicate entities, determined by the entity name and unique fields.
- Entities.Builder<B extends Entities.Builder<B>> - Interface in io.github.jonloucks.metalog.api
-
The Entities Builder
- entity(Entity) - Method in interface io.github.jonloucks.metalog.api.Entities.Builder
-
Add an entity
- entity(Consumer<Entity.Builder<?>>) - Method in interface io.github.jonloucks.metalog.api.Entities.Builder
-
Add an entity via a builder consumer
- Entity - Interface in io.github.jonloucks.metalog.api
-
A generalized representation of anything
- Entity.Builder<B extends Entity.Builder<B>> - Interface in io.github.jonloucks.metalog.api
-
Responsible for providing an easy way to build a meta instance used when logging
- error(Log) - Method in interface io.github.jonloucks.metalog.api.Console
-
Publishes the log with Console error meta
F
- FACTORY - Static variable in interface io.github.jonloucks.metalog.api.Entities.Builder
-
Entities Builder Factory Contract
- FACTORY - Static variable in interface io.github.jonloucks.metalog.api.Entity.Builder
-
Used to promise and claim the Entity.Builder implementation
- FACTORY - Static variable in interface io.github.jonloucks.metalog.api.Meta.Builder
-
Used to promise and claim the Meta.Builder implementation
- FACTORY - Static variable in interface io.github.jonloucks.metalog.api.Metalog.Config.Builder
- Filterable - Interface in io.github.jonloucks.metalog.api
-
Responsible for combining many predicates into one
- findAllIf(Predicate<? super Entity>) - Method in interface io.github.jonloucks.metalog.api.Entities
-
Finds all entities matching a filter
- findAllValuesWithType(Predicate<? super Entity>, Class<T>) - Method in interface io.github.jonloucks.metalog.api.Entities
-
Finds all the values of each entity matching a filter and has the correct type
- findFirstIf(Predicate<? super Entity>) - Method in interface io.github.jonloucks.metalog.api.Entities
-
Finds the first entity matching a filter
- findFirstValueWithType(Predicate<? super Entity>, Class<T>) - Method in interface io.github.jonloucks.metalog.api.Entities
-
Finds the value of the first entity matching a filter and has the correct type
- findMetalogFactory(Metalog.Config) - Static method in class io.github.jonloucks.metalog.api.GlobalMetalog
-
Finds the MetalogFactory implementation
G
- get() - Method in interface io.github.jonloucks.metalog.api.Log
- getChannel() - Method in interface io.github.jonloucks.metalog.api.Meta
-
User defined value to help subscribers determine how to process a log message Common values would be "info", "warn", "error", "trace", "debug" In addition System err and System out get redirected to System
- getCorrelations() - Method in interface io.github.jonloucks.metalog.api.Entity
-
The optional correlations for this entity Examples: An entity representing the support contact information for error
- getId() - Method in interface io.github.jonloucks.metalog.api.Entity
-
The optional user defined id for this entity Examples: thread id, tenant id, etc
- getInstance() - Static method in class io.github.jonloucks.metalog.api.GlobalMetalog
-
Return the global instance of Contracts
- getKey() - Method in interface io.github.jonloucks.metalog.api.Meta
-
Optional key to ensure ordering of messages.
- getName() - Method in interface io.github.jonloucks.metalog.api.Entity
-
The optional user defined name for this entity Examples: "myModule", "thread", "time", "thrown"
- getThread() - Method in interface io.github.jonloucks.metalog.api.Meta
-
The optional thread correlated to a log message
- getThrown() - Method in interface io.github.jonloucks.metalog.api.Meta
-
The optional exception correlated to a log message
- getTime() - Method in interface io.github.jonloucks.metalog.api.Meta
-
The optional time the log message was published
- getValue() - Method in interface io.github.jonloucks.metalog.api.Entity
-
The optional user defined value for this entity Examples: the thrown exception
- GlobalMetalog - Class in io.github.jonloucks.metalog.api
-
Globally shared Metalog singleton
I
- id(String) - Method in interface io.github.jonloucks.metalog.api.Entity.Builder
-
Set the id for the Entity
- id(String) - Method in interface io.github.jonloucks.metalog.api.Meta.Builder
-
Set the id for the Meta
- install(Metalog.Config, Repository) - Method in interface io.github.jonloucks.metalog.api.MetalogFactory
- io.github.jonloucks.metalog.api - module io.github.jonloucks.metalog.api
-
The API module for Metalog
- io.github.jonloucks.metalog.api - package io.github.jonloucks.metalog.api
- isBlocking() - Method in interface io.github.jonloucks.metalog.api.Meta
-
if true the
Log.get()will be invoked immediately (if needed). - isEmpty() - Method in interface io.github.jonloucks.metalog.api.Entities
- isUnique() - Method in interface io.github.jonloucks.metalog.api.Entity
K
- key(String) - Method in interface io.github.jonloucks.metalog.api.Meta.Builder
-
Set the key for the Meta
- KEYED_FACTORY - Static variable in interface io.github.jonloucks.metalog.api.Dispatcher
-
Dispatcher tuned for Log messages with sequence keys, normally a one-to-one relationship.
- keyedQueueLimit() - Method in interface io.github.jonloucks.metalog.api.Metalog.Config
-
The limit on how many log messages can be queued for processing If the subscribers get behind.
- keyedQueueLimit(int) - Method in interface io.github.jonloucks.metalog.api.Metalog.Config.Builder
L
- Log - Interface in io.github.jonloucks.metalog.api
-
Responsible for producing the text for a log message.
M
- Meta - Interface in io.github.jonloucks.metalog.api
-
The meta information for a log message
- Meta.Builder<B extends Meta.Builder<B> & Entity.Builder<B>> - Interface in io.github.jonloucks.metalog.api
-
Responsible for providing an easy way to build a meta instance used when logging
- Metalog - Interface in io.github.jonloucks.metalog.api
-
The Metalog API
- Metalog.Config - Interface in io.github.jonloucks.metalog.api
-
The configuration used to create a new Metalog instance.
- Metalog.Config.Builder - Interface in io.github.jonloucks.metalog.api
- MetalogException - Exception in io.github.jonloucks.metalog.api
-
Runtime exception thrown for Metalog related problems.
- MetalogException(String) - Constructor for exception io.github.jonloucks.metalog.api.MetalogException
-
Passthrough for
RuntimeException(String) - MetalogException(String, Throwable) - Constructor for exception io.github.jonloucks.metalog.api.MetalogException
-
Passthrough for
RuntimeException(String, Throwable) - MetalogFactory - Interface in io.github.jonloucks.metalog.api
-
Responsible for creating new instances of Metalog
N
- name(String) - Method in interface io.github.jonloucks.metalog.api.Entity.Builder
-
Set the name for the Entity
- name(String) - Method in interface io.github.jonloucks.metalog.api.Meta.Builder
-
Set the name for the Meta
O
- Outcome - Enum Class in io.github.jonloucks.metalog.api
-
Publish outcode
- output(Log) - Method in interface io.github.jonloucks.metalog.api.Console
-
Publishes the log with Console info meta
P
- publish(Log) - Method in interface io.github.jonloucks.metalog.api.Console
- publish(Log) - Static method in class io.github.jonloucks.metalog.api.GlobalMetalog
-
Publish a log message with the default meta information.
- publish(Log) - Method in interface io.github.jonloucks.metalog.api.Publisher
-
Publish a log message with the default meta information.
- publish(Log, Meta) - Static method in class io.github.jonloucks.metalog.api.GlobalMetalog
-
Publish a log message and it's included meta information.
- publish(Log, Meta) - Method in interface io.github.jonloucks.metalog.api.Publisher
-
Publish a log message and it's included meta information.
- publish(Log, Consumer<Meta.Builder<?>>) - Static method in class io.github.jonloucks.metalog.api.GlobalMetalog
-
Publish a log message with the meta initialized in a callback
- publish(Log, Consumer<Meta.Builder<?>>) - Method in interface io.github.jonloucks.metalog.api.Publisher
-
Publish a log message with the meta initialized in a callback
- Publisher - Interface in io.github.jonloucks.metalog.api
-
Responsible for publishing log messages
R
- receive(Log, Meta) - Method in interface io.github.jonloucks.metalog.api.Subscriber
-
Invoked for each published log message
- reflectionClassName() - Method in interface io.github.jonloucks.metalog.api.Metalog.Config
- reflectionClassName(String) - Method in interface io.github.jonloucks.metalog.api.Metalog.Config.Builder
- REJECTED - Enum constant in enum class io.github.jonloucks.metalog.api.Outcome
-
The publisher can't fulfill the request, for example during shutdown
- removeIf(Predicate<? super Entity>) - Method in interface io.github.jonloucks.metalog.api.Entities.Builder
-
Removes each entity that matches a filter
- replaceIf(Predicate<? super Entity>, Entity) - Method in interface io.github.jonloucks.metalog.api.Entities.Builder
-
Replaces each entity that matches a filter with a replacement entity
S
- serviceLoaderClass() - Method in interface io.github.jonloucks.metalog.api.Metalog.Config
- serviceLoaderClass(Class<? extends MetalogFactory>) - Method in interface io.github.jonloucks.metalog.api.Metalog.Config.Builder
- shutdownTimeout() - Method in interface io.github.jonloucks.metalog.api.Metalog.Config
-
How long to wait for logging to shut down before giving up
- shutdownTimeout(Duration) - Method in interface io.github.jonloucks.metalog.api.Metalog.Config.Builder
- size() - Method in interface io.github.jonloucks.metalog.api.Entities
- SKIPPED - Enum constant in enum class io.github.jonloucks.metalog.api.Outcome
-
Skipped because of filters or no subscribers are interested in the Meta
- subscribe(Subscriber) - Static method in class io.github.jonloucks.metalog.api.GlobalMetalog
-
Add a new log subscription
- subscribe(Subscriber) - Method in interface io.github.jonloucks.metalog.api.Metalog
-
Add a new log subscription
- Subscriber - Interface in io.github.jonloucks.metalog.api
-
Responsible for consuming published log messages and meta information.
T
- test(Meta) - Method in interface io.github.jonloucks.metalog.api.Console
- test(Meta) - Method in interface io.github.jonloucks.metalog.api.Publisher
-
Test of Meta matches criteria for logging
- test(Meta) - Method in interface io.github.jonloucks.metalog.api.Subscriber
-
Used to short circuit needless processing
- text(Supplier<CharSequence>) - Method in interface io.github.jonloucks.metalog.api.Entity.Builder
-
Set the text supplier for the Entity
- thread() - Method in interface io.github.jonloucks.metalog.api.Meta.Builder
-
Set the thread to the current runtime thread
- thread(Thread) - Method in interface io.github.jonloucks.metalog.api.Meta.Builder
-
Set the thread for the Meta
- thrown(Throwable) - Method in interface io.github.jonloucks.metalog.api.Meta.Builder
-
Set the throwable for the Meta
- time() - Method in interface io.github.jonloucks.metalog.api.Meta.Builder
-
Set the timestamp to the current time
- time(Temporal) - Method in interface io.github.jonloucks.metalog.api.Meta.Builder
-
Set the timestamp for the Meta
U
- unique() - Method in interface io.github.jonloucks.metalog.api.Entity.Builder
-
Shortcut for unique(true)
- unique(boolean) - Method in interface io.github.jonloucks.metalog.api.Entity.Builder
-
Set name mode for the Entity
- UNKEYED_FACTORY - Static variable in interface io.github.jonloucks.metalog.api.Dispatcher
-
Dispatcher tuned for Log messages, normally all unkeys mapped to many worker threads
- unkeyedFairness() - Method in interface io.github.jonloucks.metalog.api.Metalog.Config
-
true if all thread log messages are processed in FIFO order
- unkeyedFairness(boolean) - Method in interface io.github.jonloucks.metalog.api.Metalog.Config.Builder
- unkeyedThreadCount() - Method in interface io.github.jonloucks.metalog.api.Metalog.Config
-
The maximum number of background threads dispatching log messages to subscribers.
- unkeyedThreadCount(int) - Method in interface io.github.jonloucks.metalog.api.Metalog.Config.Builder
- useReflection() - Method in interface io.github.jonloucks.metalog.api.Metalog.Config
- useReflection(boolean) - Method in interface io.github.jonloucks.metalog.api.Metalog.Config.Builder
- useServiceLoader() - Method in interface io.github.jonloucks.metalog.api.Metalog.Config
- useServiceLoader(boolean) - Method in interface io.github.jonloucks.metalog.api.Metalog.Config.Builder
V
- value(Object) - Method in interface io.github.jonloucks.metalog.api.Entity.Builder
-
Set the value for the Entity
- valueOf(String) - Static method in enum class io.github.jonloucks.metalog.api.Outcome
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class io.github.jonloucks.metalog.api.Outcome
-
Returns an array containing the constants of this enum class, in the order they are declared.
- visit(T) - Method in interface io.github.jonloucks.metalog.api.Visitor
-
Called for each item
- visitEach(Visitor<? super Entity>) - Method in interface io.github.jonloucks.metalog.api.Entities
-
Visit each entity
- Visitor<T> - Interface in io.github.jonloucks.metalog.api
-
Like an iterator except there is not a 'remove'
All Classes and Interfaces|All Packages|Serialized Form