org.spf4j.perf.MeasurementsInfo Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of spf4j-core Show documentation

A continuously growing collection of utilities to measure performance, get better diagnostics, improve performance, or do things more reliably, faster that other open source libraries...

There is a newer version: 8.10.0

Show newest version

/*
 * Copyright (c) 2001-2017, Zoltan Farkas All Rights Reserved.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 *
 * Additionally licensed with:
 *
 * 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.
 */
package org.spf4j.perf;

import javax.annotation.Nonnull;
import javax.annotation.concurrent.Immutable;
import javax.management.openmbean.CompositeType;
import javax.management.openmbean.OpenDataException;
import javax.management.openmbean.OpenType;
import org.spf4j.tsdb2.avro.Aggregation;
import org.spf4j.tsdb2.avro.MeasurementType;

/**
 *
 * @author zoly
 */
@Immutable
public interface MeasurementsInfo {

  @Nonnull
  Object getMeasuredEntity();

  @Nonnull
  String getDescription();

  String[] getMeasurementNames();

  String[] getMeasurementUnits();

  Aggregation[] getAggregations();

  String getMeasurementName(int measurementNr);

  String getMeasurementUnit(int measurementNr);

  Aggregation getMeasurementAggregation(int measurementNr);

  int getNumberOfMeasurements();

  MeasurementType getMeasurementType();

  default CompositeType toCompositeType() {
    OpenType[] types = new OpenType[getNumberOfMeasurements()];
    for (int i = 0; i < types.length; i++) {
      types[i] = javax.management.openmbean.SimpleType.LONG;
    }
    try {
      String entityName = getMeasuredEntity().toString();
      String description = getDescription();
      if (description.isEmpty()) {
        description = entityName;
      }
      return new CompositeType(entityName, description, getMeasurementNames(), getMeasurementUnits(), types);
    } catch (OpenDataException ex) {
      throw new IllegalArgumentException("Cannot convert to composite data " + this, ex);
    }
  }

}