< prev index next >

src/jdk.scripting.nashorn/share/classes/jdk/nashorn/internal/objects/annotations/Function.java

Print this page
rev 1309 : 8085885: address Javadoc warnings in Nashorn source code
   1 /*
   2  * Copyright (c) 2010, 2013, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any


  24  */
  25 
  26 package jdk.nashorn.internal.objects.annotations;
  27 
  28 import static jdk.nashorn.internal.objects.annotations.Attribute.DEFAULT_ATTRIBUTES;
  29 
  30 import java.lang.annotation.ElementType;
  31 import java.lang.annotation.Retention;
  32 import java.lang.annotation.RetentionPolicy;
  33 import java.lang.annotation.Target;
  34 
  35 /**
  36  * Annotation to specify a JavaScript "function" property.
  37  * Note that -1 means varargs. So, -2 is used as invalid arity.
  38  *
  39  */
  40 @Retention(RetentionPolicy.RUNTIME)
  41 @Target(ElementType.METHOD)
  42 public @interface Function {
  43     /**
  44      * Name of the property. If empty, the name is inferred.
  45      */
  46     public String name() default "";
  47 
  48     /**
  49      * Attribute flags for this function.
  50      */
  51     public int attributes() default DEFAULT_ATTRIBUTES;
  52 
  53     /**
  54      * The arity of the function. By default computed from the method signature

  55      */
  56     public int arity() default -2;
  57 
  58     /**
  59      * where this function lives
  60      */
  61     public Where where() default Where.PROTOTYPE;
  62 }
   1 /*
   2  * Copyright (c) 2010, 2015, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any


  24  */
  25 
  26 package jdk.nashorn.internal.objects.annotations;
  27 
  28 import static jdk.nashorn.internal.objects.annotations.Attribute.DEFAULT_ATTRIBUTES;
  29 
  30 import java.lang.annotation.ElementType;
  31 import java.lang.annotation.Retention;
  32 import java.lang.annotation.RetentionPolicy;
  33 import java.lang.annotation.Target;
  34 
  35 /**
  36  * Annotation to specify a JavaScript "function" property.
  37  * Note that -1 means varargs. So, -2 is used as invalid arity.
  38  *
  39  */
  40 @Retention(RetentionPolicy.RUNTIME)
  41 @Target(ElementType.METHOD)
  42 public @interface Function {
  43     /**
  44      * @return the name of the property. If empty, the name is inferred.
  45      */
  46     public String name() default "";
  47 
  48     /**
  49      * @return the attribute flags for this function.
  50      */
  51     public int attributes() default DEFAULT_ATTRIBUTES;
  52 
  53     /**
  54      * @return the arity of the function. By default computed from the method
  55      *         signature.
  56      */
  57     public int arity() default -2;
  58 
  59     /**
  60      * @return where this function lives.
  61      */
  62     public Where where() default Where.PROTOTYPE;
  63 }
< prev index next >