StatisticInfo.java

/*
 * Copyright 2010 Chad Retz
 * 
 * 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.statmantis.stat;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Annotation that all statistics must use.
 *
 * @author Chad Retz
 */
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface StatisticInfo {

    /**
     * The friendly name of this statistic
     * 
     * @return
     */
    String name();
    
    /**
     * All abbreviations (if applicable) for this statistic
     * 
     * @return
     */
    String[] abbreviations() default {};
    
    /**
     * The statistic types this statistic represents
     * 
     * @return
     */
    StatisticType[] types();
    
    /**
     * All dependencies of this statistic
     * 
     * @return
     */
    Class<? extends Statistic<? extends Number>>[] dependencies() default {};
}