org.terracotta.context.annotations.ContextAttribute Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of statistics Show documentation

A statistics framework used inside Ehcache and the Terracotta products

There is a newer version: 2.1.3

/*
 * All content copyright Terracotta, Inc., unless otherwise indicated.
 *
 * 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.terracotta.context.annotations;

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

/**
 * Marks a field, method, or the object itself as a context attribute.
 * 
 * Annotated final fields may be fetched eagerly at context creation time.  Non
 * static fields and methods are fetched both lazily and on also on every
 * attribute access.  Annotating the class type will associate {@code this}
 * with the supplied attribute name.
 */
@Inherited
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD, ElementType.METHOD, ElementType.TYPE})
public @interface ContextAttribute {

  /**
   * The name with which this attribute should be associated.
   *
   * @return the attribute name
   */
  String value();
}