Index
All Classes and Interfaces|All Packages
A
- accept(T) - Method in interface org.opendaylight.serviceutils.metrics.function.CheckedConsumer
- accept(T) - Method in interface org.opendaylight.serviceutils.metrics.function.InterruptibleCheckedConsumer
- accept(T, U) - Method in interface org.opendaylight.serviceutils.metrics.function.CheckedBiConsumer
-
Performs this operation on the given arguments.
- anchor() - Method in class org.opendaylight.serviceutils.metrics.ImmutableMetricDescriptor
-
Instance of the class "containing" this Metric.
- anchor() - Method in class org.opendaylight.serviceutils.metrics.MetricDescriptor
-
Instance of the class "containing" this Metric.
- anchor(Object) - Method in interface org.opendaylight.serviceutils.metrics.ImmutableMetricDescriptor.AnchorBuildStage
-
Initializes the value for the
anchorattribute. - anchor(Object) - Method in class org.opendaylight.serviceutils.metrics.ImmutableMetricDescriptor.Builder
-
Initializes the value for the
anchorattribute. - apply(T) - Method in interface org.opendaylight.serviceutils.metrics.function.CheckedFunction
- apply(T) - Method in interface org.opendaylight.serviceutils.metrics.function.InterruptibleCheckedFunction
B
- build() - Method in class org.opendaylight.serviceutils.metrics.ImmutableMetricDescriptor.Builder
-
Builds a new
ImmutableMetricDescriptor. - build() - Method in interface org.opendaylight.serviceutils.metrics.ImmutableMetricDescriptor.BuildFinal
-
Builds a new
ImmutableMetricDescriptor. - builder() - Static method in class org.opendaylight.serviceutils.metrics.ImmutableMetricDescriptor
-
Creates a builder for
ImmutableMetricDescriptor. - builder() - Static method in class org.opendaylight.serviceutils.metrics.MetricDescriptor
C
- call() - Method in interface org.opendaylight.serviceutils.metrics.function.CheckedCallable
- check() - Method in class org.opendaylight.serviceutils.metrics.MetricDescriptor
- check(String, Pattern) - Static method in class org.opendaylight.serviceutils.metrics.IDs
-
Validate that ID matches regexp Pattern passed as argument.
- CheckedBiConsumer<T,
U, E extends Exception> - Interface in org.opendaylight.serviceutils.metrics.function -
Represents an operation that accepts two input arguments and returns no result, but can throw a checked exception.
- CheckedCallable<V,
E extends Exception> - Interface in org.opendaylight.serviceutils.metrics.function - CheckedConsumer<T,
E extends Exception> - Interface in org.opendaylight.serviceutils.metrics.function -
Consumerwhich can throw a checked exception. - CheckedFunction<T,
R, E extends Exception> - Interface in org.opendaylight.serviceutils.metrics.function -
Functionwhich can throw a checked exception. - CheckedRunnable<E extends Exception> - Interface in org.opendaylight.serviceutils.metrics.function
-
Functional interface similar to
Runnable(but not technically extending Runnable, because it cannot; and doesn't have to) which can throw a generically parameterized type of checked exception. - checkOnlyAZ09(String) - Static method in class org.opendaylight.serviceutils.metrics.IDs
-
Validate that ID matches regular expression
[a-zA-Z][a-zA-Z0-9]*(upper or lower case letter or digits, but not start with digit, no dots). - checkOnlyAZ09Dot(String) - Static method in class org.opendaylight.serviceutils.metrics.IDs
-
Validate that ID matches regular expression
[a-zA-Z0-9][a-zA-Z0-9.]*(dots allowed, but not starting with). - checkOnlyAZ09Underscore(String) - Static method in class org.opendaylight.serviceutils.metrics.IDs
-
Validate that ID matches regular expression
[a-zA-Z][a-zA-Z0-9_]*(underscores allowed, but not starting with; no dots). - checkOnlyLowercaseAZ09(String) - Static method in class org.opendaylight.serviceutils.metrics.IDs
-
Validate that ID matches regular expression
[a-z][a-z0-9]*(lower case letter or digits, but not start with digit, no dots). - copyOf(MetricDescriptor) - Static method in class org.opendaylight.serviceutils.metrics.ImmutableMetricDescriptor
-
Creates an immutable copy of a
MetricDescriptorvalue. - Counter - Interface in org.opendaylight.serviceutils.metrics
-
Counter metric, which is a simple incrementing and decrementing number.
D
- decrement() - Method in interface org.opendaylight.serviceutils.metrics.Counter
- decrement(long) - Method in interface org.opendaylight.serviceutils.metrics.Counter
- description() - Method in class org.opendaylight.serviceutils.metrics.ImmutableMetricDescriptor
-
Human readable description of the Metric.
- description() - Method in class org.opendaylight.serviceutils.metrics.MetricDescriptor
-
Human readable description of the Metric.
- description(String) - Method in class org.opendaylight.serviceutils.metrics.ImmutableMetricDescriptor.Builder
-
Initializes the value for the
descriptionattribute. - description(String) - Method in interface org.opendaylight.serviceutils.metrics.ImmutableMetricDescriptor.BuildFinal
-
Initializes the value for the
descriptionattribute.
E
- equals(Object) - Method in class org.opendaylight.serviceutils.metrics.ImmutableMetricDescriptor
-
This instance is equal to all instances of
ImmutableMetricDescriptorthat have equal attribute values.
G
- get() - Method in interface org.opendaylight.serviceutils.metrics.Counter
-
Gets the total number of events.
- get() - Method in interface org.opendaylight.serviceutils.metrics.Meter
-
Gets the total number of events.
H
- hashCode() - Method in class org.opendaylight.serviceutils.metrics.ImmutableMetricDescriptor
-
Computes a hash code from attributes:
anchor,project,module,id,description.
I
- id() - Method in class org.opendaylight.serviceutils.metrics.ImmutableMetricDescriptor
-
ID of the Metric, unique within given
ImmutableMetricDescriptor.project()+ImmutableMetricDescriptor.module(). - id() - Method in class org.opendaylight.serviceutils.metrics.MetricDescriptor
-
ID of the Metric, unique within given
MetricDescriptor.project()+MetricDescriptor.module(). - id(String) - Method in class org.opendaylight.serviceutils.metrics.ImmutableMetricDescriptor.Builder
-
Initializes the value for the
idattribute. - id(String) - Method in interface org.opendaylight.serviceutils.metrics.ImmutableMetricDescriptor.IdBuildStage
-
Initializes the value for the
idattribute. - IDs - Class in org.opendaylight.serviceutils.metrics
-
Validations for "ID" like simple types.
- ImmutableMetricDescriptor - Class in org.opendaylight.serviceutils.metrics
-
Immutable implementation of
MetricDescriptor. - ImmutableMetricDescriptor.AnchorBuildStage - Interface in org.opendaylight.serviceutils.metrics
- ImmutableMetricDescriptor.Builder - Class in org.opendaylight.serviceutils.metrics
-
Builds instances of type
ImmutableMetricDescriptor. - ImmutableMetricDescriptor.BuildFinal - Interface in org.opendaylight.serviceutils.metrics
- ImmutableMetricDescriptor.IdBuildStage - Interface in org.opendaylight.serviceutils.metrics
- ImmutableMetricDescriptor.ModuleBuildStage - Interface in org.opendaylight.serviceutils.metrics
- ImmutableMetricDescriptor.ProjectBuildStage - Interface in org.opendaylight.serviceutils.metrics
- increment() - Method in interface org.opendaylight.serviceutils.metrics.Counter
- increment(long) - Method in interface org.opendaylight.serviceutils.metrics.Counter
- InterruptibleCheckedConsumer<T,
E extends Exception> - Interface in org.opendaylight.serviceutils.metrics.function -
Consumerwhich can throw a checked exception and be interrupted. - InterruptibleCheckedFunction<T,
R, E extends Exception> - Interface in org.opendaylight.serviceutils.metrics.function -
Functionwhich can throw a checked exception and be interrupted.
L
- label(String) - Method in interface org.opendaylight.serviceutils.metrics.Labeled
- Labeled<T> - Interface in org.opendaylight.serviceutils.metrics
-
Labeled wrapper which "tags" T objects.
M
- mark() - Method in interface org.opendaylight.serviceutils.metrics.Meter
-
Mark the occurrence of an event.
- mark(long) - Method in interface org.opendaylight.serviceutils.metrics.Meter
-
Mark the occurrence of a given number of events.
- Meter - Interface in org.opendaylight.serviceutils.metrics
-
Meter metric, which measures throughput.
- MetricDescriptor - Class in org.opendaylight.serviceutils.metrics
-
Descriptor of Metric.
- MetricDescriptor() - Constructor for class org.opendaylight.serviceutils.metrics.MetricDescriptor
- MetricProvider - Interface in org.opendaylight.serviceutils.metrics
-
Factory to obtain a new metric for use by application code.
- module() - Method in class org.opendaylight.serviceutils.metrics.ImmutableMetricDescriptor
-
Name of OpenDaylight module the Metric is for, unique within given
ImmutableMetricDescriptor.project(). - module() - Method in class org.opendaylight.serviceutils.metrics.MetricDescriptor
-
Name of OpenDaylight module the Metric is for, unique within given
MetricDescriptor.project(). - module(String) - Method in class org.opendaylight.serviceutils.metrics.ImmutableMetricDescriptor.Builder
-
Initializes the value for the
moduleattribute. - module(String) - Method in interface org.opendaylight.serviceutils.metrics.ImmutableMetricDescriptor.ModuleBuildStage
-
Initializes the value for the
moduleattribute.
N
- newCounter(Object, String) - Method in interface org.opendaylight.serviceutils.metrics.MetricProvider
-
Deprecated, for removal: This API element is subject to removal in a future version.
- newCounter(MetricDescriptor) - Method in interface org.opendaylight.serviceutils.metrics.MetricProvider
-
Create new Counter metric without labels.
- newCounter(MetricDescriptor, String) - Method in interface org.opendaylight.serviceutils.metrics.MetricProvider
-
Create new Counter metric with 1 label.
- newCounter(MetricDescriptor, String, String) - Method in interface org.opendaylight.serviceutils.metrics.MetricProvider
-
Create new Counter metric with 2 labels.
- newCounter(MetricDescriptor, String, String, String) - Method in interface org.opendaylight.serviceutils.metrics.MetricProvider
-
Create new Counter metric with 3 labels.
- newCounter(MetricDescriptor, String, String, String, String) - Method in interface org.opendaylight.serviceutils.metrics.MetricProvider
-
Create new Counter metric with 4 labels.
- newCounter(MetricDescriptor, String, String, String, String, String) - Method in interface org.opendaylight.serviceutils.metrics.MetricProvider
-
Create new Counter metric with 5 labels.
- newMeter(Object, String) - Method in interface org.opendaylight.serviceutils.metrics.MetricProvider
-
Deprecated, for removal: This API element is subject to removal in a future version.use
MetricProvider.newMeter(MetricDescriptor)instead. - newMeter(MetricDescriptor) - Method in interface org.opendaylight.serviceutils.metrics.MetricProvider
-
Create new Meter metric without labels.
- newMeter(MetricDescriptor, String) - Method in interface org.opendaylight.serviceutils.metrics.MetricProvider
-
Create new Meter metric with 1 label.
- newMeter(MetricDescriptor, String, String) - Method in interface org.opendaylight.serviceutils.metrics.MetricProvider
-
Create new Meter metric with 2 labels.
- newMeter(MetricDescriptor, String, String, String) - Method in interface org.opendaylight.serviceutils.metrics.MetricProvider
-
Create new Meter metric with 3 labels.
- newMeter(MetricDescriptor, String, String, String, String) - Method in interface org.opendaylight.serviceutils.metrics.MetricProvider
-
Create new Meter metric with 4 labels.
- newMeter(MetricDescriptor, String, String, String, String, String) - Method in interface org.opendaylight.serviceutils.metrics.MetricProvider
-
Create new Meter metric with 5 labels.
- newTimer(Object, String) - Method in interface org.opendaylight.serviceutils.metrics.MetricProvider
-
Deprecated, for removal: This API element is subject to removal in a future version.
- newTimer(MetricDescriptor) - Method in interface org.opendaylight.serviceutils.metrics.MetricProvider
-
Create new Timer metric without labels.
- newTimer(MetricDescriptor, String) - Method in interface org.opendaylight.serviceutils.metrics.MetricProvider
-
Create new Timer metric with 1 label.
- newTimer(MetricDescriptor, String, String) - Method in interface org.opendaylight.serviceutils.metrics.MetricProvider
-
Create new Timer metric with 2 labels.
O
- org.opendaylight.serviceutils.metrics - package org.opendaylight.serviceutils.metrics
- org.opendaylight.serviceutils.metrics.function - package org.opendaylight.serviceutils.metrics.function
P
- project() - Method in class org.opendaylight.serviceutils.metrics.ImmutableMetricDescriptor
-
Name of OpenDaylight project the Metric is for, unique at opendaylight.org.
- project() - Method in class org.opendaylight.serviceutils.metrics.MetricDescriptor
-
Name of OpenDaylight project the Metric is for, unique at opendaylight.org.
- project(String) - Method in class org.opendaylight.serviceutils.metrics.ImmutableMetricDescriptor.Builder
-
Initializes the value for the
projectattribute. - project(String) - Method in interface org.opendaylight.serviceutils.metrics.ImmutableMetricDescriptor.ProjectBuildStage
-
Initializes the value for the
projectattribute.
R
- run() - Method in interface org.opendaylight.serviceutils.metrics.function.CheckedRunnable
T
- time(CheckedCallable<T, E>) - Method in interface org.opendaylight.serviceutils.metrics.Timer
-
Times and records the duration of event which returns a value.
- time(CheckedRunnable<E>) - Method in interface org.opendaylight.serviceutils.metrics.Timer
-
Times and records the duration of event.
- Timer - Interface in org.opendaylight.serviceutils.metrics
-
A timer metric which aggregates timing durations.
- toString() - Method in class org.opendaylight.serviceutils.metrics.ImmutableMetricDescriptor
-
Prints the immutable value
MetricDescriptorwith attribute values.
W
- withAnchor(Object) - Method in class org.opendaylight.serviceutils.metrics.ImmutableMetricDescriptor
-
Copy the current immutable object by setting a value for the
anchorattribute. - withDescription(String) - Method in class org.opendaylight.serviceutils.metrics.ImmutableMetricDescriptor
-
Copy the current immutable object by setting a value for the
descriptionattribute. - withId(String) - Method in class org.opendaylight.serviceutils.metrics.ImmutableMetricDescriptor
-
Copy the current immutable object by setting a value for the
idattribute. - withModule(String) - Method in class org.opendaylight.serviceutils.metrics.ImmutableMetricDescriptor
-
Copy the current immutable object by setting a value for the
moduleattribute. - withProject(String) - Method in class org.opendaylight.serviceutils.metrics.ImmutableMetricDescriptor
-
Copy the current immutable object by setting a value for the
projectattribute.
All Classes and Interfaces|All Packages
MetricProvider.newCounter(MetricDescriptor)instead.