lib/jetty/org/eclipse/jetty/util/annotation/Name.java

   1 //
   2 //  ========================================================================
   3 //  Copyright (c) 1995-2016 Mort Bay Consulting Pty. Ltd.
   4 //  ------------------------------------------------------------------------
   5 //  All rights reserved. This program and the accompanying materials
   6 //  are made available under the terms of the Eclipse Public License v1.0
   7 //  and Apache License v2.0 which accompanies this distribution.
   8 //
   9 //      The Eclipse Public License is available at
  10 //      http://www.eclipse.org/legal/epl-v10.html
  11 //
  12 //      The Apache License v2.0 is available at
  13 //      http://www.opensource.org/licenses/apache2.0.php
  14 //
  15 //  You may elect to redistribute this code under either of these licenses.
  16 //  ========================================================================
  17 //
  18
  19 package org.eclipse.jetty.util.annotation;
  20
  21 import java.lang.annotation.Documented;
  22 import java.lang.annotation.ElementType;
  23 import java.lang.annotation.Retention;
  24 import java.lang.annotation.RetentionPolicy;
  25 import java.lang.annotation.Target;
  26
  27 /**
  28  * This annotation is used to describe variables in method
  29  * signatures so that when rendered into tools like JConsole
  30  * it is clear what the parameters are. For example:
  31  *
  32  * public void doodle(@Name(value="doodle", description="A description of the argument") String doodle)
  33  *
  34  */
  35 @Retention(RetentionPolicy.RUNTIME)
  36 @Documented
  37 @Target( { ElementType.PARAMETER } )
  38 public @interface Name
  39 {
  40     /**
  41      * the name of the parameter
  42      */
  43     String value();
  44
  45     /**
  46      * the description of the parameter
  47      */
  48     String description() default "";
  49 }