com.gemstone.gemfire.admin.internal.StatisticImpl Maven / Gradle / Ivy

/*
 * Copyright (c) 2010-2015 Pivotal Software, Inc. 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. See accompanying
 * LICENSE file.
 */

package com.gemstone.gemfire.admin.internal;

import com.gemstone.gemfire.internal.admin.Stat;

/**
 * Implementation of a single statistic in a StatisticResource
 *
 * @author    Kirk Lund
 * @since     3.5
 *
 */
public class StatisticImpl
implements com.gemstone.gemfire.admin.Statistic {

  private static final long serialVersionUID = 3899296873901634399L;
  
  private Stat internalStat;

  protected StatisticImpl() {
  }

  protected StatisticImpl(Stat internalStat) {
    this.internalStat = internalStat;
  }
    
  /**
   * @return the identifying name of this stat 
   */
  public String getName() {
    return this.internalStat.getName();
  }
  
  /**
   * @return the value of this stat as a java.lang.Number 
   */
  public Number getValue() {
    return this.internalStat.getValue();
  }
  
  /**
   * @return a display string for the unit of measurement (if any) this stat represents
   */
  public String getUnits() {
    return this.internalStat.getUnits();
  }
  
  /**
   * @return true if this stat represents a numeric value which always increases
   */
  public boolean isCounter() {
    return this.internalStat.isCounter();
  }
  
  /**
   * @return the full description of this stat
   */
  public String getDescription() {
    return this.internalStat.getDescription();
  }
  
  /**
   * Sets the internal stat which allows us to reuse the wrapper object and
   * handle refreshes along with isWriteable set to false on the attribute.
   */
  protected void setStat(Stat internalStat) {
    this.internalStat = internalStat;
  }
    
	/**
	 * Returns a string representation of the object.
	 * 
	 * @return a string representation of the object
	 */
  @Override
	public String toString() {
		return getName();
	}
  
}