Moving all files to root directory

[appc.git] / appc-metric / appc-metric-bundle / src / main / java / org / openecomp / appc / metricservice / metric / Metric.java

diff --git a/appc-metric/appc-metric-bundle/src/main/java/org/openecomp/appc/metricservice/metric/Metric.java b/appc-metric/appc-metric-bundle/src/main/java/org/openecomp/appc/metricservice/metric/Metric.java
new file mode 100644 (file)
index 0000000..10b8daa
--- /dev/null
+++ b/appc-metric/appc-metric-bundle/src/main/java/org/openecomp/appc/metricservice/metric/Metric.java
@@ -0,0 +1,37 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * openECOMP : APP-C
+ * ================================================================================
+ * Copyright (C) 2017 AT&T Intellectual Property. All rights
+ *                                             reserved.
+ * ================================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * 
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.openecomp.appc.metricservice.metric;
+
+/**
+ *
+ * a measure of system parameter at the current moment. Each metric is identified by name.
+ * In general case, a metric just reflects its (almost) real-time value and is not responsible for maintaining its historical data.
+ * One that needs to build series of a metric values for statistical/analytic purposes should query the value and store it for further processing.
+ * Metrics can be of different types - counters, timers etc.
+ * The initial service implementation supports simple (flat) counters only.
+ *
+ */
+public interface Metric {
+    String name();
+    void reset();
+    MetricType type();
+}