Class DiagnosticOptions

java.lang.Object

java.util.AbstractMap<String,Object>

java.util.HashMap<String,Object>

org.refcodes.runtime.Options

org.refcodes.runtime.DiagnosticOptions

All Implemented Interfaces:

Serializable, Cloneable, Map<String,Object>, Diagnosable, org.refcodes.schema.Schemable<DiagnosticOptions>

public class DiagnosticOptions
extends Options

The DiagnosticOptions represent a set of options influencing how a Diagnosable instance renders its runtime diagnostics Schema.

The options are expressed as key/value pairs and stored internally in a Map. In addition to generic map-style access, this class provides typed convenience accessors for commonly used options such as DiagnosticOptions.Configuration.DIAGNOSTICS_LIMIT.

The interpretation of individual option keys and values is intentionally left to the respective Schemable implementation. This makes the DiagnosticOptions generic and reusable across different domains and schema-producing components.

Instances of this class are typically created using the nested DiagnosticOptions.Builder.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DiagnosticOptions.Builder	Builder for creating DiagnosticOptions instances.
static enum	DiagnosticOptions.Configuration	The DiagnosticOptions.Configuration enumeration defines known options supported by this class.

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DiagnosticOptions(DiagnosticOptions.Builder aBuilder)	Instantiates a new instance from the given builder.

Method Summary

Modifier and Type	Method	Description
static DiagnosticOptions.Builder	builder()	Creates a new DiagnosticOptions.Builder for constructing DiagnosticOptions instances.
int	getLimit()	Returns the configured limit value.
int	getLimitOr(int aValue)	Returns the configured limit value or the provided default.

Methods inherited from class org.refcodes.runtime.Options

get, get, get, get, getOption, getOr, getOr, getOr, put, put, registerOptions, toSchema, toSchema

Methods inherited from class java.util.HashMap

clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, getOrDefault, isEmpty, keySet, merge, newHashMap, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Constructor Details

DiagnosticOptions

protected DiagnosticOptions(DiagnosticOptions.Builder aBuilder)

Instantiates a new instance from the given builder.

Parameters:

aBuilder - The builder from which to populate the this instance.

Method Details

getLimit

public int getLimit()

Returns the configured limit value.

This is a convenience method equivalent to calling getLimitOr(int) with -1 as the default value.

Returns:

the configured limit value, or -1 if no limit is set

getLimitOr

public int getLimitOr(int aValue)

Returns the configured limit value or the provided default.

Parameters:

aValue - the default value to return if no limit is present

Returns:

the configured limit value or aValue if absent

builder

public static DiagnosticOptions.Builder builder()

Creates a new DiagnosticOptions.Builder for constructing DiagnosticOptions instances.

Returns:

a new builder instance