com.cloudhopper.commons.util.annotation.MetaField Maven / Gradle / Ivy

package com.cloudhopper.commons.util.annotation;

/*
 * #%L
 * ch-commons-util
 * %%
 * Copyright (C) 2012 Cloudhopper by Twitter
 * %%
 * 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.
 * #L%
 */

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

/**
 * Annotation for including extra meta data about a field inside a class. Useful
 * for tagging fields inside a class with a name and description to display.
 * Use in conjunction with MetaFieldUtil class.
 * 
 * @author joelauer (twitter: @jjlauer or http://twitter.com/jjlauer)
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface MetaField {
    /** Name of field */
    String name() default "";
    /** Description of field */
    String description() default "";
    /** Level of field (matches what Log4J uses by name */
    Level level() default Level.INFO;
}