sandbox/java.hints/spi.java.hints/src/org/netbeans/spi/java/hints/BooleanOption.java
1.1 --- a/sandbox/java.hints/spi.java.hints/src/org/netbeans/spi/java/hints/BooleanOption.java Mon Dec 19 11:37:36 2016 +0100
1.2 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000
1.3 @@ -1,87 +0,0 @@
1.4 -/*
1.5 - * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
1.6 - *
1.7 - * Copyright 2012 Oracle and/or its affiliates. All rights reserved.
1.8 - *
1.9 - * Oracle and Java are registered trademarks of Oracle and/or its affiliates.
1.10 - * Other names may be trademarks of their respective owners.
1.11 - *
1.12 - * The contents of this file are subject to the terms of either the GNU
1.13 - * General Public License Version 2 only ("GPL") or the Common
1.14 - * Development and Distribution License("CDDL") (collectively, the
1.15 - * "License"). You may not use this file except in compliance with the
1.16 - * License. You can obtain a copy of the License at
1.17 - * http://www.netbeans.org/cddl-gplv2.html
1.18 - * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
1.19 - * specific language governing permissions and limitations under the
1.20 - * License. When distributing the software, include this License Header
1.21 - * Notice in each file and include the License file at
1.22 - * nbbuild/licenses/CDDL-GPL-2-CP. Oracle designates this
1.23 - * particular file as subject to the "Classpath" exception as provided
1.24 - * by Oracle in the GPL Version 2 section of the License file that
1.25 - * accompanied this code. If applicable, add the following below the
1.26 - * License Header, with the fields enclosed by brackets [] replaced by
1.27 - * your own identifying information:
1.28 - * "Portions Copyrighted [year] [name of copyright owner]"
1.29 - *
1.30 - * If you wish your version of this file to be governed by only the CDDL
1.31 - * or only the GPL Version 2, indicate your decision by adding
1.32 - * "[Contributor] elects to include this software in this distribution
1.33 - * under the [CDDL or GPL Version 2] license." If you do not indicate a
1.34 - * single choice of license, a recipient has the option to distribute
1.35 - * your version of this file under either the CDDL, the GPL Version 2 or
1.36 - * to extend the choice of license to its licensees as provided above.
1.37 - * However, if you add GPL Version 2 code and therefore, elected the GPL
1.38 - * Version 2 license, then the option applies only if the new code is
1.39 - * made subject to such option by the copyright holder.
1.40 - *
1.41 - * Contributor(s):
1.42 - *
1.43 - * Portions Copyrighted 2012 Sun Microsystems, Inc.
1.44 - */
1.45 -package org.netbeans.spi.java.hints;
1.46 -
1.47 -import java.lang.annotation.ElementType;
1.48 -import java.lang.annotation.Retention;
1.49 -import java.lang.annotation.RetentionPolicy;
1.50 -import java.lang.annotation.Target;
1.51 -import java.util.prefs.Preferences;
1.52 -
1.53 -/**Specify an option that affects the way the hint works.
1.54 - *
1.55 - * Only {@code static final String} compile-time constant can be marked with this
1.56 - * annotation. The value of the constant will be used as the key to the hint's {@link Preferences}.
1.57 - *
1.58 - * For hints that consist of a class, all options that are directly enclosed in the class
1.59 - * will be used in their source order.
1.60 - *
1.61 - * For hints that consist of a single method, use {@link UseOptions} to specify which options
1.62 - * from the enclosing class should be used. The order of the options will be the order in which
1.63 - * they appear in the source code of the enclosing class.
1.64 - *
1.65 - * The customizer will be generated automatically when {@link BooleanOption} is used.
1.66 - *
1.67 - * Two keys need to be defined in the corresponding {@code Bundle.properties}:
1.68 - * {@code LBL_<class-fqn>.<field_name>}, which will be used as the display name of
1.69 - * the corresponding checkbox in the customizer, and {@code TP_<class-fqn>.<field_name>}
1.70 - * which will be used as the tooltip of the checkbox.
1.71 - *
1.72 - * @author lahvac
1.73 - */
1.74 -@Retention(RetentionPolicy.SOURCE)
1.75 -@Target(ElementType.FIELD)
1.76 -public @interface BooleanOption {
1.77 -
1.78 - /**The options' display name. Will be used as the display name of the
1.79 - * checkbox in the customizer.
1.80 - */
1.81 - public String displayName();
1.82 - /**The tooltip of the checkbox in the customizer.
1.83 - */
1.84 - public String tooltip();
1.85 -
1.86 - /**The default value of the option.
1.87 - */
1.88 - public boolean defaultValue();
1.89 -
1.90 -}